Установка AUSC#

Цель выполнения#

Целью данной инструкции «Установка AUSC» является описание последовательных шагов по развертыванию компонента AUSC. Выполнение инструкции обеспечивает корректную установку и настройку контроллера и адаптера автоскейлинга, включая настройку ролевой модели безопасности (RBAC), сборку и публикацию контейнерных образов, а также развертывание компонентов с помощью Helm-чарта.

Последовательность действий#

Для того, чтобы установить AUSC, необходимо выполнить следующие шаги:

Шаг 1. Скачайте версию дистрибутива с компонентом AUSC на ваше устройство и распакуйте дистрибутив

Шаг 2. Добавьте kubeconfig, бинарные и конфигурационные файлы в свой проект

Шаг 3. Установите необходимую ролевую модель для работы компонента AUSC

Шаг 4. Подготовка Docker-образов

Шаг 5. Развертывание сервиса c помощью Helm чарта

Шаг 1. Скачайте версию дистрибутива с компонентом AUSC на ваше устройство и распакуйте дистрибутив#

Цель выполнения#

Получить все необходимые компоненты установки AUSC: бинарные файлы, конфигурации и SBOM-данные - в локальной среде для последующего использования при развертывании.

Последовательность действий#

Скачайте дистрибутив с компонентом AUSC и извлеките содержимое zip файла в любую папку вашей ОС.
Перед установкой убедитесь, что состав дистрибутива компонента AUSC корректен и представлен в полном объеме.

Компонент AUSC предоставляет 2 архива (бинарные файлы и конфигурации), а также дополнительные файлы:

ausc-bin-{version}-{build}-distrib#

Элемент дистрибутива	Описание
./package/bh/synai_autoscaler_adapter	Бинарные файлы приложения «Adapter»
./package/bh/synai_autoscaler_controller	Бинарные файлы приложения «Controller»
./package/docker/adapter/Dockerfile	Dockerfile для сборки приложения «Adapter»
./package/docker/controller/Dockerfile	Dockerfile для сборки приложения «Controller»

ausc-cfg-{version}-{build}-distrib#

Конфигурации для установки.

