튜토리얼: GitOps를 위한 Flux 설정

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

이 튜토리얼은 GitOps를 위한 Flux 설정 방법을 가르쳐줍니다. 부트스트랩 설치를 완료하고 클러스터에 agentk를 설치하고 간단한 nginx 애플리케이션을 배포합니다.

예제 Flux 구성의 개요에 대해서는 GitLab과 함께하는 Flux 부트스트랩 및 매니페스트 동기화를 참조하세요.

GitOps를 위한 Flux 설정:

  1. 개인 액세스 토큰을 생성합니다.
  2. 부트스트랩 설치를 완료합니다.
  3. agentk를 등록합니다.
  4. agentk를 설치합니다.
  5. 예제 프로젝트를 배포합니다.

필수 조건:

  • kubectl을 사용하여 로컬에서 액세스할 수 있는 Kubernetes 클러스터가 있어야 합니다.
  • Flux CLI를 설치해야 합니다. Flux v2 이상이어야 합니다.

개인 액세스 토큰 생성

Flux CLI로 인증하려면 api 범위를 갖는 개인 액세스 토큰을 생성하세요.

  1. 왼쪽 사이드바에서 아바타를 선택합니다.
  2. 프로필 편집을 선택합니다.
  3. 왼쪽 사이드바에서 액세스 토큰을 선택합니다.
  4. 토큰의 이름과 선택 사항 만료 날짜를 입력하세요.
  5. api 범위를 선택합니다.
  6. 개인 액세스 토큰 생성을 선택합니다.

프로젝트나 그룹 액세스 토큰을 api 범위로 사용할 수도 있습니다.

부트스트랩 설치 완료

이 섹션에서는 flux bootstrap 명령을 사용하여 빈 GitLab 저장소에 Flux를 부트스트랩합니다.

Flux 설치를 부트스트랩하려면:

  • flux bootstrap gitlab 명령을 실행합니다. 예: 

    flux bootstrap gitlab \
--owner=example-org \
--repository=my-repository \
--branch=master \
--path=clusters/testing \
--deploy-token-auth

부트스트랩 스크립트는 다음을 수행합니다:

  1. 배포 토큰을 생성하고 Kubernetes secret로 저장합니다.
  2. 지정된 --repository가 존재하지 않으면 빈 GitLab 프로젝트를 생성합니다.
  3. 프로젝트를 위한 Flux 정의 파일을 생성합니다.
  4. 정의 파일을 지정된 브랜치에 커밋합니다.
  5. 정의 파일을 클러스터에 적용합니다.

스크립트를 실행한 후에는 Flux가 스스로를 관리하고 GitLab 프로젝트 및 경로에 추가하는 다른 리소스를 준비할 것으로 가정합니다.

이어지는 튜토리얼은 경로가 clusters/testing임을 가정합니다.

Flux 업그레이드

설치 후 언제든지 Flux를 업그레이드해야 할 수 있습니다. 업그레이드하려면:

  • flux bootstrap gitlab 명령을 다시 실행합니다.

agentk 등록

클러스터에 agentk를 설치하기 전에 agentk를 등록해야 합니다.

agentk를 등록하려면:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하여 프로젝트를 찾습니다. 에이전트 구성 파일이 있다면 이 프로젝트에 있어야 합니다. 클러스터 매니페스트 파일도 이 프로젝트에 있어야 합니다.
  2. 운영 > 쿠버네티스 클러스터를 선택합니다.
  3. 클러스터 연결 (에이전트)를 선택합니다.
    • CI/CD 기본값을 사용하여 구성을 만들려면 이름을 입력하세요.
    • 이미 에이전트 구성 파일이 있는 경우 목록에서 선택합니다.
  4. 에이전트 등록을 선택합니다.
  5. 나중에 사용할 수 있도록 에이전트 액세스 토큰과 kasAddress를 안전하게 저장합니다.

에이전트는 프로젝트에 등록되어 있습니다. 아직 명령을 실행할 필요는 없습니다.

다음 단계에서는 Flux를 사용하여 클러스터에 agentk를 설치합니다.

agentk 설치

다음으로, Flux를 사용하여 agentk를 위한 네임스페이스를 만들고 클러스터에 설치합니다.

이 튜토리얼에서는 agentk를 위해 gitlab 네임스페이스를 사용합니다.

