Definire e utilizzare un tipo di target personalizzato

Definire e utilizzare un tipo di target personalizzato

Questa guida rapida mostra come utilizzare Cloud Deploy per creare un di destinazione, poi eseguirne il deployment in una destinazione personalizzata di quel tipo.

In questa guida rapida imparerai a:

1. Crea una configurazione Skaffold.

   Il file di configurazione Skaffold consente di configurare il comportamento dell'oggetto target. Questa configurazione fa riferimento alle immagini container e ai comandi shell da eseguire su queste immagini, ovvero le azioni per le operazioni di rendering e deployment.

2. Definisci un tipo di target personalizzato e un target che faccia riferimento a quel tipo.

3. Definisci la pipeline di distribuzione di Cloud Deploy.

   Questa pipeline include una sola fase e utilizza un solo target. In questo farai riferimento al target che hai configurato.

4. Crea una release, che crea automaticamente un'implementazione che genera le operazioni di rendering e deployment personalizzate in esecuzione.

   Nell'ambito di questa release e dell'implementazione, vengono eseguite entrambe le operazioni di rendering e deployment definite nella configurazione di Skaffold.

5. Visualizza i risultati delle operazioni personalizzate. Sono inclusi un file di configurazione visualizzato caricato su Cloud Storage, una stringa scritta in questo file e un file di risultati che include lo stato dell'operazione.

Prima di iniziare

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

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

   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

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

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

   Enable the APIs

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

   Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

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

   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

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

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

   Enable the APIs

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

    Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

Se hai già installato Google Cloud CLI, assicurati di eseguire l'ultima versione versione:

gcloud components update

12. Assicurati che l'account di servizio Compute Engine predefinito abbia autorizzazioni sufficienti.

    L'account di servizio potrebbe già disporre delle autorizzazioni necessarie. Questi passaggi sono inclusi per i progetti che disabilitano le concessioni automatiche di ruoli per il servizio predefinito .

1. Aggiungi prima 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 sviluppatore per il tuo runtime specifico.
3. Aggiungi il ruolo iam.serviceAccountUser, che include l'autorizzazione actAs per 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
   

Prepara la configurazione Skaffold e il manifest dell'applicazione

Cloud Deploy utilizza Skaffold per fornire i dettagli di cosa eseguire il deployment e come target.

In questa guida rapida creerai un file skaffold.yaml, che definisce le azioni personalizzate che rappresentano le operazioni di rendering e deployment tipo di target.

Tieni presente che il deployment delle azioni personalizzate fornite in questa guida rapida non un'applicazione a un runtime. Sia le azioni di rendering che di deployment dei risultati in Cloud Storage per soddisfare il contratto con la destinazione personalizzata tra Cloud Deploy e il rendering e il deployment definiti dall'utente.

1. Apri una finestra del terminale.

