Verificare l'applicazione dopo il deployment

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. Creare un cluster GKE o un servizio Cloud Run.

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

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

    Nel file di configurazione Skaffold configuri il container di verifica del deployment per l'esecuzione dopo il deployment.

  3. Definire la pipeline di distribuzione di Cloud Deploy e la destinazione del deployment.

    Nella configurazione della pipeline di distribuzione, farai riferimento alla verifica del deployment definita in skaffold.yaml per eseguirla.

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

  4. Crea una release, che esegue automaticamente il deployment nella destinazione.

    Una volta eseguito il deployment dell'applicazione, la verifica viene eseguita come una fase dell'implementazione.

  5. Visualizza i risultati della verifica nei log di Cloud Build utilizzando la pagina Dettagli implementazione di Cloud Deploy nella console Google 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 gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

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

    Abilita le API

  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. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

  9. Abilita le API Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.

    Abilita le API

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

    gcloud init
  12. Se hai già installato l'interfaccia a riga di comando, assicurati di eseguire la versione più recente:

    gcloud components update
    

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

    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)")-compute@developer.gserviceaccount.com \
          --role="roles/clouddeploy.jobRunner"
      

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

    3. Aggiungi il ruolo iam.serviceAccountUser, che include l'autorizzazione actAsper 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 stai eseguendo il deployment in Cloud Run, puoi saltare questo comando.

Per GKE, crea un cluster: deploy-verification-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-verification-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 il container da eseguire dopo il deployment (verifica del deployment).

  1. Apri una finestra del terminale.

  2. Crea una nuova directory e aprila.

    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 un file denominato skaffold.yaml con il seguente contenuto:

    GKE

    apiVersion: skaffold/v4beta7
    kind: Config
    manifests:
      rawYaml:
      - k8s-pod.yaml
    deploy:
      kubectl: {}
    verify:
    - name: verification-test
      container:
        name: verification-echo
        image: ubuntu
        command: ["/bin/sh"]
        args: ["-c", 'echo "Your test or tests would go here."' ]
    

    Cloud Run

    apiVersion: skaffold/v4beta7
    kind: Config
    manifests:
      rawYaml:
      - service.yaml
    deploy:
      cloudrun: {}
    verify:
    - name: verification-test
      container:
        name: verification-echo
        image: ubuntu
        command: ["/bin/sh"]
        args: ["-c", 'echo "Your test or tests would go here."' ]
    

    Questo file include la stanza verify:, che 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, eseguiresti test sull'applicazione di cui hai eseguito il deployment.

    Consulta il riferimento skaffold.yaml per ulteriori informazioni su questo file di configurazione.

  4. 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-verification-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-verification-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 i target

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

  1. 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: true
    ---
    
    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: true
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: verify-staging
    description: staging Run service
    run:
      location: projects/PROJECT_ID/locations/us-central1
    
  2. 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 dell'applicazione e verificarlo.

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

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

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-verification-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-verification-demo-app-gke-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

Cloud Run

Esegui questo comando dalla directory deploy-verification-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-verification-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.

Il job di verifica che abbiamo specificato nella nostra configurazione Skaffold viene eseguito come parte di questo implementazione, dopo il deployment dell'applicazione.

Visualizza i risultati nella console Google Cloud

Dopo qualche minuto, viene eseguito il deployment della release nel runtime di destinazione.

Il job di verifica che abbiamo configurato (ad esempio) 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 tua 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é c'è una sola fase nella pipeline, la visualizzazione mostra solo un nodo.

    Visualizzazione della pipeline di distribuzione che mostra l'esito positivo

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

  3. Fai clic sulla scheda Implementazioni, nella sezione Dettagli pipeline di pubblicazione.

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

    lanci nella console Google Cloud

    Verifica è elencato come lavoro.

  5. Fai clic su Verifica.

    Viene visualizzato il log di esecuzione del job.

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

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

    Osserva il textPayload. La stringa è quella che è stata configurata nella Verify stanza della tua configurazione Skaffold.

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, il target, il rilascio e l'implementazione:

    gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
    
  3. Eliminare 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 di Cloud Storage

È tutto. Hai completato questa guida rapida.

Passaggi successivi