Verificare l'applicazione dopo averla implementata

Questa guida rapida mostra come utilizzare Cloud Deploy per verificare l'applicazione di cui è stato eseguito il deployment nell'ambito della pipeline di distribuzione.

In questa guida rapida imparerai a:

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

    Puoi utilizzare la verifica del deployment anche sui cluster GKE collegati, ma questa guida rapida utilizza solo GKE e Cloud Run.

  2. Definisci la pipeline di distribuzione e la destinazione di deployment di Cloud Deploy.

    La pipeline di distribuzione include una sola fase e utilizza un solo target. Definisci la configurazione per la verifica del deployment nella sezione stage.

  3. Crea una configurazione Skaffold necessaria per la release e un manifest Kubernetes o una definizione del servizio Cloud Run.

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

    Dopo il deployment dell'applicazione, la verifica viene eseguita come fase dell'implementazione.

  5. Visualizza i risultati della verifica nei log di Cloud Build utilizzando la pagina Dettagli implementazione di Cloud Deploy nella consoleGoogle Cloud .

Prima di iniziare

  1. 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 senza costi per l'esecuzione, il test e il deployment dei workload.

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

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Abilita le API Cloud Deploy, Cloud Build, GKE, Cloud Run e Cloud Storage.

    Ruoli richiesti per abilitare le API

    Per abilitare le API, devi disporre del ruolo IAM Amministratore utilizzo dei servizi (roles/serviceusage.serviceUsageAdmin), che include l'autorizzazione serviceusage.services.enable. Scopri come concedere i ruoli.

    Abilita le API

  5. Installa Google Cloud CLI.

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

  7. Per inizializzare gcloud CLI, esegui questo comando: 

    gcloud init

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

    Go to project selector

  9. Verify that billing is enabled for your Google Cloud project.

  10. Abilita le API Cloud Deploy, Cloud Build, GKE, Cloud Run e Cloud Storage.

    Ruoli richiesti per abilitare le API

    Per abilitare le API, devi disporre del ruolo IAM Amministratore utilizzo dei servizi (roles/serviceusage.serviceUsageAdmin), che include l'autorizzazione serviceusage.services.enable. Scopri come concedere i ruoli.

    Abilita le API

  11. Installa Google Cloud CLI.

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

  13. Per inizializzare gcloud CLI, esegui questo comando: 

    gcloud init

    14. Se hai già installato la CLI, assicurati di utilizzare l'ultima versione: 

    gcloud components update

  14. Assicurati che l'account di servizio Compute Engine predefinito 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. Per prima cosa, 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"

    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)")-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"

    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)")-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

Crea l'ambiente di runtime

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

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

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

Crea la pipeline di distribuzione e i target

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

  1. Apri una finestra del terminale.

  2. Crea una nuova directory e accedi.

    GKE 

    mkdir deploy-verification-gke-quickstart
cd deploy-verification-gke-quickstart

    Cloud Run 

    mkdir deploy-verification-run-quickstart
cd deploy-verification-run-quickstart

  3. Crea la pipeline di distribuzione e la definizione del target:

    GKE

    Nella directory deploy-verification-gke-quickstart, crea un nuovo file: clouddeploy.yaml, con il seguente contenuto:

    apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: deploy-verification-demo-app-gke-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: verify-staging
    profiles: []
    strategy:
      standard:
        verify:
          tasks:
          - type: container
            image: ubuntu
            command: ["/bin/sh"]
            args: ["-c", 'echo "Your test or tests would go here."' ]
---

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

    Cloud Run

    Nella directory deploy-verification-run-quickstart, crea un nuovo file: clouddeploy.yaml, con il seguente contenuto:

    apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: deploy-verification-demo-app-run-1
description: main application pipeline
serialPipeline:
  stages:
  - targetId: verify-staging
    profiles: []
    strategy:
      standard:
        verify:
          tasks:
          - type: container
            image: ubuntu
            command: ["/bin/sh"]
            args: ["-c", 'echo "Your test or tests would go here."' ]
