{"queryDurationMs":52,"svc":{"svcId":151,"svc":"Vault","svcShort":"k8sOpenbao","code":null,"version":"master","orchestratorName":"Openbao","createUrl":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/create/job/master/buildWithParameters","isProductionReady":true,"resourceRealmTypeId":3,"iconSrc":null,"descr":"Хранилище секретов","man":"# Инструкция по развертыванию Хранилища секретов через платформу<br/><br/>## 1. Общая информация<br/>Хранилище секретов — сервис централизованного и защищённого хранения чувствительных данных (секретов, ключей, конфигураций). Предназначен для использования приложениями и сервисами в Kubernetes с управлением доступом на основе ролей.<br/>В качестве приложения используется открытый проект OpenBao с поддержкой кластерного режима RAFT.<br/><br/>### Доступные операции<br/>**create** — Создание хранилища секретов и инициализация кластера.<br/>**delete** — Удаление хранилища секретов с полной очисткой всех связанных сущностей.<br/>**modify** — Изменение параметров развернутого хранилища секретов.<br/>**suspend** — Приостановка работы кластера без удаления Persistent Volume.<br/>**resume** — Возобновление работы кластера с автоматическим unseal всех нод.<br/>**restart** — Поочередный перезапуск нод с последующим подключением в кластер.<br/>**create_kv** — Создание Key/Value хранилища версии V2.<br/>**delete_kv** — Удаление Key/Value хранилища со всеми содержащимися секретами.<br/>**create_secrets** — Создание секрета внутри Key/Value хранилища.<br/>**delete_secrets** — Удаление секрета из Key/Value хранилища.<br/>**update_secrets** — Обновление значения секрета.<br/>**recovery_secrets** — Откат секрета к указанной версии.<br/>**create_role** — Создание роли для управления Key/Value хранилищем или секретами.<br/>**update_role** — Обновление параметров роли.<br/>**delete_role** — Удаление роли доступа.<br/><br/>---<br/><br/>## 2. Параметры развертывания<br/><br/>Параметры входных данных операции **create**:<br/><br/>### Платформа для развертывания<br/>Описание: Кластер Kubernetes, в котором будет развернуто приложение.<br/>Формат значения: имя Kubernetes-кластера.<br/><br/>### Имя домена<br/>Описание: Доменное имя сервиса. При указании полного FQDN выполняется проверка DNS A-записи или добавляется А-запись в техническую зону.<br/>Формат значения: secrets.domain.com / mysecretdomain.<br/><br/>### Кол-во реплик<br/>Описание: Количество узлов в кластере.<br/>Формат значения: целое число.<br/><br/>### Квота ядра пода<br/>Описание: Лимит CPU для одного узла. Указывается в milicores (1000 milicores = 1 CPU).<br/>Формат значения: целое число.<br/><br/>### Квота памяти пода<br/>Описание: Лимит оперативной памяти для одного узла. Указывается в megabytes.<br/>Формат значения: целое число.<br/><br/>### Размер диска под хранение секретов<br/>Описание: Объем диска для хранения данных. Фактический объем равен значению, умноженному на количество реплик. Указывается в Gigabytes<br/>Формат значения: целое число.<br/><br/>### Версия OpenBao<br/>Описание: Версия OpenBao для развертывания сервиса.<br/>Формат значения: выбор из предоставленного списка версий.<br/><br/>---<br/><br/>## 3. Рекомендованные характеристики<br/><br/>### Тестовое окружение<br/>Кол-во реплик: 2.<br/>Квота ядра пода: 200.<br/>Квота памяти пода: 256.<br/>Размер диска под хранение секретов: 1.<br/>Версия OpenBao: актуальная стабильная версия.<br/><br/>### Промышленное окружение<br/>Кол-во реплик: от 3.<br/>Квота ядра пода: от 1000.<br/>Квота памяти пода: от 1024.<br/>Размер диска под хранение секретов: от 10.<br/>Версия OpenBao: актуальная стабильная версия.<br/><br/>---<br/><br/>## 4. Выходные параметры<br/>Настройки внутри хранилища (kv/secrets/roles) — конфигурации Key/Value, секретов и ролей, созданные соответствующими операциями.<br/>Настройки самого хранилище (сайзинг, объемы) — параметры ресурсов и хранилища данных, примененные к сервису.<br/>Статус кластера (running / suspended) — текущее состояние работы кластера.<br/>url для подключения к веб — адрес веб-интерфейса сервиса.<br/><br/>---<br/><br/>## 5. Дополнительная информация<br/>При удалении хранилища все данные и настройки безвозвратно удаляются.<br/>При использовании доменного имени требуется корректная настройка DNS.<br/>Операции управления секретами и ролями выполняются только после успешного создания хранилища.<br/>Удаление кластера производится через операцию `suspend`, а удаление становится доступно через 14 дней после остановки кластера<br/>Правило выше не относится к операции `delete_kv` / `delete_secrets` / `delete_role`","operations":[{"svcOperationId":215,"operation":"suspend","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/suspend/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":216,"operation":"resume","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/resume/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":237,"operation":"create_policy","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/create_policy/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":233,"operation":"delete_secrets","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/delete_secrets/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":234,"operation":"restart","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/restart/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":210,"operation":"create","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/create/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":211,"operation":"modify","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/modify/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":238,"operation":"update_policy","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/update_policy/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":239,"operation":"delete_policy","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/delete_policy/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":232,"operation":"recovery_secrets","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/recovery_secrets/job/master/buildWithParameters","descr":null,"man":"Данная операция подразумевает откат на конкретную версию в секрете.<br/><br/>**Это не восстановление удалённого секрета**"},{"svcOperationId":212,"operation":"create_kv","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/create_kv/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":230,"operation":"update_secrets","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/create_secrets/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":213,"operation":"delete_kv","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/delete_kv/job/master/buildWithParameters","descr":null,"man":"**ОСТОРОЖНО**<br/>Удаление KV подразумевает удаление ВСЕХ secrets внутри этой KV"},{"svcOperationId":231,"operation":"delete","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/delete/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":214,"operation":"create_secrets","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/create_secrets/job/master/buildWithParameters","descr":null,"man":null},{"svcOperationId":236,"operation":"reconcile","url":"https://jenkins-master1.adl.nubes.ru/job/cloudServicesDev/job/k8s/job/Openbao/job/reconcile/job/master/buildWithParameters","descr":null,"man":null}]},"runDurationMs":53}