¶ Руководство
Как упоминалось ранее, для управления кластером используется методология IaC посредством Flux и GitLab. Это накладывает некоторые правила, которые нужно соблюдать при работе с кластером. Далее приведена инструкция по по развертыванию приложения в Kubernetes.
¶ Подготовка
Прежде чем развертывать приложение в Kubernetes, необходимо убедиться что приложение соответствует определенным требованиям, а именно:
- Приложение может принимать все необходимые настройки не только через конфигурационные файлы но и через переменные среды
- Имеется документация ко всем настройкам приложения
- Имеется документация о директориях, в которых приложение хранит данные
- У приложения имеется Dockerfile, собранный Docker-образ, размещенный на Dockerhub или в реестре GitLab. Вы можете сделать их самостоятельно или попросить команду DevOps-ов помочь вам.
- Имеется документация по запуску приложения и особенностям работы (работа нескольких реплик одновременно, требования к ресурсам и т.д.)
¶ Написание манифестов
После того как вы подготовили контейнеры, необходимо создать набора манифестов, позволяющих развернуть ваше приложение в Kubernetes. Есть два основных способа это сделать: написать готовые манифесты, которые могут быть изменены с помощью Kustomize[1] или создать helm-чарт. Первый способ рекомендуется в случае если приложение может быть развернуто с минимальным количеством изменений, второй напротив рекомендуется при наличии большого количества изменяемых параметров
¶ Требования к helm-чартам
- Все переменные либо должны быть очевидными для использования, либо иметь описание в
README.md - Если для сервиса должен быть обеспечен доступ извне, то чарт должен содержать ресурсы Service и Ingress, а также Certificate[2] для обеспечения HTTPS соединения
Все образы котнейнеров должны иметь строго фиксированный тег, использование latestи подобных тегов не допускается- Желательно проверить все манифесты с помощью таких инструментов как checkov
¶ Развертывание
После того как манифесты готово, можно развернуть приложение с помощью Flux. В зависимости от того, используется ли Kustomize или Helm, процедуры будут немного отличаться, однако кратко процедура выглядит следующим образом: нужно создать манифест Flux, обозначающий применение Kustomize или Helm-чарта, создать ветку или форк в репозитории с манифестами flux, создать папку с необходимыми манифестами (см. ниже) в директории prod/, отправить Merge Request и дождаться пока его примут и развернут ваше приложение.
¶ Kustomize
Для того чтобы развернуть приложение с Kustomize необходимо создать следующие файлы:
kustomization.yml- стандартный файл Kustomize (см. тут)- Файлы с патчами для конкретного развертывания на которые необходимо сослаться из файла
kustomization.yml - Файл FluxCD, описывающий ваше развертывание со следующим содержимым:
apiVersion: kustomize.toolkit.fluxcd.io/v1 kind: Kustomization metadata: name: ingress-nginx namespace: flux-apps spec: interval: 10m sourceRef: kind: GitRepository name: flux-apps namespace: flux-apps path: prod/<app-name> # укажите здесь путь до вашего сервиса в репозитории prune: true
В виде диаграммы это можно представить следующим образом:
Flux читает манифест типа Kustomization, берет kustomize-файл из репозитория, а также все необходимые манифесты и патчи, и применяет их.
¶ Helm
Для развертывания манифестов из чарта необходимо создать манифест Flux HelmRelease:
apiVersion: helm.toolkit.fluxcd.io/v2beta1
kind: HelmRelease
metadata:
name: my-app
namespace: flux-apps
spec:
chart:
spec:
chart: traefik # имя чарта в репозитории
sourceRef:
kind: HelmRepository
name: helm-charts
targetNamespace: my-app
interval: 10m0s
values:
# разместите значение переменных чарта здесь