Элемент дистрибутива	Описание
./package/conf/helm/application/ausc/*	Конфигурации развертывавния компонента

ausc-bin-{version}-{build}–cyclonedx-distrib.json#

В данном файле находится спецификация программного обеспечения SBOM (Software Bill Of Materials) - это список всех open source и других сторонних компонентов, использующихся в кодовой базе программного продукта.

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

С помощью SBOM вы можете просмотреть версии сборки, номера выпусков компонентов программного обеспечения и решить, продолжать их использование или нет. Это необходимо во избежание проблем с безопасностью в цепочках зависимостей. Поэтому, если в одной из библиотек обнаруживается проблема, вам необходимо знать, уязвимо ли приложение в целом.

CycloneDX — это стандарт SBOM от фонда OWASP, разработанный для контекстов безопасности приложений и анализа компонентов цепочки поставок, обеспечивающий инвентаризацию всех компонентов программного обеспечения как собственных, так и сторонних производителей.

Проверка результата#

Убедитесь, что:

Архивы ausc-bin-{version}-{build}-distrib.zip и ausc-cfg-{version}-{build}-distrib.zip успешно извлечены.
В директории ./package/ присутствуют подкаталоги bh, docker, conf.

Шаг 2. Добавьте kubeconfig, бинарные и конфигурационные файлы в свой проект#

Цель выполнения#

Обеспечить доступ AUSC к Kubernetes-кластеру и предоставить ему необходимые бинарные и конфигурационные файлы, организовав корректную структуру проекта для последующих этапов установки.

Последовательность действий#

Добавьте вручную kubeconfig, бинарные и конфигурационные файлы в свой проект так, чтобы иерархия файлов соответствовала следующей схеме:

∟ AUSC
    ∟ bin/ # папка ausc-bin-{version}-{build}-distrib
    ∟ conf/ # папка ausc-cfg-{version}-{build}-distrib
    ∟ kubeconfig # файл `kubeconfig` предоставляется администратором Kubernetes-кластера

Бинарные и конфигурационные файлы, а также kubeconfig должны находиться в корне каталога AUSC.

Проверка результата#

Убедитесь, что:

Файл kubeconfig размещен в корне директории AUSC

Шаг 3. Установка необходимой ролевой модели для работы компонента AUSC#

Цель выполнения#

Настроить ролевую модель для компонента, чтобы обеспечить его работу в пространстве имен ReleaseNamespace.

Последовательность действий#

Для ручной установки ролевой модели добавьте приложения «Adapter» и «Controller», воспользуйтесь шаблонами ниже. Для установки через helm chart доступен один из двух вариантов:

Использование кастомных средств развертывания ролей в рамках папки custom-role-model.
Использование конфигураций в рамках папки ext-role-model (ВНИМАНИЕ! У вас в данной папке может не быть ни одной конфигурации, в этом случае рекомендуется первый вариант).

Приложение «Adapter»#

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: autoscalerHPAMetricsReader
rules:
  - apiGroups:
      - "external.metrics.k8s.io"
    resources:
      - externalmetrics
    verbs:
      - get
      - list
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: autoscaler-system-auth-delegator
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: system:auth-delegator
subjects:
  - kind: ServiceAccount
    name: synai-adapter
    namespace:  # укажите namespace в котором вы разворачиваете AUSC
---
kind: RoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: autoscaler-auth-reader
  namespace: kube-system
subjects:
  - kind: ServiceAccount
    name: synai-adapter
    namespace: # укажите namespace в котором вы разворачиваете AUSC
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: extension-apiserver-authentication-reader
---
kind: RoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: autoscalerHPAMetricsReader
  namespace: {{$ns}}
subjects:
  - kind: ServiceAccount
    name: horizontal-pod-autoscaler
    namespace: kube-system
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: autoscalerHPAMetricsReader

Приложение «Controller»#

kind: ClusterRole
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: synai-autoscaler-controller
rules:
  - apiGroups:
      - ""
    resources:
      - limitranges
      - pods
    verbs:
      - get
      - list
      - watch
  - apiGroups:
      - ""
    resources:
      - events
    verbs:
      - create
      - patch
  - apiGroups:
      - apps
    resources:
      - deployments/scale
      - statefulsets/scale
    verbs:
      - get
      - list
      - patch
      - update
      - watch
  - apiGroups:
      - apps
    resources:
      - deployments
      - statefulsets
    verbs:
      - get
      - list
      - watch
  - apiGroups:
      - autoscaling
    resources:
      - horizontalpodautoscalers
    verbs:
      - create
      - delete
      - get
      - list
      - patch
      - update
      - watch
  - apiGroups:
      - autoscaler.synapse.sber
    resources:
      - scaledobjects
    verbs:
      - get
      - list
      - watch
      - patch
      - update
  - apiGroups:
      - autoscaler.synapse.sber
    resources:
      - projectcapacitypolicies
    verbs:
      - get
      - list
      - watch
  - apiGroups:
      - autoscaler.synapse.sber
    resources:
      - scaledobjects/finalizers
      - scaledobjects/status
      - projectcapacitypolicies/status
    verbs:
      - get
      - list
      - patch
      - update
      - watch
  - apiGroups:
      - metrics.k8s.io
    resources:
      - pods
    verbs:
      - get
      - list
      - watch
---
kind: Role
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: synai-autoscaler-controller-minimal
  namespace: # укажите namespace в котором вы разворачиваете AUSC
rules:
  - verbs:
      - get
      - list
      - watch
      - create
      - update
      - patch
      - delete
    apiGroups:
      - coordination.k8s.io
    resources:
      - leases
---
kind: RoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: synai-autoscaler-controller-minimal
  namespace: # укажите namespace в котором вы разворачиваете AUSC
subjects:
  - kind: ServiceAccount
    name: synai-controller
    namespace: # укажите namespace в котором вы разворачиваете AUSC
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: synai-autoscaler-controller-minimal
---
kind: RoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
  name: synai-autoscaler-controller
subjects:
  - kind: ServiceAccount
    name: synai-controller
    namespace: # укажите namespace в котором вы разворачиваете AUSC
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: synai-autoscaler-controller

Примечание: По умолчанию в конфигурационном файле values установка ролевой модели отключена. Для того, чтобы ролевая модель была установлена укажите в values.yaml (conf/helm/ausc/values.yaml) для useCustomRBAC в поле install значение «true» вместо false.

useCustomRBAC:
  install: "true"

Проверка результата#

Если все выполнено верно:

Role и RoleBinding существуют в указанном namespace.
ServiceAccount имеет необходимые права.

Шаг 4. Подготовка Docker-образов#

Цель выполнения#

Цель выполнения шага - подготовить бинарные файлы приложения, собрать их в контейнерный образ (image) и интегрировать его в конфигурации установки, чтобы обеспечить корректную работу системы.

Последовательность действий#

Используйте инструменты сборки, чтобы создать исполняемые файлы или артефакты.
Соберите Docker-образ, включающий бинарные файлы.

Чтобы собрать Docker-образ для controller введите следующую команду:

   docker build -t <ваш registry>/<ваш путь>/controller:latest -f package/docker/controller/Dockerfile . --build-arg=<базовый образ>

Далее отправьте Docker-образ для controller в registry, для этого введите следующую команду:

   docker push <ваш registry>/<ваш путь>/controller:latest

Чтобы собрать Docker-образ для adapter введите следующую команду:

   docker build -t <ваш registry>/<ваш путь>/adapter:latest -f package/docker/adapter/Dockerfile . --build-arg=<базовый образ>

Далее отправьте Docker-образ для adapter в registry, для этого введите следующую команду:

   docker push <ваш registry>/<ваш путь>/adapter:latest

Обновите конфигурационные файл values.yaml (conf/helm/ausc/values.yaml), указав новый образ:

registry: <ваш registry>
registry_path: <ваш путь>

Проверка результата#

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

Шаг 5. Развертывание сервисов c помощью Helm чарта#

Цель выполнения#

Цель выполнения шага - развернуть сервисы с использованием Helm-чарта, используя подготовленный Docker-образ с бинарными файлами, чтобы обеспечить корректную работу системы в кластере Kubernetes.

Последовательность действий#

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

   helm install <ваш релиз> ./path/to/chart --kubeconfig ./<ваш kubeconfig>.yaml --namespace <название вашего namespace>

Проверка результата#

Если все выполнено верно:

Helm-релиз будет отображаться в списке (helm list).
Все поды будут работать без ошибок.
AUSC успешно взаимодействует с ресурсами в наблюдаемых namespace-ах.

Проверка результата#

Корректным результатом проверки установки AUSC является соотвествие успешным проверкам в шагах:

Установка необходимой ролевой модели для работы компонента AUSC.
Сборка и установка бинарных файлов.
Развертывание сервисов c помощью Helm чарта.