Esegui gli hook prima e dopo il deployment
Questa guida rapida mostra come eseguire un hook di deployment, un programma arbitrario da eseguire prima o dopo il deployment con Cloud Deploy.
In questa guida rapida, imparerai a:
Creare un cluster GKE o un servizio Cloud Run.
Puoi utilizzare un cluster GKE Enterprise anche per questo, ma questa guida rapida utilizza solo GKE e Cloud Run.
Creare una configurazione Skaffold e un file manifest Kubernetes o una definizione del servizio Cloud Run.
Il file di configurazione Skaffold è il luogo in cui configuri gli hook di deployment da eseguire. Devi identificare un container da eseguire prima e un container da eseguire dopo il deployment.
Definire la pipeline di distribuzione di Cloud Deploy e la destinazione del deployment.
Nella configurazione della pipeline di distribuzione, farai riferimento agli hook di deployment definiti in
skaffold.yaml
per eseguire questi hook.Questa pipeline include una sola fase e utilizza un solo target.
Crea una release, che esegue automaticamente il deployment nella destinazione.
Uno degli hook viene eseguito prima del deployment dell'applicazione, mentre l'altro viene eseguito dopo.
Visualizza i risultati degli hook pre e post-deployment nei log di Cloud Build utilizzando la pagina Dettagli implementazione di Cloud Deploy nella console Google Cloud.
Prima di iniziare
- Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.
-
Abilita le API Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.
- 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.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.
-
Abilita le API Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
- Assicurati che l'account di servizio Compute Engine predefinito disponga delle autorizzazioni sufficienti.
L'account di servizio potrebbe avere già le autorizzazioni necessarie. Questi passaggi sono inclusi per i progetti che disabilitano le concessioni automatiche dei ruoli per gli account di servizio predefiniti.
- Innanzitutto, aggiungi il ruolo
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"
- Aggiungi il ruolo sviluppatore per il runtime specifico.
- Per 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"
- Per 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"
-
Aggiungi il ruolo
iam.serviceAccountUser
, che include l'autorizzazioneactAs
per il deployment nel runtime: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
Se hai già installato l'interfaccia a riga di comando, assicurati di eseguire la versione più recente:
gcloud components update
Crea l'ambiente di runtime
Se stai eseguendo il deployment in Cloud Run, puoi saltare questo comando.
Per GKE, crea un cluster: deploy-hooks-cluster
, con
impostazioni predefinite. L'endpoint API Kubernetes del cluster deve essere
raggiungibile alla rete da internet pubblico. I cluster GKE sono accessibili dall'esterno per impostazione predefinita.
gcloud container clusters create-auto deploy-hooks-cluster \ --project=PROJECT_ID \ --region=us-central1
Prepara il manifest dell'applicazione e della configurazione Skaffold
Cloud Deploy utilizza Skaffold per fornire i dettagli su cosa eseguire il deployment e come eseguirne il deployment per il tuo target.
In questa guida rapida, creerai un file skaffold.yaml
che identifica il file manifest da utilizzare per il deployment dell'app di esempio e i container da eseguire prima e dopo il deployment (gli hook di deployment).
Apri una finestra del terminale.
Crea una nuova directory e aprila.
GKE
mkdir deploy-hooks-gke-quickstart cd deploy-hooks-gke-quickstart
Cloud Run
mkdir deploy-hooks-run-quickstart cd deploy-hooks-run-quickstart
Crea un file denominato
skaffold.yaml
con il seguente contenuto: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"' ]
Questo file include la stanza
customActions:
. Questo definisce i container da eseguire prima e dopo il deployment: gli hook.Consulta il riferimento
skaffold.yaml
per ulteriori informazioni su questo file di configurazione.Crea la definizione dell'applicazione: una definizione di servizio per Cloud Run o un manifest Kubernetes per GKE.
GKE
Crea un file denominato
k8s-pod.yaml
, con il seguente contenuto:apiVersion: v1 kind: Pod metadata: name: my-hooks-pod spec: containers: - name: nginx image: my-app-image
Questo file è un semplice manifest Kubernetes, che viene applicato al cluster per eseguire il deployment dell'applicazione.
Cloud Run
Crea un file denominato
service.yaml
, con il seguente contenuto:apiVersion: serving.knative.dev/v1 kind: Service metadata: name: my-hooks-run-service spec: template: spec: containers: - image: my-app-image
Questo file è una semplice definizione del servizio Cloud Run, utilizzata al momento del deployment per creare il tuo servizio Cloud Run.
Crea la pipeline di distribuzione e il target
Puoi definire la pipeline e il target in un file o in file separati. In questa guida rapida, creerai un singolo file.
Crea la pipeline di distribuzione e la definizione del target:
GKE
Nella directory
deploy-hooks-gke-quickstart
, crea un nuovo file:clouddeploy.yaml
, con il seguente contenuto: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
Nella directory
deploy-hooks-run-quickstart
, crea un nuovo file:clouddeploy.yaml
, con il seguente contenuto: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
Registra la pipeline e i target con il servizio Cloud Deploy:
gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
Ora hai una pipeline di distribuzione, con un'unica destinazione, pronta per eseguire il deployment della tua applicazione e per eseguire i job di pre e post-deployment.
Conferma la pipeline e i target:
Nella console Google Cloud, vai alla pagina pipeline di distribuzione di Cloud Deploy per visualizzare l'elenco delle pipeline di distribuzione disponibili.
Apri la pagina Pipeline di distribuzione
Viene visualizzata la pipeline di distribuzione appena creata, con una destinazione elencata nella colonna Destinazioni.
Crea una release
Una release è la risorsa centrale di Cloud Deploy che rappresenta le modifiche di cui viene eseguito il deployment. La pipeline di distribuzione definisce il ciclo di vita di quella release. Per i dettagli sul ciclo di vita, consulta Architettura del servizio Cloud Deploy.
GKE
Esegui questo comando dalla directory deploy-hooks-gke-quickstart
per creare una risorsa release
che rappresenti l'immagine del container di cui eseguire il deployment:
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
Esegui questo comando dalla directory deploy-hooks-run-quickstart
per creare una risorsa release
che rappresenti l'immagine del container di cui eseguire il deployment:
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:6063adf8f687702b4065151acddba6781c47bc602167eb9f3bec8aebc9ce95cc
Come per tutte le release (a meno che non includano --disable-initial-rollout
), Cloud Deploy crea automaticamente anche una risorsa di implementazione. Il deployment dell'applicazione viene eseguito automaticamente in un'unica destinazione configurata per questa pipeline di distribuzione.
Inoltre, il job di pre-deployment viene eseguito prima del deployment dell'applicazione, mentre il job post-deployment viene eseguito dopo.
Visualizza i risultati nella console Google Cloud
Dopo qualche minuto, viene eseguito il deployment della release nel runtime di destinazione.
Gli hook pre e post-deployment che abbiamo configurato (ad esempio) stampano le stringhe nei log di Cloud Build. Possiamo visualizzare questi log per confermare che gli hook abbiano funzionato come previsto.
Nella console Google Cloud, vai alla pagina pipeline di distribuzione di Cloud Deploy per visualizzare la pipeline di distribuzione ("deploy-hooks-demo-app-gke-1" o "deploy-hooks-demo-app-run-1").
Fai clic sul nome della tua pipeline di distribuzione ("deploy-hooks-demo-app-gke-1" o "deploy-hooks-demo-app-run-1").
La visualizzazione della pipeline mostra lo stato del deployment dell'app. Poiché c'è una sola fase nella pipeline, la visualizzazione mostra solo un nodo.
La release è elencata nella scheda Release in Dettagli della pipeline di pubblicazione.
Fai clic sulla scheda Implementazioni, nella sezione Dettagli pipeline di pubblicazione.
Fai clic sul nome dell'implementazione per visualizzarne i dettagli.
Pre-deployment e Postdeploy sono elencati come job.
Fai clic su Pre-deployment
Viene visualizzato il log di esecuzione del job.
Scorri verso il basso nell'elenco delle voci di log per trovare
predeploy-echo
e fai clic su questa voce.Osserva il
textPayload
. La stringa è quella che è stata configurata inpredeploy-action
nella configurazione di Skaffold.Fai clic sul job Postdeploy e trova la voce di log
postdeploy-echo
.
Esegui la pulizia
Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questa pagina, segui questi passaggi:
Elimina il cluster GKE o il servizio 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
Elimina la pipeline di distribuzione, il target, il rilascio e l'implementazione:
gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
Eliminare i bucket Cloud Storage creati da Cloud Deploy.
Uno termina con
_clouddeploy
e l'altro è[region].deploy-artifacts.[project].appspot.com
.
È tutto. Hai completato questa guida rapida.