agentk를 설치하려면:

  1. clusters/testing/namespace-gitlab.yaml에 다음 파일을 커밋하고 푸시하세요. 

    apiVersion: v1
kind: Namespace
metadata:
  name: gitlab

  2. 액세스 토큰을 시크릿으로 포함하는 secret.yaml 파일을 생성합니다. 

    apiVersion: v1
kind: Secret
metadata:
  name: gitlab-agent-token
  namespace: gitlab
type: Opaque
stringData:
   token: "<여기에 토큰 입력>"

  3. secret.yaml을 클러스터에 적용합니다. 

    kubectl apply -f secret.yaml -n gitlab

    이 단계는 GitOps 원칙을 준수하지는 않지만, 신규 Flux 사용자를 위한 구성을 단순화합니다. 적절한 GitOps 설정을 위해 시크릿 관리 솔루션을 사용해야 합니다. Flux 문서를 참조하세요.

  4. 이전 단계에서 생성한 비밀을 사용하여 .spec.values.config.kasAddress와 .spec.values.config.secretName의 값을 대체하고, 다음 파일을 clusters/testing/agentk.yaml에 커밋하고 푸시하세요. 

    ---
apiVersion: source.toolkit.fluxcd.io/v1beta2
kind: HelmRepository
metadata:
  labels:
    app.kubernetes.io/component: agentk
    app.kubernetes.io/created-by: gitlab
    app.kubernetes.io/name: agentk
    app.kubernetes.io/part-of: gitlab
  name: gitlab-agent
  namespace: gitlab
spec:
  interval: 1h0m0s
  url: https://charts.gitlab.io
---
apiVersion: helm.toolkit.fluxcd.io/v2beta1
kind: HelmRelease
metadata:
  name: gitlab-agent
  namespace: gitlab
spec:
  chart:
    spec:
      chart: gitlab-agent
      sourceRef:
        kind: HelmRepository
        name: gitlab-agent
        namespace: gitlab
  interval: 1h0m0s
  values:
    config:
      kasAddress: "wss://kas.gitlab.com"
      secretName: gitlab-agent-token

  5. 클러스터에서 agentk가 설치되어 실행 중인지 확인하려면 다음 명령을 실행하세요. 

    kubectl -n gitlab get pods

좋은 작업입니다! Flux와 agentk를 성공적으로 설정했습니다. 이 섹션의 단계를 반복하여 프로젝트에서 더 많은 애플리케이션을 배포할 수 있습니다. 다음 섹션에서는 프로젝트 간에 Flux를 확장하는 방법에 대해 설명하겠습니다.

예제 프로젝트 배포

여러 GitLab 프로젝트에 걸쳐 Flux 배포를 확장하려면 다른 프로젝트를 가리키는 Flux GitRepository 및 Kustomization을 추가하여야 합니다. 이 기능을 사용하여 특정 GitLab 그룹과 관련된 Manifest를 해당 그룹에 저장할 수 있습니다.

예제를 통해 nginx 애플리케이션을 배포하고 Flux를 가리키세요:

  1. 다음 파일을 clusters/testing/example-nginx-app.yaml에 커밋하고 푸시하세요: 

    ---
apiVersion: source.toolkit.fluxcd.io/v1
kind: GitRepository
metadata:
  name: example-nginx-app
  namespace: flux-system
spec:
  interval: 1m0s
  ref:
    branch: main
  url: https://gitlab.com/gitlab-examples/ops/gitops-demo/example-mini-flux-deployment.git
---
apiVersion: kustomize.toolkit.fluxcd.io/v1
kind: Kustomization
metadata:
  name: example-nginx-app
  namespace: flux-system
spec:
  interval: 10m0s
  path: ./manifests
  prune: true
  sourceRef:
    kind: GitRepository
    name: example-nginx-app

  2. 애플리케이션이 올바르게 배포되고 agentk가 실행 중인지 확인하려면 다음 명령을 실행하세요: 

    kubectl -n example-nginx get pods

이 자습서는 공개 프로젝트에서 애플리케이션을 배포합니다. 비공개 프로젝트를 추가하려면 프로젝트 배포 토큰을 생성하여 Flux 시크릿으로 저장해야 합니다. 네임스페이스와 시크릿 이름을 저장해야 합니다.

축하합니다! 여러 그룹 및 프로젝트로 Flux를 성공적으로 확장했습니다.