Всё об инсталляции

Развернуть все Свернуть все

Вводная информация #

Для инсталляции платформы используется модуль первичной установки - shturval installer (stc) и лицензия. Модуль обновляется каждый релиз и всегда доступен для скачивания документации в разделе Платформа/Инсталляция. Прежде чем начать инсталляцию, определите, какая версия лицензии вам подойдет: enterprise или community edition.

Инсталляция в открытом контуре (т.е. из публичного репозитория shturval) доступна в любой версии лицензии. Инсталляция в закрытом контуре доступна только в enterprise лицензии. В закрытом контуре дополнительно требуется бандл - tar-архив, который содержит в себе всё необходимое для установки платформы, и утилита shturval mirror (stm) для работы с зеркалом. Бандл и утилита передаются заказчику вместе с enterprise лицензией.

Прежде чем начать инсталляцию обязательно ознакомьтесь с требованиями к платформе:

• Сколько хостов и какой производительности нужно для установки платформы;
• Какие виды операционных систем поддерживаются;
• Требования к синхронизации времени в зависимости от особенностей ОС;
• Как подготовить хосты для установки платформы;
• Особенности работы с сетевыми именами;
• Требования к балансировщику нагрузки (при использовании внешнего);
• Требования к IP-адресам, в т.ч. Virtual-IP для KubeAPI и Ingress.
• Требования для удаленного доступа.

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

Инсталляция #

Выбрали лицензию? Тогда переходим к инсталляции. Если еще нет, запросите лицензию CE или обратитесь за enterprise лицензией к представителю продукта Штурвал.

1. Определить контур инсталляции:

• Открытый (со всех хостов кластера потребуется доступ по 443 порту до r.shturval.tech)
• Закрытый (только для enterprise!. Перед запуском инсталляции выполните подготовку зеркала, для этого используйте выданный менеджером бандл.)

2. Подготовьте хосты с одной из ОС, указанных в таблице:

• 1 Master (6/8/80) для минимальной конфигурации (При необходимости после инсталляции можно будет добавить хосты в провайдере shturvalv2 с именем создаваемого кластера управления);
• 3 Master (4/16/100) и 3 Worker(8/32/300) для отказоустойчивой конфигурации;
• еще 1 (2/4/150) для зеркала, если инсталляция в закрытом контуре.

Не забудьте проверить:

• SELinux отключен или в режиме permissive;
• время между хостами и вашей рабочей машиной синхронизировано;
• с хостов удалены недоступные (например, родные) репозитории (потребуется только iptables и gnupg).

3. Создайте на каждом хосте пользователя. Этот пользователь должен иметь возможность выполнять sudo без пароля.
4. Вы можете использовать внешний или внутренний балансировщик KubeAPI и/или Ingress:

• Если используете внешний балансировщик, то для каждого компонента нужен FQDN (примеры сетевого взаимодействия)
• Если не используете внешний балансировщик, то подготовьте 2 непингуемых (свободных) IP-адреса. Они не должны быть настроены на каком-либо из хостов кластера, но должны быть в одной подсети с хостами Master-узлов.

5. Подготовьте сертификаты для применения при инсталляции или запустить установку без них, тогда будут установлены самоподписные сертификаты.
6. Для запуска инсталляции

• с машины на ОС Linux скачайте stc для linux и выполните команду, чтобы сделать файл исполняемым:

chmod +x ./stc-2.10.0

• с машины на ОС Windows скачайте stc для windows

7. Сгенерируйте ключевую пару с помощью команды:

ssh-keygen -t ed25519 -f shturval

8. Скопируйте ее на каждый хост будущего кластера с помощью команды:

ssh-copy-id -i shturval.pub ssh-user@IP-адрес-хоста

где вместо IP-адрес-хоста пропишите IP хоста будущего кластера. Если хостов будет более одного, выполните команду для каждого хоста.

9. Подготовьте адреса ntp-серверов, с которыми должна происходить синхронизация времени хостов (использованные в шаге 2).
10. Для инсталляции на рабочей машине с ОС Linux или Windows (в зависимости от того, какой stc вы скачали) запустите команду, в которую необходимо подставить свои значения параметров

Примеры команд для инсталляции #

