Перейти к основному содержимому

Управление точками установки

Точка установки — это цель развертывания сертификата в файле конфигурации clmBot. Она состоит из формата сертификата (format), пути к файлу и скрипта обновления. Один узел clmBot может управлять несколькими точками установки.

clmBot предоставляет следующие команды управления точками установки:

КомандаНазначение
discover-certificateАвтоматически сканировать сертификаты на локальном компьютере (и в контейнерах Docker) и добавлять их как точки установки
add-serverИнтерактивно добавить точку установки вручную (записывается только в локальную конфигурацию)
sync-serverСинхронизировать локальные точки установки с облаком и откалибровать номера подписки на сертификаты
setupЗапустить локальную веб-страницу конфигурации для управления точками установки в браузере
query-certificateПросматривать в режиме только для чтения информацию о сертификатах, развернутых в каждой точке установки

Автоматическое обнаружение точек установки сертификатов​

Выполните discover-certificate, чтобы автоматически просканировать сертификаты, уже развернутые на сервере:

./clm-bot-linux-amd64 discover-certificate

Область сканирования:

  • Linux: nginx, Apache HTTP Server, Tomcat.
  • Windows: IIS.

После выполнения команды найденная информация о сертификатах будет выведена в виде таблицы (источник, тип, центр сертификации, субъект, путь, точка доступа, серийный номер и т. д.). Введите порядковый номер сертификата, чтобы подтвердить добавление в административную консоль:

  • all: загрузить все
  • none: не загружать
  • 1,3-5: выбор по порядковым номерам, поддерживается запись диапазона

После успешной загрузки эти сертификаты появятся в административной консоли как точки установки, и clmBot сгенерирует соответствующую конфигурацию для каждой точки установки в config.yaml.

Доступные параметры​

ПараметрОписание
--yes / -yПропустить выбор и загрузить все точки установки
--selectНапрямую укажите порядковый номер для загрузки (all, none или 1,3-5), взаимоисключающий с --yes
--skip-filter / -sПропустить фильтрацию по доменам (SAN) сертификата, по умолчанию загружаются только сертификаты, соответствующие разрешённым доменам в облаке
--scan-docker / -dДополнительное сканирование конфигураций nginx, Apache, Tomcat внутри Docker-контейнеров (только Linux/macOS)
--scan-onlyТолько сканирование и вывод всех точек установки сертификатов, без входа и загрузки — подходит для предварительного просмотра перед развёртыванием

Сценарий с Docker-контейнерами​

При использовании --scan-docker clmBot сканирует запущенные на данном хосте контейнеры nginx, Apache, Tomcat:

  • Путь к сертификату внутри контейнера должен быть смонтирован на хост-машину и доступен для записи, иначе эта точка установки будет пропущена.
  • Точка доступа для места установки будет сгенерирована с использованием IP и порта, опубликованных хост-машиной.
  • С помощью переменных окружения CLMBOT_NGINX_CONTAINERS, CLMBOT_APACHE_CONTAINERS, CLMBOT_TOMCAT_CONTAINERS можно указать имена контейнеров для сканирования (несколько имён контейнеров разделяются точкой с запятой).

Добавление точки установки вручную​

Если облачный сертификат не развёрнут на сервере или автоматическое сканирование не смогло его обнаружить, точку установки можно добавить вручную:

./clm-bot-linux-amd64 add-server 260101AABBCC pem

Первый параметр — это номер подписки сертификата, второй параметр — формат сертификата (pem, pfx, jks, iis или exchange). Следуя подсказкам, по очереди введите идентификатор точки установки и путь к файлу соответствующего формата.

add-server только записывает точку установки в локальный config.yaml и не загружает её автоматически в облако; если требуется синхронизация с облаком, выполните затем sync-server.

Синхронизация точки установки с облаком​

sync-server Загрузите локальные точки установки из конфигурации в облако и используйте идентификатор подписки, возвращённый облаком, для дополнения или корректировки локальной конфигурации:

./clm-bot-linux-amd64 sync-server

После выполнения отобразится список локальных точек установки; выберите по номеру элемент для загрузки (также поддерживаются all, none, 1,3-5), либо используйте --yes для загрузки всех или --select для прямого указания.

Информация
  • Если локальный идентификатор подписки пуст, он будет заполнен автоматически; при расхождении с облаком будут перечислены конфликты, и перезапись произойдёт только после подтверждения.
  • Точки установки в формате Exchange пока не поддерживают синхронизацию.

Локальная страница веб-конфигурации​

Если командная строка неудобна, можно использовать setup для запуска локальной страницы конфигурации и добавлять, редактировать и удалять точки установки в браузере:

./clm-bot-linux-amd64 setup

После выполнения будет выведен адрес доступа со случайным токеном (например, http://localhost:<端口>/setup?token=...). Откройте его в браузере на самом сервере, чтобы управлять точками установки.

Внимание

Страница настройки слушает только петлевой адрес самого сервера и недоступна с других хостов. Не сообщайте адрес доступа с токеном посторонним лицам; после завершения работы нажмите Ctrl+C (или выполните действия согласно подсказке), чтобы остановить страницу.

Если нужно указать порт, используйте параметр -a (например, setup -a localhost:8900); в среде со старым браузером можно добавить --legacy, чтобы использовать страницу настройки на чистом HTML.

Просмотр сведений о сертификатах точек установки​

query-certificate позволяет только для чтения просматривать сведения о сертификатах (тема, издатель, серийный номер), развёрнутых в данный момент на каждой точке установки, и не изменяет файлы сертификатов:

./clm-bot-linux-amd64 query-certificate

По умолчанию запрашиваются все точки установки. Для указания ID точки установки можно использовать параметр -i, например query-certificate -i nginx_pem.

Дальнейшие действия​

После того как точка установки будет готова, настройте способ обновления сертификата. См. Способ обновления сертификата.