Интеграция с Argo CD

Argo CD — декларативный инструмент для непрерывной доставки в Kubernetes по модели GitOps.

В этом руководстве описана интеграция инстанса Yandex Managed Service for GitLab, кластера Managed Service for Kubernetes и установленных в кластере Argo CD и GitLab Runner, который выполняет сборку Docker-контейнеров с помощью инструмента Kaniko.

Чтобы интегрировать Argo CD с Managed Service for Kubernetes и Managed Service for GitLab:

1. Создайте инстанс GitLab.
2. Настройте GitLab.
3. Создайте GitLab Runner.
4. Подготовьте репозиторий приложения для развертывания.
5. Разверните приложение с помощью Argo CD.

Если созданные ресурсы вам больше не нужны, удалите их.

Перед началом работыПеред началом работы

Подготовьте инфраструктуруПодготовьте инфраструктуру

Установите дополнительные зависимостиУстановите дополнительные зависимости

Установите в локальном окружении:

• Интерфейс командной строки Yandex Cloud (YC CLI).
• Утилиту потоковой обработки JSON-файлов jq.
• Менеджер пакетов Helm.

• Установите kubectl и настройте его на работу с созданным кластером.

Создайте инстанс GitLabСоздайте инстанс GitLab

Создайте инстанс Managed Service for GitLab или виртуальную машину с образом GitLab в той же облачной сети, где расположен кластер Managed Service for Kubernetes.

Настройте GitLabНастройте GitLab

Чтобы настроить GitLab и подготовить процесс непрерывной интеграции (Continuous Integration, CI), создайте новый проект и введите параметры для авторизации в CI:

Создайте GitLab RunnerСоздайте GitLab Runner

Чтобы запускать задачи сборки в кластере Yandex Managed Service for Kubernetes, создайте GitLab Runner. Для этого установите приложение GitLab Runner согласно инструкции.

После установки вы можете запускать автоматизированные сборки внутри своего кластера Managed Service for Kubernetes.

Подробнее про установку и настройку GitLab Runner читайте в документации GitLab.

Подготовьте репозиторий приложения для развертыванияПодготовьте репозиторий приложения для развертывания

1. Получите авторизованный ключ для созданного ранее сервисного аккаунта с ролями container-registry.images.puller и container-registry.images.pusher:

   yc iam key create --service-account-name <имя_сервисного_аккаунта_для_узлов> -o key.json
   

2. Сохраните содержимое этого ключа — оно потребуется на следующем шаге:

   cat key.json | base64
   

3. Создайте переменные окружения GitLab:

   1. На панели слева в GitLab перейдите в раздел Settings и во всплывающем списке выберите пункт CI/CD.

   2. Нажмите кнопку Expand напротив пункта Variables.

   3. Добавьте переменные окружения:

      • CI_REGISTRY — адрес созданного ранее реестра в формате cr.yandex/<идентификатор_реестра>.
      • CI_REGISTRY_USER — json_key.
      • CI_REGISTRY_PASSWORD — вывод команды cat key.json | base64.

      Для добавления переменной:

      1. Нажмите кнопку Add variable.
      2. В появившемся окне в поле Key укажите имя переменной, в поле Value — значение переменной.
      3. Нажмите кнопку Add variable.

4. Настройте доступ к репозиторию:

   1. Сгенерируйте новую пару SSH-ключей или используйте существующую.
   2. Добавьте публичную часть SSH-ключа в настройки учетной записи GitLab.

5. Клонируйте репозиторий:

   git clone git@<имя_инстанса>.gitlab.yandexcloud.net:<имя_пользователя-администратора>/gitlab-test.git
   

6. Клонируйте репозиторий yc-webinar-gitops-argo-crossplane на рабочую машину:

   git clone https://github.com/yandex-cloud-examples/yc-webinar-gitops-argo-crossplane.git
   

