Не нашли информацию
Если в документации платформы «Штурвал» не удаётся найти ответ на вопрос или описание нужного сценария, сначала имеет смысл проверить несколько вариантов поиска и навигации. Если после этого информация по-прежнему отсутствует, можно запросить её через поддержку или каналы обратной связи.
Как искать в документации
Поиск по сайту
Воспользуйтесь поиском по документации: введите ключевые слова по теме (например, «kubeconfig», «резервное копирование», «StorageClass», «назначение прав»). Поиск может находить страницы по заголовкам, описаниям и ключевым словам.
Навигация по разделам
Документация организована по верхнему уровню навигации. Ниже — имена разделов, основные подразделы и типовые задачи, которые с ними связаны.
| Раздел | Что внутри | Задачи |
|---|---|---|
| Администратору платформы | Быстрый старт, навигация в GUI, глоссарий Установка платформы, планирование и архитектура, провайдеры, лицензирование Развёртывание клиентских кластеров, IAM, тенанты Мониторинг, логирование, обновление, восстановление после сбоев, FAQ |
Установить платформу в открытом или закрытом контуре, подключить провайдеры инфраструктуры, развернуть клиентские кластеры, настроить доступ, управлять лицензией, смотреть мониторинг и логи платформы в целом, обновить в закрытом контуре, восстановлению после сбоев. |
| Администратору кластера | Быстрый старт, интерфейсы управления, глоссарий Работа с узлами, хранилище, управление сетями, управление сертификатами, обслуживание ETCD Резервное копирование в кластере, логи, мониторинг, алертинг Сервисы и репозитории, обновление версии Kubernetes в кластере, траблшутинг |
Управлять кластером управления или клиентским кластером после развёртывания: обслуживать узлы, сеть, хранилище, сертификаты и ETCD, настраивать квоты, резервные копии, логи и мониторинг, подключать сервисы и репозитории, обновлять Kubernetes и разбирать типовые неполадки. |
| Разработчику | Быстрый старт, глоссарий Доставка приложений Справочная информация |
Настроить доставку приложений через поддерживаемые платформой сценарии, использовать сервисные учётные записи и справочные материалы для работы приложений в кластере. |
| ИБ специалисту | Быстрый старт, глоссарий Обзор инструментов безопасности, отчёты Как обеспечивается безопасность Штурвала Политики безопасности, управление уязвимостями, аудит и логирование, управление секретами, справочная информация |
Оценить инструменты безопасности платформы, работать с отчётами, политиками безопасности, уязвимостями, аудитом, логированием и секретами, а также использовать справочные материалы по требованиям и настройкам безопасности. |
| Общая информация | Способы работы: GUI, CLI, API Для кого подойдёт платформа, функциональные возможности, дистрибутив Roadmap, Release notes Нехватка прав, ошибки в платформе или документации, недостающая информация |
Получить вводную по платформе: понять сценарии использования, основные возможности, способы доступа, порядок получения дистрибутива, планы развития, изменения по версиям и каналы обратной связи. |
| Блог | Статьи Анонсы Release notes без галстуков |
Читать обзорные материалы, новости и неформальные Release notes. |
Откройте нужный Раздел в меню и уточните тему через вложенные страницы из колонки Что внутри. Фиксированный перечень изменений по версиям платформы — в Release notes внутри Общей информации; раздел Блог этот перечень не заменяет.
Смежные разделы и ссылки
На страницах часто есть ссылки на связанные разделы (в конце блока или в тексте). Если описание вашей задачи частично совпадает с темой другой страницы, перейдите по ссылке — там может быть нужная информация или следующий шаг.
Release notes и известные ограничения
В подразделе Общая информация → Release notes описаны изменения по версиям: новые возможности, исправления, прекращение поддержки. Дополнительно смотрите Roadmap — планы по направлениям развития. Если вы используете конкретную версию, проверьте, не описано ли нужное поведение или ограничение в release notes этой версии.
Запрос недостающей информации
Если вы просмотрели подходящий раздел и поиск по ключевым словам, но нужного описания или сценария нет, можно запросить дополнение документации или уточнение.
Коммерческая версия (Enterprise)
В Service Desk (портал поддержки вендора) размещена часть документации с прикладными инструкциями — имеет смысл проверить базу знаний перед обращением в поддержку.
Обратитесь в службу поддержки вендора (по каналам, указанным в договоре). В обращении укажите:
- Какую задачу или сценарий вы решаете (например: «настроить алертинг в кластер управления», «добавить узел в кластер с провайдером X»).
- Что именно не нашли — раздел, в котором искали, и какой информации не хватает (шаги, параметры, примеры).
- Версию платформы, которую используете.
Поддержка может подсказать, где уже описано нужное, или передать запрос на доработку документации.
Community‑версия
Используйте Telegram‑канал сообщества. Опишите, что вы хотите сделать и в каком разделе документации ожидали бы найти ответ.
Внутри организации
Если платформа развёрнута у вас в компании, администратор платформы или ответственный за внедрение «Штурвала» может располагать внутренними инструкциями, FAQ или доступом к дополнительным материалам. Имеет смысл уточнить у них, есть ли описание вашего сценария или куда направлять запросы на дополнение документации.
Если вы столкнулись с ошибкой в тексте документации (опечатка, неверный шаг, устаревшая информация), см. Что делать, если обнаружили ошибку в функционале платформы или в документации?.