튜토리얼: 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 역할이 필요합니다.

부트스트랩 설치 완료

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

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. 운영 > 쿠버네티스 클러스터를 선택합니다.
  3. 클러스터 연결(agent) 만들기를 선택합니다.
    • CI/CD 기본값으로 구성하려면 이름을 입력합니다.
    • 이미 에이전트 구성 파일이 있는 경우 목록에서 선택합니다.
  4. 에이전트 등록을 선택합니다.
  5. 에이전트 접근 토큰과 kasAddress를 안전하게 보관합니다. 이후에 사용해야 합니다.

프로젝트에 에이전트가 등록됩니다. 지금은 명령을 실행할 필요가 없습니다.

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

agentk 설치

다음으로, Flux를 사용하여 agentk의 네임스페이스를 생성하고 클러스터에 설치합니다. 저장소에서 정의한 구성 변경을 Flux가 가져와 클러스터에 적용하는 데 시간이 좀 걸릴 수 있습니다.

이 튜토리얼에서 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: "<your-token-here>"

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

    kubectl apply -f secret.yaml -n gitlab

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

  4. 다음 파일을 clusters/testing/agentk.yaml에 커밋하고 푸시합니다. .spec.values.config.kasAddress와 .spec.values.config.secretName의 값을 저장한 kas 주소와 시크릿 이름으로 대체합니다: 

    ---
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

    Helm 릴리스는 앞서 단계에서 생성한 시크릿을 사용합니다.

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