7. Скопируйте в директорию gitlab-test все файлы из директории yc-webinar-gitops-argo-crossplane/02-argocd/app, включая скрытые:

   cp -rT <путь_к_директории_app> <путь_к_директории_gitlab-test>
   

8. Зафиксируйте изменения в gitlab-test и отправьте их в репозиторий:

   git add . && \
   git commit -m "Add app src and CI" && \
   git push
   

9. Запустится сценарий сборки. Чтобы посмотреть его выполнение, выберите в выпадающем меню пункт Build → Pipelines. Дождитесь успешного завершения обоих этапов сборки.

10. Откройте завершенную сборку и скопируйте строку из лога, она понадобится на следующем этапе:

    INFO[0025] Pushing image to cr.yandex/<идентификатор_реестра>/<имя_пользователя-администратора>/gitlab-test:main.<номер_коммита>
    

Разверните приложение с помощью Argo CDРазверните приложение с помощью Argo CD

Установите Argo CD в кластер Managed Service for KubernetesУстановите Argo CD в кластер Managed Service for Kubernetes

1. Установите Argo CD согласно инструкции.

   Важно

   Группам узлов Kubernetes требуется доступ в интернет для скачивания образов и компонентов.

   Предоставить доступ в интернет можно следующими способами:

   • Назначить каждому узлу в группе публичный IP адрес.
   • Настроить виртуальную машину в качестве NAT-инстанса.
   • Настроить NAT-шлюз.

2. Настройте переадресацию порта сервиса ArgoCD на локальный компьютер:

   kubectl port-forward service/<название_приложения_Argo_CD>-argocd-server \
     --namespace <пространство_имен> 8080:443
   

3. Получите пароль администратора из секрета Kubernetes:

   kubectl --namespace <пространство_имен> get secret argocd-initial-admin-secret \
     --output jsonpath="{.data.password}" | base64 -d
   

4. Откройте в браузере консоль Argo CD по адресу https://127.0.0.1:8080.

5. Авторизуйтесь в консоли, используя имя пользователя admin и пароль, полученный на предыдущем шаге.

Добавьте репозиторий GitLab в Argo CDДобавьте репозиторий GitLab в Argo CD

1. На панели слева в GitLab перейдите в раздел Settings и во всплывающем списке выберите пункт Access Tokens.

2. Задайте параметры нового токена:

   • Token name — argocd.
   • Select a role — Maintainer.
   • Select scopes — read_repository.

3. Нажмите кнопку Create project access token.

4. Скопируйте значение созданного токена.

5. В консоли Argo CD перейдите в раздел Settings → Repositories.

6. Нажмите кнопку Connect Repo Using HTTPS.

7. В открывшейся форме задайте параметры:

   • Repository URL — URL репозитория вида https://<имя_инстанса_GitLab>.gitlab.yandexcloud.net/<имя_пользователя-администратора>/gitlab-test.git.
   • Username — gitlab-ci-token.
   • Password — токен GitLab, сгенерированный ранее.

8. Нажмите кнопку Connect.

9. В консоли Argo CD перейдите в раздел Applications и нажмите кнопку Create Application.

10. В открывшейся форме задайте параметры:

    • Application Name — gitlab-test.
    • Project — default.
    • Sync policy — Automatic, затем выберите опции Prune resources и Self Heal.
    • Sync options — выберите опцию Auto-Create Namespace.
    • Repository URL — укажите URL репозитория вида https://<имя_инстанса_GitLab>.gitlab.yandexcloud.net/<имя_пользователя-администратора>/gitlab-test.git.
    • Path — .helm.
    • Cluster URL — https://kubernetes.default.svc.
    • Namespace — gitlab-test.
    • image.repository — cr.yandex/<идентификатор_реестра>/<имя_пользователя-администратора>/gitlab-test.
    • image.tag — main.<номер_коммита>.

11. Нажмите кнопку Create и дождитесь завершения синхронизации.

