Eseguire gli hook prima e dopo il deployment

Eseguire gli hook prima e dopo il deployment

Questa guida rapida mostra come eseguire un hook di deployment, ovvero un programma arbitrario da eseguire prima o dopo il deployment utilizzando Cloud Deploy.

In questa guida rapida imparerai a:

1. Creare un cluster GKE o un servizio Cloud Run.

   Puoi utilizzare anche i cluster collegati GKE, ma questa guida rapida utilizza solo GKE e Cloud Run.

2. Definire la pipeline di distribuzione e il target di deployment di Cloud Deploy.

   La configurazione della pipeline di distribuzione include le definizioni degli hook di deployment, come tasks.

   Questa pipeline include una sola fase e utilizza un solo target.

3. Creare una configurazione Skaffold e un manifest Kubernetes o una definizione del servizio Cloud Run.

   Il file di configurazione Skaffold è il luogo in cui identifichi i manifest di cui vuoi eseguire il deployment con Cloud Deploy.

4. Creare una release, di cui viene eseguito automaticamente il deployment nel target.

   Uno degli hook viene eseguito prima del deployment dell'applicazione, l'altro dopo.

5. Visualizzare i risultati degli hook di pre- e post-deployment nei log di Cloud Build, utilizzando la pagina Dettagli implementazione di Cloud Deploy nella Google Cloud console.

Prima di iniziare

Accedi al tuo Google Cloud account. Se non hai mai utilizzato Google Cloud, crea un account per valutare il rendimento dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti senza costi per l'esecuzione, il test e il deployment dei workload.
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.
Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.
Go to project selector
Verify that billing is enabled for your Google Cloud project.
Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.
Enable the APIs
Installa Google Cloud CLI.
Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.
Per inizializzare gcloud CLI, esegui questo comando:
gcloud init
Nota: puoi eseguire gcloud CLI nella console senza installare Google Cloud CLI. Google Cloud Per eseguire la gcloud CLI nella Google Cloud console, utilizza Cloud Shell.

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

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

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Installa Google Cloud CLI.

Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

Per inizializzare gcloud CLI, esegui questo comando:

gcloud init

Nota: puoi eseguire gcloud CLI nella console senza installare Google Cloud CLI. Google Cloud Per eseguire la gcloud CLI nella Google Cloud console, utilizza Cloud Shell.

Se hai già installato l'interfaccia a riga di comando, assicurati di eseguire l'ultima versione:

gcloud components update

1. Assicurati che il service account predefinito di Compute Engine disponga delle autorizzazioni necessarie.

   Il account di servizio potrebbe già disporre delle autorizzazioni necessarie. Questi passaggi sono inclusi per i progetti che disattivano la concessione automatica dei ruoli per i service account predefiniti.

1. Innanzitutto, aggiungi il ruolo clouddeploy.jobRunner:

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --role="roles/clouddeploy.jobRunner"
   

2. Aggiungi il ruolo di 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)")[e-mail] \
      --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)")[e-mail] \
      --role="roles/run.developer"
  

3. Aggiungi il ruolo iam.serviceAccountUser, che include l'autorizzazione actAs per eseguire il deployment nel runtime:

   gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
       --format="value(projectNumber)")[e-mail] \
       --role="roles/iam.serviceAccountUser" \
       --project=PROJECT_ID
   

Crea l'ambiente di runtime

Se esegui il deployment in Cloud Run, puoi saltare questo comando.

Per GKE, crea un cluster: deploy-hooks-cluster, con le impostazioni predefinite. L'endpoint API Kubernetes del cluster deve essere raggiungibile dalla rete internet pubblica. Per impostazione predefinita, i cluster GKE sono accessibili esternamente.

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

Crea la pipeline di distribuzione e il target

Puoi definire la pipeline e il target in un unico file o in file separati. In questa guida rapida, creerai un singolo file.

1. Apri una finestra del terminale.

2. Crea una nuova directory e accedi alla directory.

   GKE

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

   Cloud Run

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