• Для инсталляции в закрытом контуре добавьте в нужную команду параметр --registry=corp.domain.local:443, где вместо corp.domain.local введите адрес вашего реджистри.
• Для инсталляции с цепочкой сертификатов (ваш промежуточный сертификат -> сертификат корпоративного центра сертификации) в конец нужной команды добавьте ключи --ca-cert=ВВЕДИТЕ-ПУТЬ-ДО-ПРОМЕЖУТОЧНОГО-СЕРТИФИКАТА("pem" файла) и --ca-key=ВВЕДИТЕ-ПУТЬ-ДО-ЗАКРЫТОГО-КЛЮЧА-ПРОМЕЖУТОЧНОГО-СЕРТИФИКАТА
• Для инсталляции с корпоративными сертификатами в конец нужной команды добавьте ключи --ingress-cert=ВВЕДИТЕ-ПУТЬ-ДО-КОРПОРАТИВНОГО-СЕРТИФИКАТА("pem" файла) и --ingress-key=ВВЕДИТЕ-ПУТЬ-ДО-ЗАКРЫТОГО-КЛЮЧА-ПРОМЕЖУТОЧНОГО-СЕРТИФИКАТА
• Для инсталляции с ACME сертификатами в конец нужной команды добавьте ключи --acme-root-cert=ВВЕДИТЕ-ПУТЬ-ДО-КОРНЕВОГО-СA-ДЛЯ-ACME и --acme-url=ВВЕДИТЕ-АДРЕС-ACME-СЕРВЕРА-С-ПОРТОМ-И-ПУТЁМ-К-РЕСУРСУ
• При необходимости использования внешнего хранилища данных для OpenSearch, ознакомьтесь с инструкцией.

Примеры команд для инсталляции на 1 Master-узле (minimal) #

./stc-2.10.0 install management \
 --license="ВВЕДИТЕ-ВАШУ-ЛИЦЕНЗИЮ" \
 --cluster-name=ВВЕДИТЕ-НАЗВАНИЕ-КЛАСТЕРА \
 --ssh-user=ИМЯ-СОЗДАННОГО-ПОЛЬЗОВАТЕЛЯ \
 --ssh-private-key=ВВЕДИТЕ-ПУТЬ-ДО-ПРИВАТНОГО-КЛЮЧА  \
 --api-endpoint=ВВЕДИТЕ-IP-ДЛЯ-API-СЕРВЕРА \
 --master-nodes=ВВЕДИТЕ-IP-ХОСТА \
 --timezone=Europe/Moscow \
 --ingress-vip=ВВЕДИТЕ-IP-АДРЕС-ДЛЯ-INGRESS \
 --skip-check \
 --ntp-servers=ВВЕДИТЕ-АДРЕСА-NTP-СЕРВЕРОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛА \
 --minimal=true

./stc-2.10.0 install management \
 --license="ВВЕДИТЕ-ВАШУ-ЛИЦЕНЗИЮ" \
 --cluster-name=ВВЕДИТЕ-НАЗВАНИЕ-КЛАСТЕРА \
 --ssh-user=ИМЯ-СОЗДАННОГО-ПОЛЬЗОВАТЕЛЯ \
 --ssh-private-key=ВВЕДИТЕ-ПУТЬ-ДО-ПРИВАТНОГО-КЛЮЧА  \
 --use-external-kubeapi-lb=true  \
 --api-endpoint=ВВЕДИТЕ-ВАШ-FQDN \
 --timezone=Europe/Moscow \
 --master-nodes=ВВЕДИТЕ-IP-ХОСТА \
 --ingress-vip=ВВЕДИТЕ-IP-АДРЕС-ДЛЯ-INGRESS \
 --skip-check \
 --ntp-servers=ВВЕДИТЕ-АДРЕСА-NTP-СЕРВЕРОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛА \
 --minimal=true