12. Для проверки запуска приложения выполните команду в кластере Managed Service for Kubernetes:

    kubectl get all -n gitlab-test
    

    Результат:

    NAME                               READY   STATUS    RESTARTS   AGE
    pod/gitlab-test-67c8d58bc4-6w4q7   1/1     Running   0          2m26s
    pod/gitlab-test-67c8d58bc4-sldpc   1/1     Running   0          2m26s
    
    NAME                  TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)   AGE
    service/gitlab-test   ClusterIP   10.96.186.223   <none>        80/TCP    2m26s
    
    NAME                          READY   UP-TO-DATE   AVAILABLE   AGE
    deployment.apps/gitlab-test   2/2     2            2           2m26s
    
    NAME                                     DESIRED   CURRENT   READY   AGE
    replicaset.apps/gitlab-test-67c8d58bc4   2         2         2       2m26s
    

Проверьте автоматическую синхронизацию из репозиторияПроверьте автоматическую синхронизацию из репозитория

1. Перейдите в директорию с клонированным проектом и откройте файл .helm/values.yaml.

2. Измените значение параметра replicaCount на 3.

3. Сохраните изменения и отправьте их в репозиторий:

   git add . && \
   git commit -m "Increase replica count" && \
   git push
   

4. В консоли Argo CD дождитесь синхронизации приложения.

5. Проверьте, что количество подов приложения в кластере Managed Service for Kubernetes увеличилось:

   kubectl get pod -n gitlab-test
   

   Результат:

   NAME                               READY   STATUS    RESTARTS   AGE
   pod/gitlab-test-67c8d58bc4-6w4q7   1/1     Running   0          15m
   pod/gitlab-test-67c8d58bc4-7hmcn   1/1     Running   0          10m
   pod/gitlab-test-67c8d58bc4-sldpc   1/1     Running   0          15m
   
   NAME                  TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)   AGE
   service/gitlab-test   ClusterIP   10.96.186.223   <none>        80/TCP    15m
   
   NAME                          READY   UP-TO-DATE   AVAILABLE   AGE
   deployment.apps/gitlab-test   3/3     3            3           15m
   
   NAME                                     DESIRED   CURRENT   READY   AGE
   replicaset.apps/gitlab-test-67c8d58bc4   3         3         3       15m
   

Удалите созданные ресурсыУдалите созданные ресурсы

Некоторые ресурсы платные. Чтобы за них не списывалась плата, удалите ресурсы, которые вы больше не будете использовать:

1. Удалите созданные Docker-образы.

2. Удалите кластер Managed Service for Kubernetes и реестр Container Registry:

   Вручную

   Terraform

   1. Удалите кластер Managed Service for Kubernetes.
   2. Удалите реестр Container Registry.
   3. Удалите созданные подсети и сети.
   4. Удалите созданные сервисные аккаунты.

   1. В командной строке перейдите в директорию, в которой расположен актуальный конфигурационный файл Terraform с планом инфраструктуры.

   2. Удалите конфигурационный файл k8s-argocd.tf.

   3. Проверьте корректность файлов конфигурации Terraform с помощью команды:

      terraform validate
      

      Если в файлах конфигурации есть ошибки, Terraform на них укажет.

   4. Подтвердите изменение ресурсов.

      1. Выполните команду для просмотра планируемых изменений:

         terraform plan
         

         Если конфигурации ресурсов описаны верно, в терминале отобразится список изменяемых ресурсов и их параметров. Это проверочный этап: ресурсы не будут изменены.

      2. Если вас устраивают планируемые изменения, внесите их:

         1. Выполните команду:

            terraform apply
            

         2. Подтвердите изменение ресурсов.

         3. Дождитесь завершения операции.

      Все ресурсы, которые были описаны в конфигурационном файле k8s-argocd.tf, будут удалены.

3. Удалите созданную виртуальную машину GitLab или инстанс Managed Service for GitLab.