---

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

    Questo file include la sezione verify all'interno della definizione strategy della pipeline di pubblicazione. Definisce il container e il comando da eseguire dopo il deployment dell'applicazione. In questo caso, stiamo eseguendo il deployment di un container Ubuntu ed eseguendo un semplice comando echo. Puoi visualizzare i risultati di questo comando nei log. In uno scenario più realistico, eseguirai test sull'applicazione di cui è stato eseguito il deployment.

  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 una destinazione, pronta per eseguire il deployment della tua applicazione e verificare il deployment.

  5. Conferma la pipeline e i target:

    Nella console Google Cloud , vai alla pagina Pipeline di distribuzione di Cloud Deploy per visualizzare un 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.

    Pagina della pipeline di distribuzione nella console Google Cloud , che mostra la pipeline

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

Cloud Deploy utilizza Skaffold per identificare il manifest da utilizzare per eseguire il deployment dell'app di esempio nel tuo 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 per la tua 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-verification-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 segnaposto, my-app-image, che viene sostituito 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-verification-run-service
spec:
  template:
    spec:
      containers:
      - image: my-app-image

    Questo file è una definizione di base del servizio Cloud Run, che viene utilizzata per eseguire il deployment dell'applicazione. L'immagine container da eseguire il deployment è impostata qui come segnaposto, my-app-image, che viene sostituito con l' immagine specifica quando crei la release.

Crea una release

Una release è la risorsa Cloud Deploy centrale 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 questo comando dalla directory deploy-verification-gke-quickstart per creare una risorsa release che rappresenta l'immagine container da eseguire il deployment:

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

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

Cloud Run

Esegui questo comando dalla directory deploy-verification-run-quickstart per creare una risorsa release che rappresenta l'immagine container da eseguire il deployment:

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

Nota il flag --images=, 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 per le definizioni dei servizi in questo modo e di utilizzare nomi di immagini qualificati 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 rollout. L'applicazione viene automaticamente sottoposta a deployment nell'unico target configurato per questa pipeline di distribuzione.

Il job di verifica specificato nella pipeline di distribuzione viene eseguito nell'ambito di questo rollout, dopo il deployment dell'applicazione.

Visualizza i risultati nella console Google Cloud

Dopo alcuni minuti, la release viene implementata nel runtime di destinazione.

Il job di verifica che abbiamo configurato (a scopo esemplificativo) stampa una stringa nel log di Cloud Build. Possiamo visualizzare il log per confermare che la verifica ha funzionato come previsto.

  1. Nella console Google Cloud , vai alla pagina Pipeline di distribuzione di Cloud Deploy per visualizzare la pipeline di distribuzione ("deploy-verification-demo-app-gke-1" o "deploy-verification-demo-app-run-1").

    Apri la pagina Pipeline di distribuzione

  2. Fai clic sul nome della pipeline di distribuzione ("deploy-verification-demo-app-gke-1" o "deploy-verification-demo-app-run-1").

    La visualizzazione della pipeline mostra lo stato del deployment dell'app. Poiché la pipeline contiene una sola fase, la visualizzazione mostra un solo nodo.

    Visualizzazione della pipeline di distribuzione che mostra l'operazione riuscita

    La tua uscita è elencata nella scheda Uscite in Dettagli della pipeline di distribuzione.

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

  4. Fai clic sul nome del lancio per visualizzarne i dettagli.

    implementazioni nella console Google Cloud

    Verifica è elencato come job.

  5. Fai clic su Verifica.

    Viene visualizzato il log di esecuzione del job.

  6. Scorri verso il basso l'elenco delle voci di log per trovare verification-test e fai clic su di esso.

    Voce di log che mostra l'output del job di verifica

    Nota textPayload. Questa stringa è stata configurata nella sezione Verify della pipeline di pubblicazione.

Esegui la pulizia

Per evitare che al tuo account Google Cloud 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-verification-cluster --region=us-central1 --project=PROJECT_ID

    Cloud Run 

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

  2. Elimina la pipeline di distribuzione, la destinazione, 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 e l'altro è [region].deploy-artifacts.[project].appspot.com.

    Apri la pagina del browser Cloud Storage

Ecco fatto, hai completato questa guida rapida.

Passaggi successivi