3. 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:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a predeploy action"' ]
           postdeploy:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a 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:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a predeploy action"' ]
           postdeploy:
             tasks:
             - type: container
               image: ubuntu
               command: ["/bin/sh"]
               args: ["-c", 'echo "this is a 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
   

   Nota: in questo file, il target è incluso nella pipeline di distribuzione, ma puoi definire i target in un file separato o in più file separati.

4. 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 target, pronta per eseguire il deployment dell'applicazione ed eseguire i job di pre- e post-deployment.

5. Conferma la pipeline e i target:

   Nella Google Cloud console, 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 un target elencato nella colonna Target.

   

Crea il file di configurazione Skaffold e il manifest dell'applicazione

Cloud Deploy utilizza Skaffold per identificare i manifest utilizzati per eseguire il deployment dell'app di esempio nel target.

1. Crea un file denominato skaffold.yaml con il seguente contenuto:

   GKE

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

   Cloud Run

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

   Per ulteriori informazioni su questo file di configurazione, consulta il riferimento skaffold.yaml.

2. Crea la definizione dell'applicazione: una definizione del 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 manifest Kubernetes di base, che viene applicato al cluster per eseguire il deployment dell'applicazione. L'immagine container di cui eseguire il deployment è impostata qui come un segnaposto, my-app-image, che viene sostituita con l'immagine specifica quando crei la release.

   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 per eseguire il deployment dell'applicazione. L'immagine container di cui eseguire il deployment è impostata qui come segnaposto, my-app-image, che viene sostituita con l'immagine specifica quando crei la release.

Nota: se vuoi utilizzare manifest diversi per target, leggi questo articolo sulla gestione dei manifest per scoprire di più sull'utilizzo dei profili Skaffold.

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 questa release. Per informazioni dettagliate su questo ciclo di vita, consulta Architettura del servizio Cloud Deploy.

GKE

Esegui il comando seguente dalla directory deploy-hooks-gke-quickstart per creare una risorsa release che rappresenta l'immagine 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

Nota il --images= flag, che utilizzi per sostituire il segnaposto (my-app-image) nel manifest con l'immagine specifica qualificata con SHA. Google consiglia di creare un modello dei manifest in questo modo e di utilizzare nomi di immagini qualificati con SHA durante la creazione della release.

Cloud Run

Esegui il comando seguente dalla directory deploy-hooks-run-quickstart per creare una risorsa release che rappresenta l'immagine 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:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

Nota il --images= flag, che utilizzi per sostituire il segnaposto (my-app-image) nella definizione del servizio con l'immagine specifica qualificata con SHA. Google consiglia di creare un modello delle definizioni di servizi e job in questo modo e di utilizzare nomi di immagini qualificati con SHA durante la creazione della release.

Come per tutte le release (a meno che non includano --disable-initial-rollout), Cloud Deploy crea automaticamente anche una risorsa di implementazione. L'applicazione viene sottoposta automaticamente al deployment nell'unico target configurato per questa pipeline di distribuzione.

Inoltre, il job di pre-deployment viene eseguito prima del deployment dell'applicazione, mentre il job di post-deployment viene eseguito dopo.

Visualizza i risultati nella Google Cloud console

Dopo alcuni minuti, la release viene sottoposta al deployment nel runtime di destinazione.

Gli hook di pre- e post-deployment che abbiamo configurato (a scopo di esempio) stampano stringhe nei log di Cloud Build. Possiamo visualizzare questi log per verificare che gli hook funzionino come previsto.

1. Nella Google Cloud console, 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").

   Apri la pagina Pipeline di distribuzione

2. Fai clic sul nome della 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é la pipeline ha una sola fase, la visualizzazione mostra un solo nodo.

   

   La release è elencata nella scheda Release in Dettagli pipeline di distribuzione.

3. Fai clic sulla scheda Implementazioni in Dettagli pipeline di distribuzione.

4. Fai clic sul nome dell'implementazione per visualizzarne i dettagli.

   

   Predeploy e Postdeploy sono elencati come job.

5. Fai clic su Predeploy.

   Viene visualizzato il log di esecuzione del job.

6. Scorri verso il basso nell'elenco delle voci di log per trovare predeploy-echo e fai clic su di essa.

   

   Nota textPayload. Questa stringa è quella configurata in predeploy-action nella tua pipeline di distribuzione.

7. Fai clic sul job Postdeploy e trova la voce di log postdeploy-echo.

   

Libera spazio

Per evitare che al tuo Google Cloud account vengano addebitati costi relativi alle risorse utilizzate in questa pagina, segui questi passaggi.

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

2. Elimina la pipeline di distribuzione, il target, la release e l'implementazione:

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

3. Elimina i bucket Cloud Storage creati da Cloud Deploy.

   Uno termina con _clouddeploy, l'altro è [region].deploy-artifacts.[project].appspot.com.

   Apri la pagina del browser Cloud Storage

Ecco fatto, hai completato questa guida rapida.

Passaggi successivi

• Scopri di più su Cloud Deploy.

• Scopri le nozioni di base sul deployment delle applicazioni.

• Prova la procedura dettagliata di Cloud Deploy.

• Scopri come combinare Google Cloud gli strumenti CI/CD per sviluppare e distribuire software in modo efficace su GKE.