튜토리얼: Flux를 사용하여 Git 리포지토리를 배포하기


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

이 튜토리얼에서는 Flux를 사용하여 Kubernetes 클러스터에 애플리케이션을 빌드하고 배포하는 GitLab 프로젝트를 생성합니다. 샘플 매니페스트 프로젝트를 설정하고 매니페스트를 배포 브랜치에 푸시하고 Flux를 구성하여 배포 브랜치를 동기화합니다. 이 설정에서는 리포지토리에서 변경 사항을 가져오기 전에 GitLab 파이프라인에서 추가적인 단계를 실행할 수 있습니다.

이 튜토리얼은 공개 프로젝트에서 애플리케이션을 배포합니다. 비공개 프로젝트를 추가하려면 프로젝트 배포 토큰을 생성해야 합니다.

GitOps 배포를 위한 리포지토리 설정:

  1. Kubernetes 매니페스트 리포지토리 생성
  2. 배포 브랜치 생성
  3. GitLab CI/CD를 구성하여 브랜치에 푸시
  4. Flux를 구성하여 매니페스트 동기화
  5. 구성 확인

전제 조건:

  • Kubernetes 클러스터에 연결된 Flux 리포지토리가 있어야 합니다. 처음부터 시작하는 경우 GitOps를 위한 Flux 설정을 참조하십시오.

Kubernetes 매니페스트 리포지토리 생성

먼저 Kubernetes 매니페스트를 위한 리포지토리를 생성합니다.

  1. GitLab에서 web-app-manifests라는 새 리포지토리를 생성합니다.
  2. web-app-manifests에 다음 내용으로 src/nginx-deployment.yaml 파일을 추가합니다.

    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: nginx
    spec:
      replicas: 1
      template:
        spec:
          containers:
          - name: nginx
            image: nginx:1.14.2
            ports:
            - containerPort: 80
    
  3. web-app-manifests에 다음 내용으로 src/kustomization.yaml 파일을 추가합니다.

    apiVersion: kustomize.config.k8s.io/v1beta1
    kind: Kustomization
    resources:
      - nginx-deployment.yaml
    commonLabels:
      app: flux-branches-tutorial
    

배포 브랜치 생성

다음으로 클러스터의 현재 상태를 반영할 브랜치를 생성합니다.

이 워크플로우에서 기본 브랜치는 애플리케이션의 단일 진실의 원천입니다. Kubernetes 클러스터에 반영되려면 코드나 구성 변경 사항은 기본 브랜치에 존재해야 합니다. 나중 단계에서 CI/CD를 구성하여 기본 브랜치에서 배포 브랜치로 변경 사항을 병합합니다.

배포 브랜치를 생성하려면:

  1. web-app-manifests에서 기본 브랜치로부터 _gitlab/deploy/example이라는 브랜치를 생성합니다. 이 예에서 브랜치 이름은 배포 브랜치를 기능 브랜치와 구분하기 위해 선택된 것이지만 필수는 아닙니다. 배포 브랜치의 이름을 원하는 대로 지정할 수 있습니다.
  2. write_repository 범위가 있는 프로젝트, 그룹 또는 개인 액세스 토큰을 생성합니다.
  3. DEPLOYMENT_TOKEN이란 이름의 토큰 값을 가진 CI/CD 변수를 생성합니다. job logs에 표시되지 않도록 값을 mask해야 합니다.
  4. 다음 값으로 보호 규칙을 추가합니다.:

    • 병합 허용: 아무도 아님.
    • 푸시 및 병합 허용: 이전 단계에서 생성한 토큰 또는 개인 액세스 토큰을 만든 경우 사용자 선택.
    • 강제 푸시 허용: 토글 끄기.
    • 코드 소유자의 승인 필요: 토글 끄기.

    이 구성은 해당 토큰만 브랜치에 푸시할 수 있도록 보장합니다.

리포지토리에 보호된 배포 브랜치가 성공적으로 생성되었습니다!

GitLab CI/CD를 구성하여 브랜치에 푸시

다음으로 CI/CD를 구성하여 기본 브랜치에서 배포 브랜치로 변경 사항을 병합합니다.

web-app-manifests의 루트에 다음 내용의 .gitlab-ci.yml 파일을 생성하고 푸시합니다.

   deploy:
     stage: deploy
     environment: production
     variables:
       DEPLOYMENT_BRANCH: _gitlab/deploy/example
     script:
       - |
         git config user.name "Deploy Example Bot"
         git config user.email "test@example.com"
         git fetch origin $DEPLOYMENT_BRANCH
         git checkout $DEPLOYMENT_BRANCH
         git merge $CI_COMMIT_SHA --ff-only
         git push https://deploy:$DEPLOYMENT_TOKEN@$CI_SERVER_HOST/$CI_PROJECT_PATH.git HEAD:$DEPLOYMENT_BRANCH
     resource_group: $CI_ENVIRONMENT_SLUG

이렇게 하면 단일 deploy 작업을 가진 CI/CD 파이프라인이 생성됩니다. 이 작업은:

  1. 배포 브랜치를 확인합니다.
  2. 기본 브랜치에서의 새 변경 사항을 배포 브랜치로 병합합니다.
  3. 변경 사항을 구성된 토큰을 사용하여 리포지토리에 푸시합니다.

Flux를 구성하여 매니페스트 동기화

다음으로 Flux 리포지토리를 구성하여 web-app-manifests 리포지토리의 배포 브랜치를 동기화합니다.

구성을 위해 GitRepository 리소스를 생성합니다.:

  1. Flux 리포지토리의 로컬 클론에서 다음 내용으로 clusters/my-cluster/web-app-manifests-source.yaml 파일을 추가합니다.

    apiVersion: source.toolkit.fluxcd.io/v1
    kind: GitRepository
    metadata:
      name: web-app-manifests
      namespace: flux-system
    spec:
      interval: 5m0s
      url: https://gitlab.com/gitlab-org/configure/examples/flux/web-app-manifests-branches
      ref:
        branch: _gitlab/deploy/example
    

    urlweb-app-manifests 프로젝트의 URL로 대체해야 합니다.

  2. Flux 리포지토리의 로컬 클론에서 다음 내용으로 clusters/my-cluster/web-app-manifests-kustomization.yaml 파일을 추가합니다.

    apiVersion: kustomize.toolkit.fluxcd.io/v1
    kind: Kustomization
    metadata:
      name: nginx-source-kustomization
      namespace: flux-system
    spec:
      interval: 1m0s
      path: ./src
      prune: true
      sourceRef:
        kind: GitRepository
        name: web-app-manifests
      targetNamespace: default
    

    이 파일은 Kustomization 리소스를 추가하여 Flux에게 레지스트리에서 가져온 매니페스트를 동기화하도록 알려줍니다.

  3. 새 파일을 커밋하고 푸시합니다.

구성 확인

파이프라인이 완료되면 클러스터에 새로 생성된 nginx 팟을 확인해야 합니다.

배포를 다시 동기화하려면 src/nginx-deployment.yaml 파일에서 레플리카 수를 업데이트하고 기본 브랜치에 푸시해 보세요. 모든 것이 잘 작동하면 변경 내용은 파이프라인이 완료될 때 클러스터에 동기화될 것입니다.

축하합니다! 애플리케이션을 배포하고 변경 사항을 동기화하기 위해 프로젝트를 성공적으로 구성했습니다!