배포 정책을 사용하여 출시 제한

이 빠른 시작에서는 지정된 시간 동안 대상에 Cloud Deploy 출시를 방지하는 방법과 이러한 제한을 재정의하는 방법을 보여줍니다.

이 빠른 시작에서 다루는 작업은 다음과 같습니다.

  1. Skaffold 구성 및 Kubernetes 매니페스트 또는 Cloud Run 서비스 정의를 만들어 배포할(사전 빌드된) 컨테이너 이미지를 지정합니다.

  2. 하나의 GKE 클러스터 또는 Cloud Run 서비스를 가리키는 단일 배포 대상 및 Cloud Deploy 배포 파이프라인을 정의합니다.

    이 파이프라인에는 하나의 대상에 대해 한 단계만 포함됩니다.

  3. 대상의 배포 정책을 구성합니다.

    정책은 해당 대상에 대한 출시를 금지할 날짜 범위를 정의합니다.

  4. 출시 버전을 만듭니다.

    일반적으로 출시 버전을 만들 때 Cloud Deploy는 배포 파이프라인의 진행에서 첫 번째 대상에 대한 출시를 만듭니다. 이 경우 대상에 대한 배포를 방지하는 정책이 있으므로 해당 대상에 대한 출시가 생성되지 않습니다.

  5. Google Cloud 콘솔에서 결과를 봅니다.

    정책으로 인해 출시 버전에 대한 출시가 표시되지 않으며 배포 파이프라인 시각화에 대기 중인 작업이 없습니다.

  6. 배포 정책을 재정의합니다.

    이 재정의로 인해 이제 Cloud Deploy에서 대상에 대한 출시가 생성됩니다.

  7. Google Cloud 콘솔에서 결과를 봅니다.

    이제 정책이 재정의되었으므로 출시가 진행 중(또는 충분한 시간이 경과한 경우 완료됨)임을 확인할 수 있습니다.

시작하기 전에

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Cloud Deploy, Cloud Build, GKE, and Cloud Storage APIs.

    Enable the APIs

  5. Install the Google Cloud CLI.
  6. To initialize the gcloud CLI, run the following command:

    gcloud init
  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  8. Make sure that billing is enabled for your Google Cloud project.

  9. Enable the Cloud Deploy, Cloud Build, GKE, and Cloud Storage APIs.

    Enable the APIs

  10. Install the Google Cloud CLI.
  11. To initialize the gcloud CLI, run the following command:

    gcloud init
  12. Google Cloud CLI가 이미 설치되어 있으면 최신 버전으로 실행 중인지 확인합니다.

    gcloud components update
    
  13. 기본 Compute Engine 서비스 계정에 충분한 권한이 있는지 확인합니다.

    서비스 계정에 이미 필요한 권한이 있을 수 있습니다. 기본 서비스 계정의 자동 역할 부여를 중지한 프로젝트를 위해 포함된 단계입니다.

    1. 먼저 clouddeploy.jobRunner 역할을 추가합니다.
      gcloud projects add-iam-policy-binding PROJECT_ID \
          --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
          --role="roles/clouddeploy.jobRunner"
      
    2. clouddeploy.policyAdmin 역할 추가:
      gcloud projects add-iam-policy-binding PROJECT_ID \
          --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
          --role="roles/clouddeploy.policyAdmin"
      
    3. 특정 런타임의 개발자 역할을 추가합니다.
      • GKE의 경우:

        gcloud projects add-iam-policy-binding PROJECT_ID \
            --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
            --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
            --role="roles/container.developer"
        

      • Cloud Run의 경우:

        gcloud projects add-iam-policy-binding PROJECT_ID \
            --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
            --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
            --role="roles/run.developer"
        

    4. 런타임에 배포할 수 있는 actAs 권한이 포함된 iam.serviceAccountUser 역할을 추가합니다.
      gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
          --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
          --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
          --role="roles/iam.serviceAccountUser" \
          --project=PROJECT_ID
      

런타임 환경 만들기

Cloud Run에 배포하는 경우 이 명령어를 건너뛸 수 있습니다.

GKE의 경우 quickstart-cluster-qsprod 클러스터 1개를 만듭니다. 클러스터의 Kubernetes API 엔드포인트는 공개 인터넷에서 네트워크에 연결할 수 있어야 합니다. GKE 클러스터는 기본적으로 외부에서 액세스할 수 있습니다.

gcloud container clusters create-auto quickstart-cluster-qsprod \
                 --project=PROJECT_ID \
                 --region=us-central1

Skaffold 구성 및 애플리케이션 매니페스트 준비

Cloud Deploy는 Skaffold를 사용하여 배포할 항목의 세부정보와 대상에 배포하는 방법을 제공합니다.