./stc-2.10.0 install management \
 --license="ВВЕДИТЕ-ВАШУ-ЛИЦЕНЗИЮ" \
 --cluster-name=ВВЕДИТЕ-НАЗВАНИЕ-КЛАСТЕРА \
 --ssh-user=ИМЯ-СОЗДАННОГО-ПОЛЬЗОВАТЕЛЯ \
 --ssh-private-key=ВВЕДИТЕ-ПУТЬ-ДО-ПРИВАТНОГО-КЛЮЧА \
 --api-endpoint=ВВЕДИТЕ-IP-ДЛЯ-API-СЕРВЕРА \
 --timezone=Europe/Moscow \
 --use-external-ingress-lb=true \
 --master-nodes=ВВЕДИТЕ-IP-ХОСТА \
 --ingress=--ingress=ВВЕДИТЕ-FQDN-ДЛЯ-INGRESS \
 --skip-check \
 --ntp-servers=ВВЕДИТЕ-АДРЕСА-NTP-СЕРВЕРОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛА \
 --minimal=true

./stc-2.10.0 install management \
 -license="ВВЕДИТЕ-ВАШУ-ЛИЦЕНЗИЮ" \
 -cluster-name=ВВЕДИТЕ-НАЗВАНИЕ-КЛАСТЕРА \
 -ssh-user=shturval \
 -ssh-private-key=ВВЕДИТЕ-ПУТЬ-ДО-ПРИВАТНОГО-КЛЮЧА \
 -use-external-kubeapi-lb=true \
 -api-endpoint=ВВЕДИТЕ-FQDN-API-СЕРВЕРА \
 --timezone=Europe/Moscow \
 --use-external-ingress-lb=true \
 --master-nodes=ВВЕДИТЕ-IP-ХОСТА \
 --ingress=ВВЕДИТЕ-FQDN-ДЛЯ-INGRESS \
 --skip-check \
 --ntp-servers=ВВЕДИТЕ-АДРЕСА-NTP-СЕРВЕРОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛА \
 --minimal=true

Примеры команд для инсталляции в отказоустойчивой конфигурации (3 Master + 3 Worker) #

./stc-2.10.0 install management \
 --license="ВВЕДИТЕ-ВАШУ-ЛИЦЕНЗИЮ" \
 --cluster-name=ВВЕДИТЕ-НАЗВАНИЕ-КЛАСТЕРА \
 --ssh-user=ИМЯ-СОЗДАННОГО-ПОЛЬЗОВАТЕЛЯ \
 --ssh-private-key=ВВЕДИТЕ-ПУТЬ-ДО-ПРИВАТНОГО-КЛЮЧА \
 --api-endpoint=ВВЕДИТЕ-IP-ДЛЯ-API-СЕРВЕРА \
 --master-nodes=ВВЕДИТЕ-IP-ХОСТОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛОВ \
 --worker-nodes=ВВЕДИТЕ-IP-ХОСТОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛОВ \
 --timezone=Europe/Moscow \
 --ingress-vip=ВВЕДИТЕ-IP-АДРЕС-ДЛЯ-INGRESS \
 --skip-check \
 --ntp-servers=ВВЕДИТЕ-АДРЕСА-NTP-СЕРВЕРОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛА \

./stc-2.10.0 install management \
 --license="ВВЕДИТЕ-ВАШУ-ЛИЦЕНЗИЮ" \
 --cluster-name=ВВЕДИТЕ-НАЗВАНИЕ-КЛАСТЕРА \
 --ssh-user=ИМЯ-СОЗДАННОГО-ПОЛЬЗОВАТЕЛЯ \
 --ssh-private-key=ВВЕДИТЕ-ПУТЬ-ДО-ПРИВАТНОГО-КЛЮЧА \
 --use-external-kubeapi-lb=true \
 --api-endpoint=ВВЕДИТЕ-FQDN-API-СЕРВЕРА \
 --timezone=Europe/Moscow \
 --master-nodes=ВВЕДИТЕ-IP-ХОСТОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛОВ \
 --worker-nodes=ВВЕДИТЕ-IP-ХОСТОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛОВ \
 --ingress-vip=ВВЕДИТЕ-IP-АДРЕС-ДЛЯ-INGRESS \
 --skip-check \
 --ntp-servers=ВВЕДИТЕ-АДРЕСА-NTP-СЕРВЕРОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛА \

./stc-2.10.0 install management \
 --license="ВВЕДИТЕ-ВАШУ-ЛИЦЕНЗИЮ" \
 --cluster-name=ВВЕДИТЕ-НАЗВАНИЕ-КЛАСТЕРА \
 --ssh-user=ИМЯ-СОЗДАННОГО-ПОЛЬЗОВАТЕЛЯ \
 --ssh-private-key=ВВЕДИТЕ-ПУТЬ-ДО-ПРИВАТНОГО-КЛЮЧА \
 --api-endpoint=ВВЕДИТЕ-IP-ДЛЯ-API-СЕРВЕРА \
 --timezone=Europe/Moscow \
 --use-external-ingress-lb=true \
 --master-nodes=ВВЕДИТЕ-IP-ХОСТОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛОВ \
 --worker-nodes=ВВЕДИТЕ-IP-ХОСТОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛОВ \
 --ingress=ВВЕДИТЕ-FQDN-ДЛЯ-INGRESS \
 --skip-check \
 -ntp-servers=ВВЕДИТЕ-АДРЕСА-NTP-СЕРВЕРОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛА \

./stc-2.10.0 install management \
 --license="ВВЕДИТЕ-ВАШУ-ЛИЦЕНЗИЮ" \
 --cluster-name=ВВЕДИТЕ-НАЗВАНИЕ-КЛАСТЕРА \
 --ssh-user=ИМЯ-СОЗДАННОГО-ПОЛЬЗОВАТЕЛЯ \
 --ssh-private-key=ВВЕДИТЕ-ПУТЬ-ДО-ПРИВАТНОГО-КЛЮЧА \
 --use-external-kubeapi-lb=true \
 --api-endpoint=ВВЕДИТЕ-FQDN-API-СЕРВЕРА \
 --timezone=Europe/Moscow \
 --use-external-ingress-lb=true \
 --master-nodes=ВВЕДИТЕ-IP-ХОСТОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛОВ \
 --worker-nodes=ВВЕДИТЕ-IP-ХОСТОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛОВ \
 --ingress=ВВЕДИТЕ-FQDN-ДЛЯ-INGRESS \
 --skip-check \
 --ntp-servers=ВВЕДИТЕ-АДРЕСА-NTP-СЕРВЕРОВ-ЧЕРЕЗ-ЗАПЯТУЮ-БЕЗ-ПРОБЕЛА \

После завершения инсталляции #

После инсталляции вы получите:

• логин и пароль администратора платформы;
• kubeconfig администратора платформы;
• ссылку для перехода в графический интерфейс платформы “Штурвал”.

Сохраните логин, пароль и kubeconfig. Они статические и пригодятся вам для дальнейшей эксплуатации.

Управление хостами, доступными для присоединения в кластер управления происходит с помощью экземпляра провайдера shturvalv2 с именем кластера управления. Чтобы перейти в интерфейс кластера управления в веб-интерфейсе платформы перейдите в раздел “Кластер” на вкладку “Кластер управления”. Управление ресурсами кластера управления, в т.ч. количеством узлов в группе происходит из интерфейса кластера управления.

Управление платформенными ресурсами происходит в разделе “Платформа”. Информация о лимитах лицензии, Swagger находятся в разделе “О системе”.

Инсталляция с самоподписным сертификатом #

Если вы используете самоподписной сертификат при инсталляции, после завершения инсталляции и перехода в графический интерфейс платформы “Штурвал” в веб-браузере потребуется принять сертификаты:

• https://front.<shturval_cluster_name>.<base_domain>;
• https://back.<shturval_cluster_name>.<base_domain>;
• https://auth.<shturval_cluster_name>.<base_domain>.

где:

• <shturval_cluster_name> - IP-адрес или Ingress вашего кластера управления;
• <base_domain> - ваша доменная зона или shturval.link (если вы не настраивали свою доменную зону).

Чтобы заменить самоподписные на цепочку сертификатов или ACME после завершения инсталляции, воспользуйтесь инструкцией.

Как изменить пароль администратора #

При завершении установки система предоставит временный пароль администратора для первого входа в систему и настройки интеграции с внешней системой аутентификации.

Чтобы сменить пароль администратора по умолчанию, перейдите в установленный сервис “Модуль программного управления платформой” (объект типа shturvalserviceconfig shturval-backend) кластера управления. В спецификации сервиса найдите параметр static_password и обновите его значение.