Дополнительные настройки
В пользовательских параметрах (answers_raw_custom_params) файла ответов answers.yaml можно указать дополнительные переменные и переопределить значения по умолчанию для переменных ролей Ansible.
Подробнее — в разделе Подготовка файла ответов и разделе Переменные ролей Ansible.
Все параметры для дополнительных настроек описаны в файлах roles/<РОЛЬ>/README.md внутри образа Shepherd.
Примеры представлены ниже.
Настройки для повышения безопасности компонентов VK Dev Platform собраны в разделе Настройки для повышения безопасности (Hardening).
После редактирования файла ответов answers.yaml применяйте изменения командами shepherd init и shepherd deploy.
Доступ к Git-репозиториям по HTTPS используется через основной эндпоинт GitLab.
Чтобы включить доступ по SSH, укажите в файле answers.yaml:
answers_raw_custom_params:gitlab_ssh_enable: true
Дополнительно включите параметр gitlab_ssh_proxy_protocol_enabled при использовании nginx-addon в кластере Kubernetes в VK Cloud. Этот параметр:
- включайте только при настроенном Proxy Protocol;
- используйте только для перенаправления SSH-трафика через ingress-nginx.
Если нужен отдельный балансировщик нагрузки, например для нескольких тестовых экземпляров VK Dev Platform в одном кластере (сценарий для Dev-окружений), задайте дополнительные параметры:
answers_raw_custom_params:gitlab_ssh_enable: truegitlab_ssh_separate_lb: truegitlab_ssh_create_dns_record: truegitlab_ssh_dns_record_name: "<DNS_ЗАПИСЬ>"
Здесь <DNS_ЗАПИСЬ> — имя DNS-записи для отдельного балансировщика нагрузки GitLab SSH-сервиса.
Заранее проверьте доступность SSH-порта, балансировщика нагрузки и DNS.
Для публикации SSH-трафика через общий ingress-nginx требуется перенаправление TCP-трафика на стороне контроллера. В этом случае включите параметр gitlab_ssh_proxy_protocol_enabled. При использовании отдельного балансировщика нагрузки этот параметр игнорируется.
За настройку сбора логов отвечают параметры:
answers_observability_install— управляет развертыванием базового observability-стека.answers_logs_collection_enabled— управляет сбором логов компонентов.
В шаблоне answers.yaml оба параметра включены.
Агрегатор Vector принимает обработанные логи от агентов Vector и сохраняет их в Persistent Volume (PV).
Вы можете настроить пересылку логов из агрегатора во внешние системы, задать размер PV и настроить работу утилиты logrotate.
Полный список параметров для настройки — в файле roles/vector/README.md.
Настройки агента Vector размещайте под answers_raw_custom_params.vector, а агрегатора Vector — под answers_raw_custom_params.vector_aggregator.
В агрегаторе Vector входящие логи разделяются на два потока:
- логи аудита
route_by_category.audit; - логи приложений
route_by_category.app.
Настройка интеграции с внешними системами сбора и обработки логов выполняется в переменной vector_sinks_extra.
Пример:
answers_raw_custom_params:vector_aggregator:vector_secret_generic:password: "{% raw %}{{ all_vector_auth_password }}{% endraw %}"clickhouse-password: "{% raw %}{{ all_clickhouse_password }}{% endraw %}"vector_envs:- name: HTTP_AUTH_PASSWORDvalueFrom:secretKeyRef:name: "{% raw %}{{ vector_release_name }}{% endraw %}"key: password- name: CLICKHOUSE_PASSWORDvalueFrom:secretKeyRef:name: vector-aggregatorkey: clickhouse-passwordvector_sinks_extra:clickhouse:auth:password: "${CLICKHOUSE_PASSWORD}"strategy: basicuser: defaultbatch:max_events: 10000timeout_secs: 1database: my_ch_dbencoding:timestamp_format: unix_msendpoint: http://clickhouse.example.cominputs:- route_by_category.audit- route_by_category.appskip_unknown_fields: truetable: logstype: clickhouse
В этом примере:
- Нужно добавить зашифрованный пароль от ClickHouse
all_clickhouse_passwordв файл/shepherd/inventories/<ИМЯ_INVENTORY>/group_vars/all/secrets_custom.yaml. - В секциях
vector_secret_genericиvector_envsуказаны параметры, значения которых определены в файлеbase.yaml. Это нужно, чтобы не потерять эти значения, так как добавление в список новых параметров недоступно.
Логи аудита собираются из компонентов Samsara и Nexus.
Их можно перенаправить из агрегатора Vector во внешние системы из потока route_by_category.audit (пример настройки — в разделе Перенаправление логов во внешние системы).
Централизованное управление логированием настраивается в файле answers.yaml с помощью параметров answers_observability_install и answers_logs_collection_enabled. По умолчанию в шаблоне файла ответов они включены.
Чтобы управлять логированием отдельных компонентов, добавьте в дополнительные настройки переменные ролей <РОЛЬ>_log_collect_enabled.
Пример:
answers_raw_custom_params:samsara_log_collect_enabled: truegitlab_log_collect_enabled: truenexus_log_collect_enabled: trueredis_log_collect_enabled: falsesonarqube_log_collect_enabled: falsefront_log_collect_enabled: truekeycloak_log_collect_enabled: trueoidc_proxy_log_collect_enabled: truezalando_log_collect_enabled: truevk_registry_log_collect_enabled: true
Настройка уровня логирования поддерживается для компонентов Samsara, Nexus, Redis и SonarQube.
Пример настроек в файле answers.yaml:
answers_raw_custom_params:samsara_logger_level: "INFO"samsara_konf_fu_log_level: "INFO"nexus_log_level: "INFO"sonarqube_log_level_root: "INFO"redis_log_level: "notice"
Поддерживаемые значения уровней логирования проверяйте в файлах roles/<РОЛЬ>/README.md конкретной роли.
Пример: Redis поддерживает notice, warning, verbose, debug.
Настройка уровня логирования не включает сбор логов — убедитесь, что он включен (подробнее — в разделе Настройка сбора логов).
Сбор метрик с подов приложений осуществляется на базе VMAgent.
VMAgent устанавливается опционально и выключен по умолчанию.
Для его установки добавьте в файл answers.yaml:
answers_raw_custom_params:vmagent_enable: truevmagent_install: truevmagent_remote_write_list:- url: "https://metrics.example.com/api/v1/write"
Здесь https://metrics.example.com/api/v1/write — пример адреса, замените на свой эндпоинт VictoriaMetrics или Prometheus.
Параметры TLS и аутентификации согласуйте с сервисом, принимающим метрики.
Все доступные параметры для настройки — в файле roles/vmagent/README.md.
Установка VMAgent и компонентные scrape-переключатели — разные настройки. Пример дополнительной настройки для Samsara:
answers_raw_custom_params:samsara_metrics_scrape_enabled: true
При необходимости также включите сбор метрик для Redis и VK Dev Platform с помощью redis_metrics_scrape_enabled и vk_registry_metrics_scrape_enabled.
Нужный класс хранения (StorageClass) должен быть заранее создан в кластере Kubernetes.
Если для компонентов не установлен класс хранения по умолчанию или нужно изменить это значение, задайте класс хранения в файле answers.yaml.
Пример:
answers_raw_custom_params:nexus_storage_class: "<ИМЯ_КЛАССА_ХРАНЕНИЯ>"pgadmin_storage_class: "<ИМЯ_КЛАССА_ХРАНЕНИЯ>"redis_master_pv_storage_class: "<ИМЯ_КЛАССА_ХРАНЕНИЯ>"samsara_temp_storage_class_name: "<ИМЯ_КЛАССА_ХРАНЕНИЯ>"sonarqube_persistent_storage_class: "<ИМЯ_КЛАССА_ХРАНЕНИЯ>"vk_registry_data_persistence_storage_class: "<ИМЯ_КЛАССА_ХРАНЕНИЯ>"vk_registry_temp_persistence_storage_class: "<ИМЯ_КЛАССА_ХРАНЕНИЯ>"zalando_pg_cluster_storage_class: "<ИМЯ_КЛАССА_ХРАНЕНИЯ>"vector_aggregator:vector_pvc_storage_class: "<ИМЯ_КЛАССА_ХРАНЕНИЯ>"
Здесь <ИМЯ_КЛАССА_ХРАНЕНИЯ> — имена существующих классов хранения для каждого компонента.
При выборе классов хранения проверьте требования к режиму доступа (access mode) и зонам доступности.
Чтобы указать почту для обращения в техническую поддержку, заполните следующий параметр в файле answers.yaml:
answers_raw_custom_params:front_env_support_email: "<ПОЧТА>"
Здесь <ПОЧТА> — действующая почта вашего контура. Пример: support@example.com.
Базовые доменные имена компонентов:
- Портал Front/Samsara —
portal.<ДОМЕН>; - GitLab —
gitlab.<ДОМЕН>; - Keycloak —
keycloak.<ДОМЕН>; - Административная консоль Keycloak (если включена) —
keycloak-admin.<ДОМЕН>; - Nexus —
nx.<ДОМЕН>; - Nexus (анонимный доступ) —
nxa.<ДОМЕН>; - VK Registry —
vkr.<ДОМЕН>; - VK Registry (анонимный доступ) —
vkra.<ДОМЕН>; - pgAdmin —
pgadmin.<ДОМЕН>; - SonarQube —
sonarqube.<ДОМЕН>; - Агрегатор Vector —
vector-aggregator.<ДОМЕН>.
Изменить эти значения можно через переменную all_dns_records_extra.
Пример переопределения доменного имени для компонента gitlab с сохранением поддоменной части в файле answers.yaml:
answers_raw_custom_params:all_dns_records_extra:gitlab: "{% raw %}code.{{ all_domain }}{% endraw %}"
В этом примере доменное имя gitlab.<ДОМЕН> заменяется на code.<ДОМЕН>.
Shepherd CLI не генерирует сервисные учетные записи и токены внешних сервисов.
Токены хранятся в shepherd-secrets, но генерируются в сервисах, с которыми интегрируется VK Dev Platform.
В следующих примерах для добавления нового ключа используются команды с add.
Существующие ключи обновляются командой shepherd secrets update <key> с интерактивным вводом.
Для интеграции с публичным облаком VK Cloud требуется токен Hoe — сервисный токен для авторизации в облачном сервисе Hoe.
-
Обратитесь в техническую поддержку VK Cloud, чтобы получить токен Hoe.
-
Добавьте токен Hoe:
$ shepherd secrets add samsara_vkc_service_token --value -
В файле
answers.yamlнастройте версию VK Cloud через переменнуюsamsara_vkc_versionи параметры подключения согласноroles/samsara/README.md.
-
Создайте сервисную учетную запись в системе Проекты VK WorkSpace, если она еще не создана (подробнее — в разделе Внешние интеграции). После создания вы получите токен Проекты VK WorkSpace.
-
Добавьте токен:
$ shepherd secrets add samsara_teamstorm_token --value -
В файле
answers.yamlнастройте параметры интеграции и включите опциюsamsara_alm_project_feature_flagсогласноroles/samsara/README.md. -
Выполните инициализацию:
$ shepherd init -
Запустите развертывание Samsara:
$ shepherd deploy --tags samsara-role -
Проверьте интеграцию и права сервисной учетной записи.
-
Создайте сервисную учетную запись в Test IT, если она еще не создана (подробнее — в разделе Внешние интеграции). После создания вы получите токен Test IT.
-
Добавьте токен:
$ shepherd secrets add samsara_testit_token --value -
В файле
answers.yamlнастройте параметры интеграции и включите опциюsamsara_testit_feature_flagсогласноroles/samsara/README.md. -
Выполните инициализацию:
$ shepherd init$ shepherd deploy --tags samsara-role -
Проверьте интеграцию и права сервисной учетной записи.