이 빠른 시작에서는 샘플 앱을 배포하는 데 사용할 Kubernetes 매니페스트를 식별하는 skaffold.yaml 파일을 만듭니다.

  1. 터미널 창을 엽니다.

  2. 새 디렉터리를 만들어 해당 디렉터리로 이동합니다.

    GKE

    mkdir deploy-policy-quickstart
    cd deploy-policy-quickstart
    

    Cloud Run

    mkdir deploy-policy-quickstart
    cd deploy-policy-quickstart
    
  3. 다음 콘텐츠로 skaffold.yaml라는 파일을 만듭니다.

    GKE

    apiVersion: skaffold/v4beta1
    kind: Config
    manifests:
      rawYaml:
      - k8s-pod.yaml
    deploy:
      kubectl: {}
    

    Cloud Run

    apiVersion: skaffold/v4beta1
    kind: Config
    manifests:
      rawYaml:
      - service.yaml
    deploy:
      cloudrun: {}
    

    이 파일은 최소한의 Skaffold 구성입니다. 이 빠른 시작에서는 해당 파일을 만듭니다. 하지만 기본적인 비프로덕션 애플리케이션의 경우 Cloud Deploy에서 자동으로 생성되도록 할 수도 있습니다.

    이 구성 파일에 대한 자세한 내용은 skaffold.yaml 참조를 확인하세요.

  4. Cloud Run용 서비스 정의 또는 GKE용 Kubernetes 매니페스트와 같은 애플리케이션의 매니페스트를 만듭니다.

    GKE

    다음 콘텐츠로 k8s-pod.yaml이라는 파일을 만듭니다.

    apiVersion: v1
    kind: Pod
    metadata:
      name: getting-started
    spec:
      containers:
      - name: nginx
        image: my-app-image
    

    이 파일은 애플리케이션을 배포하기 위해 클러스터에 적용되는 기본 Kubernetes manifest입니다.

    Cloud Run

    다음 콘텐츠로 service.yaml이라는 파일을 만듭니다.

    apiVersion: serving.knative.dev/v1
    kind: Service
    metadata:
      name: my-deploy-policy-run-service
    spec:
      template:
        spec:
          containers:
          - image: my-app-image
    

    이 파일은 배포 시 Cloud Run 서비스를 만드는 데 사용되는 기본 Cloud Run 서비스 정의입니다.

전달 파이프라인 및 대상 만들기

배포 파이프라인 및 대상을 파일 하나 또는 별도의 파일로 정의할 수 있습니다. 이 빠른 시작에서는 두 파일을 모두 사용하여 단일 파일을 만듭니다.

  1. 배포 파이프라인과 대상 정의를 만듭니다.

    GKE

    deploy-policy-quickstart 디렉터리에서 다음 콘텐츠로 새 파일 clouddeploy.yaml을 만듭니다.

    apiVersion: deploy.cloud.google.com/v1
    kind: DeliveryPipeline
    metadata:
      name: deploy-policy-pipeline
    serialPipeline:
      stages:
      - targetId: prod-target
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: prod-target
    description: production cluster
    gke:
      cluster: projects/PROJECT_ID/locations/us-central1/clusters/quickstart-cluster-qsprod
    

    Cloud Run

    deploy-policy-quickstart 디렉터리에서 다음 콘텐츠로 새 파일 clouddeploy.yaml을 만듭니다.

    apiVersion: deploy.cloud.google.com/v1
    kind: DeliveryPipeline
    metadata:
      name: deploy-policy-pipeline
    serialPipeline:
      stages:
      - targetId: prod-target
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: prod-target
    description: production Run service
    run:
      location: projects/PROJECT_ID/locations/us-central1
    
  2. Cloud Deploy 서비스에 파이프라인 및 대상 리소스를 등록합니다.

    gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
    

    이제 하나의 대상이 포함된 배포 파이프라인이 있습니다.

  3. 파이프라인 및 대상을 확인합니다.

    Google Cloud 콘솔에서 Cloud Deploy 배포 파이프라인 페이지로 이동하여 사용 가능한 배포 파이프라인 목록을 확인합니다.

    배포 파이프라인 페이지 열기

    방금 만든 배포 파이프라인이 표시되고 대상 하나가 대상 열에 나열됩니다.

    파이프라인을 보여주는 Google Cloud 콘솔의 배포 파이프라인 페이지

배포 정책 만들기

