# Установка контроллера nsctl

## Шаг 2. Установите контроллер nsctl

Установка контроллера `nsctl` может быть выполнена двумя способами в зависимости от ваших прав доступа к Kubernetes-кластеру:

- [**Автоматизированная установка**](#автоматизированная-установка) - требует прав администратора. Helm-чарт самостоятельно создаст все необходимые ресурсы Kubernetes, включая пространство имен для Global ERP и ресурсы RBAC. 

- [**Установка с ручной подготовкой окружения**](./060_install_nsctl_manual.md).

  Требует участия администратора кластера. Пространство имён и роли с правами доступа должны быть созданы вручную, а оставшиеся ресурсы, такие как ресурс контроллера `nsctl` и `ConfigMap` с параметрами, разворачиваются из Helm-чарта. 
  ```{note}
  Выберите этот путь, если развертывание производится на кластере с ограниченными правами пользователя Kubernetes, например, на общекорпоративном коммунальном кластере.
  ```

Если вам удобнее, то можете Helm-чарт скачать отдельно от `nscli`:

~~~bash
cd ~
wget --backups=1 --user=<пользователь> --ask-password "https://repo.global-system.ru/ui/native/general/ru/bitec/gs-ctk-helm-chart/SNAPSHOT/gs-ctk-helm-chart-SNAPSHOT.tgz"
~~~

Мы предполагаем, что мы будем разворачивать Helm-чарт из дистрибутива `nscli`, он точно такой же.

### Автоматизированная установка

Системное NFS-хранилище должно вмещать комплекты и автоматически выгружаемые дампы памяти. Минимальный объём —
**5–6 размеров максимального `-Xmx`, но не менее 120 ГБ**; см.
[расчёт объёма](../043_kubernetes_advanced/020_min_requirements.md#системное-nfs-хранилище-кластера).

1. Подготовьте values.yaml:

    ```{important}
       Не забудьте изменить параметры доступа к системному файловому хранилищу
    ```

    ```bash
    cat <<EOF | tee values.yaml
    # Реестр образов
    imageRepository: docker-registry.net

    # Системное NFS-хранилище для комплектов групп, приложений и дампов памяти
    # Минимальный объём: 5–6 размеров максимального Xmx, но не менее 120 ГБ
    systemVolume:
        nfs:
            server: "nfs.server" # Путь к NFS-серверу
            path: /export # Путь к публикуемой на NFS-сервере папке

    # Секрет загрузки с репозитория
    imagePullSecret: "" # или "docker-secret", если Docker-реестр требует авторизации
    
    # Селекторы нод для подов
    #nodeSelector: {}
    # Tolerations для подов
    #tolerations: []
    # Affinity для подов
    #affinity: {}
    EOF
    ```

    ```{note}
       Весь список параметров смотрите в `values.yaml` из чарта. Получить `values.yaml` из скачанного отдельно Helm-чарта можно при помощи команды `helm show values gs-ctk-helm-chart-SNAPSHOT.tgz > values.yaml`.

       Документация по параметрам Helm-чарта доступна [здесь](../043_kubernetes_advanced/030_chart.md).
    ```

   **Режим ссылок на образы (Helm)**

   При установке Helm-чарта способ формирования ссылок на образы задается в `values.yaml` параметром `imageMode`:
   
   - `tag` - совместимый режим, образа указываются по тегу (`:<tag>`).
   - `digestAuto` - nsctl будет разворачивать контейнеры по хешам образов (digest), сформированным вендором при сборке. (Рекомендуемый вариант)
   - `digestManual` - digest указываются вручную через `imageDigests`.
   
   Параметр `imageDigests` задается списком, например:
   
   ```yaml
   imageMode: digestManual  # варианты: tag | digestAuto | digestManual
   imageTag: "SNAPSHOT"
   imageDigests:
     - image: nsctl
       digest: sha256:...
     - image: globalserver
       digest: sha256:...
   ```
   
   В режиме `digestAuto` значение для `image=nsctl` можно задать в `imageDigests` опционально.

    ```{note}
        Docker-секрет будет создан позже, после развертывания пространства имен Helm-чартом.
    ```

2. Разверните Helm-чарт вместе с пространством имен:

    ```sh
    helm upgrade \
         --install \
         gs-ctk \
         ~/nscli/helm_chart \
         -f values.yaml
    ```

    ```{note}
    Если вы скачали Helm-чарт отдельно от nscli, то укажите вместо `~/nscli/helm_chart` путь к скачанному файлу, например, `./gs-ctk-helm-chart-SNAPSHOT.tgz`.
    ```

    ```text
    NAME: gs-ctk
    LAST DEPLOYED: Tue Jan 19 03:14:08 2038
    NAMESPACE: default
    STATUS: deployed
    REVISION: 1
    TEST SUITE: None
    NOTES:
    =====================================

    GS-CTK
    Версия SNAPSHOT-5.1.3
    Copyright © 2000-2025
    Компания «Бизнес Технологии»
    Все права защищены.

    =====================================
    Развернут в пространстве имен `gs-ctk`.
    (venv)
    ```

3. Создайте и примените Docker-секрет:

    ```bash
    docker login docker-registry.net # укажите здесь ваш репозиторий

    cat <<EOF | tee docker-secret.yaml
    apiVersion: v1
    kind: Secret
    metadata:
      name: docker-secret
      namespace: gs-ctk
    data:
      .dockerconfigjson: $(cat ~/.docker/config.json | base64 | tr -d '\n')
    type: kubernetes.io/dockerconfigjson
    EOF

    kubectl apply -f docker-secret.yaml
    ```

4. Проверьте, что под `nsctl` находится в состоянии `Running`.

   На развертывание может потребоваться некоторое время, так как требуется скачать образ контейнера и запустить его. Обычно это занимает не больше пяти минут.

    ```bash
    kubectl get pods --namespace gs-ctk
    ```

    ```text
    NAME                     READY   STATUS    RESTARTS   AGE
    nsctl-84cb5578fd-b2c5x   1/1     Running   0          1h
    ```

Если `nsctl` запустился, у вас должно быть все готово к переходу [к созданию секретов](./070_create_secrets.md).
