배포 전후 후크 실행

이 빠른 시작에서는 Cloud Deploy를 사용하여 배포하기 전후에 실행할 임의의 프로그램인 배포 후크를 실행하는 방법을 보여줍니다.

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

하나의 GKE 클러스터 또는 하나의 Cloud Run 서비스를 만듭니다.

GKE Enterprise 클러스터도 사용할 수 있지만 이 빠른 시작에서는 GKE 및 Cloud Run만 사용합니다.
Skaffold 구성과 Kubernetes 매니페스트 또는 Cloud Run 서비스 정의를 만듭니다.

Skaffold 구성 파일은 배포 후 실행되도록 배포 후크를 구성하는 곳입니다. 배포 전에 실행할 컨테이너와 배포 후에 실행할 컨테이너를 식별합니다.
Cloud Deploy 배포 파이프라인 및 배포 대상을 정의합니다.

배포 파이프라인 구성에서는 skaffold.yaml에 정의된 배포 후크를 참조하여 이러한 후크를 실행합니다.

이 파이프라인에는 한 단계만 포함되며 대상 하나만 사용됩니다.
대상에 자동으로 배포되는 출시 버전을 만듭니다.

후크 중 하나는 애플리케이션이 배포되기 전에 실행되고 다른 후크는 나중에 실행됩니다.
Google Cloud 콘솔의 Cloud Deploy 출시 세부정보 페이지를 사용하여 Cloud Build 로그에서 배포 전 및 배포 후 후크의 결과를 확인하세요.

시작하기 전에

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.

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

Go to project selector

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

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

Enable the APIs

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

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

Go to project selector

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

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

Enable the APIs

Install the Google Cloud CLI.

To initialize the gcloud CLI, run the following command:

gcloud init

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

gcloud components update

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

먼저 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"

특정 런타임의 개발자 역할을 추가합니다.

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"

런타임에 배포할 수 있는 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의 경우 기본 설정으로 deploy-hooks-cluster 클러스터 하나를 만듭니다. 클러스터의 Kubernetes API 엔드포인트는 공개 인터넷에서 네트워크에 연결할 수 있어야 합니다. GKE 클러스터는 기본적으로 외부에서 액세스할 수 있습니다.

gcloud container clusters create-auto deploy-hooks-cluster \
                 --project=PROJECT_ID \
                 --region=us-central1

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

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

이 빠른 시작에서는 샘플 앱을 배포하는 데 사용할 매니페스트를 식별하고 배포 전후에 실행할 컨테이너(배포 후크)를 식별하는 skaffold.yaml 파일을 만듭니다.

터미널 창을 엽니다.

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

GKE

mkdir deploy-hooks-gke-quickstart
cd deploy-hooks-gke-quickstart

Cloud Run

mkdir deploy-hooks-run-quickstart
cd deploy-hooks-run-quickstart

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

GKE

apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - k8s-pod.yaml
deploy:
  kubectl: {}
customActions:
- name: predeploy-action
  containers:
  - name: predeploy-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "this is a predeploy action"' ]
- name: postdeploy-action
  containers:
  - name: postdeploy-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "this is a postdeploy action"' ]

Cloud Run

apiVersion: skaffold/v4beta7
kind: Config
manifests:
  rawYaml:
  - service.yaml
deploy:
  cloudrun: {}
customActions:
- name: predeploy-action
  containers:
  - name: predeploy-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "this is a predeploy action"' ]
- name: postdeploy-action
  containers:
  - name: postdeploy-echo
    image: ubuntu
    command: ["/bin/sh"]
    args: ["-c", 'echo "this is a postdeploy action"' ]

이 파일에는 customActions: 스탠스가 포함되어 있습니다. 이렇게 하면 배포 전후에 실행할 컨테이너(후크)를 정의합니다.

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

Cloud Run용 서비스 정의 또는 GKE용 Kubernetes 매니페스트와 같은 애플리케이션의 정의를 만듭니다.
GKE
다음 콘텐츠로 k8s-pod.yaml라는 파일을 만듭니다.
```
apiVersion: v1
kind: Pod
metadata:
  name: my-hooks-pod
spec:
  containers:
  - name: nginx
    image: my-app-image
```
이 파일은 애플리케이션을 배포하기 위해 클러스터에 적용되는 간단한 Kubernetes manifest입니다.
Cloud Run
다음 콘텐츠로 service.yaml라는 파일을 만듭니다.
```
apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: my-hooks-run-service
spec:
  template:
    spec:
      containers:
      - image: my-app-image
```
이 파일은 배포 시 Cloud Run 서비스를 만드는 데 사용되는 단순 Cloud Run 서비스 정의입니다.

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