배포 정책은 배포 파이프라인 및 대상과 동일한 파일에 정의하거나 별도의 파일에 정의할 수 있습니다. 이 빠른 시작에서는 이를 별도로 정의합니다.

  1. 배포 파이프라인 및 대상을 만든 동일한 디렉터리에서 다음 콘텐츠가 포함된 새 파일 deploypolicy.yaml을 만듭니다.

    apiVersion: deploy.cloud.google.com/v1
    description: Restrict all rollouts in the deploy-policy-pipeline resource for the next ten years
    kind: DeployPolicy
    metadata:
      name: quickstart-deploy-policy
    selectors:
    - deliveryPipeline:
        id: 'deploy-policy-pipeline'
    rules:
    - rolloutRestriction:
        id: no-rollouts
        timeWindows:
          timeZone: America/New_York
          oneTimeWindows:
          - start: 2024-01-01 00:00
            end: 2034-01-01 24:00
    

    이 정책은 2024년 1월 1일부터 10년 동안 출시를 차단합니다. 이 정책은 실제 정책이 아닙니다. 출시 버전을 만들 때 정책 적용을 보장하기 위해 이 빠른 시작을 위해서만 생성된 정책입니다.

  2. Cloud Deploy 서비스에 배포 정책 리소스를 등록하세요.

    gcloud deploy apply --file=deploypolicy.yaml --region=us-central1 --project=PROJECT_ID
    
  3. 배포 정책을 확인합니다.

    Google Cloud 콘솔에서 Cloud Deploy 배포 정책 페이지로 이동하여 사용 가능한 정책 목록을 확인합니다.

    배포 정책 페이지 열기

    방금 만든 배포 정책이 표시됩니다.

    Google Cloud 콘솔의 배포 정책 페이지

출시 버전 만들기

출시 버전은 배포되는 변경사항을 나타내는 중앙 Cloud Deploy 리소스입니다. 배포 파이프라인은 해당 출시의 수명 주기를 정의합니다. 수명 주기에 대한 자세한 내용은 Cloud Deploy 서비스 아키텍처를 참조하세요.

GKE

릴리스를 만들기 위해 deploy-policy-quickstart 디렉터리에서 다음 명령어를 실행합니다.

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-policy-pipeline \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

Cloud Run

릴리스를 만들기 위해 deploy-policy-quickstart 디렉터리에서 다음 명령어를 실행합니다.

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-policy-pipeline \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4

일반적인 상황에서 Cloud Deploy는 이 명령어를 사용하여 출시 버전을 만들 때 첫 번째 대상에 대한 출시를 만듭니다. 이 경우 배포 정책에 따라 출시가 제한되므로 출시가 생성되지 않습니다. 명령줄에 오류 메시지가 표시됩니다.

ERROR: (gcloud.deploy.releases.create) A create-rollout attempt was blocked by the "quickstart-deploy-policy" policy. Target: "prod-target", Delivery pipeline: "deploy-policy-pipeline", policy rule: "no-rollouts"

정책 제한사항 재정의

배포 정책으로 차단되는 샘플 애플리케이션을 배포하려면 해당 정책을 재정의해야 합니다. 이를 위해 이번에는 --override-deploy-policies 옵션을 포함하여 이 출시 버전에 대해 새로운 출시를 생성합니다.

GKE

릴리스를 만들기 위해 deploy-policy-quickstart 디렉터리에서 다음 명령어를 실행합니다.

 gcloud deploy releases promote --release=test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-policy-pipeline \
   --to-target=prod-target \
   --override-deploy-policies=quickstart-deploy-policy

Cloud Run

릴리스를 만들기 위해 deploy-policy-quickstart 디렉터리에서 다음 명령어를 실행합니다.

 gcloud deploy releases promote --release=test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=deploy-policy-pipeline \
   --to-target=prod-target \
   --override-deploy-policies=quickstart-deploy-policy

--override-deploy-policies=quickstart-deploy-policy를 포함했고 roles/clouddeploy.policyAdmin 역할이 있으므로 Cloud Deploy는 사용자가 만든 배포 정책을 무시하고 prod-target에 대한 출시를 만듭니다.

Google Cloud 콘솔에서 결과 보기

  1. Google Cloud 콘솔에서 Cloud Deploy 배포 파이프라인 페이지로 다시 이동하여 배포 파이프라인(deploy-policy-pipeline)을 확인합니다.

    배포 파이프라인 페이지 열기

  2. 배포 파이프라인 이름(deploy-policy-pipeline)을 클릭합니다.

    파이프라인 시각화에 앱의 배포 상태가 표시됩니다. 이 경우에는 정책이 재정의되어 출시가 생성되고 성공했습니다.

    출시를 보여주는 배포 파이프라인 시각화

    출시 버전은 배포 파이프라인 세부정보출시 탭에 표시됩니다.

삭제

이 페이지에서 사용한 리소스 비용이 Google Cloud 계정에 청구되지 않도록 하려면 다음 단계를 수행합니다.

  1. GKE 클러스터나 Cloud Run 서비스를 삭제합니다.

    GKE

    gcloud container clusters delete quickstart-cluster-qsprod --region=us-central1 --project=PROJECT_ID
    

    Cloud Run

    gcloud run services delete my-deploy-policy-run-service --region=us-central1 --project=PROJECT_ID
    
  2. 배포 정책을 삭제합니다.

    gcloud deploy delete --file=deploypolicy.yaml --region=us-central1 --project=PROJECT_ID
    
  3. 배포 파이프라인, 대상, 출시 버전 및 출시를 삭제합니다.

    gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
    
  4. Cloud Deploy에서 만든 Cloud Storage 버킷을 모두 삭제합니다.

    Cloud Storage 브라우저 페이지 열기

빠른 시작을 완료하셨습니다.

다음 단계