튜토리얼: 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 스코프와 developer 역할로 생성할 수도 있습니다.

부트스트랩 설치 완료

이 섹션에서는 flux bootstrap 명령을 사용하여 빈 GitLab 리포지터리에 Flux를 부트스트랩합니다.

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

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

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

bootstrap의 각 인수는 다음과 같습니다:

인수 설명
hostname GitLab 인스턴스의 호스트 이름입니다.
owner Flux 리포지터리를 포함하는 GitLab 그룹입니다.
repository Flux 리포지터리를 포함하는 GitLab 프로젝트입니다.
branch 변경 사항이 커밋되는 Git 브랜치입니다.
path Flux 구성이 저장된 폴더의 파일 경로입니다.

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

  1. 배포 토큰을 생성하고 이를 Kubernetes secret으로 저장합니다.
  2. 지정한 --repository 인수의 프로젝트가 없는 경우 빈 GitLab 프로젝트를 생성합니다.
  3. 프로젝트의 Flux 정의 파일을 --path 인수로 지정한 폴더에 생성합니다.
  4. --branch 인수로 지정한 브랜치에 정의 파일을 커밋합니다.
  5. 정의 파일을 클러스터에 적용합니다.

스크립트를 실행한 후에는 Flux가 스스로를 관리하고 GitLab 프로젝트와 경로에 추가하는 모든 리소스를 관리할 수 있는 상태가 됩니다.

이 튜토리얼의 나머지 부분은 경로가 clusters/testing임을 전제로 합니다.

Flux 업그레이드

설치 후 언제든지 Flux를 업그레이드해야 할 수 있습니다. 다음을 수행합니다:

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

agentk 등록

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

agentk를 등록하려면:

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

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

다음 단계에서는 클러스터에 agentk를 설치하는 데에 Flux를 사용할 것입니다.

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를 저장된 kas 주소와 시크릿 이름으로 대체하여 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를 프로젝트 간에 확장하는 방법에 대해 논의할 것입니다.

예제 프로젝트 배포

Flux GitRepository 및 Kustomization을 추가하여 여러 GitLab 프로젝트에 대한 Flux 배포를 확장할 수 있습니다. 이 기능을 사용하여 특정 GitLab 그룹과 관련된 매니페스트를 해당 그룹에 저장할 수 있습니다.

예제로, 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를 여러 그룹과 프로젝트에 확장하여 성공적으로 배포했습니다.