파이프라인과 대상을 파일 하나 또는 별도의 파일로 정의할 수 있습니다. 이 빠른 시작에서는 단일 파일을 만듭니다.

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

GKE

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

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: deploy-hooks-demo-app-gke-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: hooks-staging
    profiles: []
    strategy:
      standard:
        predeploy:
          actions: ["predeploy-action"]
        postdeploy:
          actions: ["postdeploy-action"]
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: hooks-staging
description: hooks staging cluster
gke:
  cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-hooks-cluster

Cloud Run

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

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: deploy-hooks-demo-app-run-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: hooks-staging
    profiles: []
    strategy:
      standard:
        predeploy:
          actions: ["predeploy-action"]
        postdeploy:
          actions: ["postdeploy-action"]
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: hooks-staging
description: staging Run service
run:
  location: projects/PROJECT_ID/locations/us-central1

Cloud Deploy 서비스에 파이프라인 및 대상을 등록합니다.
```
gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
```
이제 하나의 타겟으로 애플리케이션을 배포하고 사전 배포 및 배포 후 작업을 실행할 배포 파이프라인이 준비되었습니다.
파이프라인 및 대상을 확인합니다.

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

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

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

출시 버전 만들기

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

GKE

deploy-hooks-gke-quickstart 디렉터리에서 다음 명령어를 실행하여 배포할 컨테이너 이미지를 나타내는 release 리소스를 만듭니다.

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

Cloud Run

deploy-hooks-run-quickstart 디렉터리에서 다음 명령어를 실행하여 배포할 컨테이너 이미지를 나타내는 release 리소스를 만듭니다.

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

모든 출시 버전과 마찬가지로(--disable-initial-rollout을 포함하지 않는 경우) Cloud Deploy도 자동으로 출시 리소스를 만듭니다. 애플리케이션은 이 배포 파이프라인에 구성된 대상 하나에 자동으로 배포됩니다.

또한 배포 전 작업은 애플리케이션이 배포되기 전에 실행되고 배포 후 작업은 배포 후에 실행됩니다.

Google Cloud 콘솔에서 결과 보기

몇 분 후에 출시 버전이 대상 런타임에 배포됩니다.

구성한 사전 및 사후 배포 후크는 Cloud Build 로그에 문자열을 인쇄합니다(예: 목적). 이러한 로그를 보고 후크가 예상대로 작동하는지 확인할 수 있습니다.

Google Cloud 콘솔에서 Cloud Deploy 배포 파이프라인 페이지로 이동하여 배포 파이프라인('deploy-hooks-demo-app-gke-1' 또는 'deploy-hooks-demo-app-run-1')을 확인합니다.

배포 파이프라인 페이지 열기
배포 파이프라인 이름('deploy-hooks-demo-app-gke-1' 또는 'deploy-hooks-demo-app-run-1')을 클릭합니다.

파이프라인 시각화에 앱의 배포 상태가 표시됩니다. 파이프라인에는 단계가 하나뿐이므로 시각화에 노드가 하나만 표시됩니다.

출시 버전은 배포 파이프라인 세부정보의 출시 탭에 표시됩니다.
배포 파이프라인 세부정보에서 출시 탭을 클릭합니다.
출시 이름을 클릭하여 출시 세부정보를 봅니다.

Predeploy 및 Postdeploy가 작업으로 표시됩니다.
사전 배포를 클릭합니다.

작업 실행 로그가 표시됩니다.
로그 항목 목록을 아래로 스크롤하여 predeploy-echo를 찾고 클릭합니다.

textPayload를 확인합니다. 이 문자열은 Skaffold 구성의 predeploy-action에 구성된 문자열입니다.
Postdeploy 작업을 클릭하고 postdeploy-echo 로그 항목을 찾습니다.

삭제

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

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

GKE

gcloud container clusters delete deploy-hooks-cluster --region=us-central1 --project=PROJECT_ID

Cloud Run

gcloud run services delete my-hooks-run-service --region=us-central1 --project=PROJECT_ID

배포 파이프라인, 대상, 출시 버전 및 출시를 삭제합니다.

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

Cloud Deploy에서 만든 Cloud Storage 버킷을 삭제합니다.

하나는 _clouddeploy로 끝나고 다른 하나는 [region].deploy-artifacts.[project].appspot.com입니다.

Cloud Storage 브라우저 페이지 열기

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