2. Crea una nuova directory e aprila.

   mkdir custom-target-quickstart
   cd custom-target-quickstart
   

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

   apiVersion: skaffold/v4beta7
   kind: Config
   customActions:
   - name: custom-render
     containers:
     - name: render
       image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:66e2681aa3099b4e517e4cdcdefff8f2aa45d305007124ccdc09686f6712d018
       command: ['/bin/bash']
       args:
         - '-c'
         - |-
           echo "Sample manifest rendered content" > manifest.txt
           gcloud storage cp manifest.txt $CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt
           echo {\"resultStatus\": \"SUCCEEDED\", \"manifestFile\": \"$CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt\"} > results.json
           gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
   - name: custom-deploy
     containers:
     - name: deploy
       image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:66e2681aa3099b4e517e4cdcdefff8f2aa45d305007124ccdc09686f6712d018
       command: ['/bin/bash']
       args:
         - '-c'
         - |-
           echo {\"resultStatus\": \"SUCCEEDED\"} > results.json
           gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
   

   Questo file include la stanza customActions:, che definisce un rendering personalizzato e un'azione di deployment personalizzata. Ognuna di queste azioni personalizzate fa riferimento a un'immagine container da eseguire e ai comandi da eseguire in quel container.

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

Crea la pipeline di distribuzione, il tipo di target personalizzato e il target

Puoi definire la pipeline di distribuzione, il tipo di target personalizzato e il target in una o in file separati. In questa guida rapida, creerai un unico file con tutti e tre gli elementi.

1. Nella directory custom-target-quickstart, crea un nuovo file, clouddeploy.yaml, con il seguente contenuto:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: custom-targets-pipeline
   serialPipeline:
     stages:
     - targetId: sample-env
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: sample-env
   customTarget:
     customTargetType: basic-custom-target
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: CustomTargetType
   metadata:
     name: basic-custom-target
   customActions:
     renderAction: custom-render
     deployAction: custom-deploy
   

   Nota: il tipo di target personalizzato e il target sono inclusi nella pubblicazione pipeline in questo file, ma puoi definirle in un file separato o file separati.

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 un target. Questo è il tuo target il tipo di destinazione personalizzato e questa pipeline non esegue il deployment di un'applicazione runtime.

3. Conferma la pipeline e i target:

   Nella console Google Cloud, vai a Cloud Deploy Pagina Pipeline di distribuzione per visualizzare l'elenco della distribuzione disponibile pipeline di dati.

   Apri la pagina Pipeline di distribuzione

   Viene visualizzata la pipeline di distribuzione appena creata, con un target elencato nella colonna Target.

   

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 della release. Per informazioni dettagliate sul ciclo di vita, consulta la sezione Architettura del servizio Cloud Deploy.

Esegui questo comando dalla directory custom-target-quickstart per crea una risorsa release che rappresenta l'azione personalizzata di cui eseguire il deployment:

gcloud deploy releases create test-release-001 \
  --project=PROJECT_ID \
  --region=us-central1 \
  --delivery-pipeline=custom-targets-pipeline

Come per tutte le release (a meno che non includano --disable-initial-rollout), Cloud Deploy crea automaticamente risorsa rollout. Tutte le fasi un'implementazione, tra cui rendering e deployment.

Visualizza i risultati nella console Google Cloud

Dopo alcuni minuti, il deployment è completo. In questo caso, poiché i due le azioni personalizzate sono comandi per eseguire l'eco delle stringhe in un file e caricarlo nel in Cloud Storage, non viene eseguito alcun deployment nel runtime di destinazione.

Tuttavia, puoi visualizzare il file e le relative stringhe:

1. Nella console Google Cloud, vai alla pagina Pipeline di distribuzione di Cloud Deploy per visualizzare la pipeline di distribuzione (custom-targets-pipeline).

   Apri la pagina Pipeline di distribuzione

2. Fai clic sul nome della pipeline di distribuzione (custom-targets-pipeline).

   La visualizzazione della pipeline mostra lo stato di deployment dell'app. Poiché nella pipeline è presente un solo passaggio, la visualizzazione mostra un solo nodo.

   

   La tua release sarà elencata nella scheda Uscite della sezione Pipeline di pubblicazione dettagli.

3. Fai clic sul nome della release.

   Viene visualizzata la pagina Dettagli sulla release.

4. Fai clic sulla scheda Artefatti.

5. In Artefatti target, fai clic sul link VISUALIZZA ARTEFATTI.

   Viene mostrato il file manifest sottoposto a rendering. In questo caso, il file è l'output dell'azione di rendering personalizzata che hai definito nel file di configurazione skaffold.yaml e contiene la stringa "Sample manifest rendered content".

   

6. Trova i bucket Cloud Storage creati da questa release.

   Apri la pagina del browser di Cloud Storage

   Viene visualizzata la pagina Bucket, che mostra i due bucket creati per questo . Un bucket contiene il file di configurazione della pipeline di distribuzione e il skaffold.yaml visualizzato. L'altro include il file di output che la nostra azione personalizzata è configurata per creare.

7. Fai clic sul bucket il cui nome inizia con us-central1.deploy-artifacts...

   

8. Fai clic sulla cartella il cui nome inizia con custom-targets-pipeline-, quindi fai clic sulla cartella test-release-001.

9. Fai clic sulla cartella il cui nome corrisponde all'implementazione, che dovrebbe test-release-001-to-sample-env-0001.

10. Fai clic sulla cartella visualizzata, che è un UUID, quindi sulla cartella custom-output.

11. Fai clic su results.json, poi fai clic sull'URL con link ipertestuale nel riquadro URL.

    Questo file contiene la stringa che hai configurato come output dell'azione custom-deploy in skaffold.yaml:

    

Nota: puoi anche vedere i risultati di rendering nella finestra di Cloud Storage ma è più rapido usare la funzionalità di controllo delle release, come mostrato in primi passaggi di questa procedura.

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

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

2. Elimina entrambi i bucket Cloud Storage su cui Cloud Deploy è stato creato.

   Apri la pagina del browser Cloud Storage

Hai completato questa guida rapida.

Passaggi successivi

• Scopri di più sui target personalizzati.

• Consulta i tipi di target personalizzati di esempio disponibili.

• Scopri di più su Cloud Deploy.

• Scopri le nozioni di base sul deployment delle applicazioni.

• Prova la procedura dettagliata di Cloud Deploy.