Utilizzare i parametri di deployment

Utilizzare i parametri di deployment

Questa pagina mostra come utilizzare Cloud Deploy per eseguire il deployment di un'applicazione di esempio a due target contemporaneamente (un deployment parallelo), passando un valore parametro diverso a ogni manifest o definizione di servizio di cui è stato eseguito il rendering, utilizzando tre metodi diversi.

In questa guida rapida imparerai a:

1. Creare due cluster GKE o due servizi Cloud Run.

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

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

   Il manifest o la definizione di servizio sarà lo stesso per entrambi i target figlio, ma al momento del deployment il manifest o la definizione di servizio di cui è stato eseguito il rendering per ogni target figlio avrà valori diversi per i parametri specifici configurati in questa guida rapida.

3. Definire la pipeline di distribuzione e i target di deployment di Cloud Deploy.

   Questa pipeline avrà un target multiplo, che fa riferimento a due target figlio, per distribuire l'app ai due cluster o ai due servizi.

4. Definire i parametri di deployment in tre posizioni diverse:

   • Nella progressione della pipeline
   • Nei target figlio
   • Nella riga di comando, durante la creazione della release

5. Creare un'istanza della pipeline di distribuzione creando una release, che esegue automaticamente il deployment nei due target in parallelo.

6. Visualizzare il "rollout del controller" e i rollout figlio nella Google Cloud console.

Prima di iniziare

Accedi al tuo Google Cloud account. 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.
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 gli ambienti di runtime

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

Per GKE, crea due cluster: deploy-params-cluster-prod1 e deploy-params-cluster-prod2, con le impostazioni predefinite. Gli endpoint API Kubernetes dei cluster devono essere raggiungibili dalla rete internet pubblica. Per impostazione predefinita, i cluster GKE sono accessibili esternamente.

gcloud container clusters create-auto deploy-params-cluster-prod1 \
                 --project=PROJECT_ID \
                 --region=us-central1 \
                 && gcloud container clusters create-auto deploy-params-cluster-prod2 \
                 --project=PROJECT_ID \
                 --region=us-west1

Prepara la configurazione e i manifest di Skaffold

Cloud Deploy utilizza Skaffold per fornire i dettagli su cosa eseguire il deployment e come eseguirlo correttamente per i target separati .

In questa guida rapida, crei un file skaffold.yaml, che identifica il manifest Kubernetes o la definizione di servizio Cloud Run da utilizzare per eseguire il deployment dell'app di esempio.

1. Apri una finestra del terminale.

2. Crea una nuova directory e spostati al suo interno.

   GKE

   mkdir deploy-params-gke-quickstart
   cd deploy-params-gke-quickstart
   

   Cloud Run

   mkdir deploy-params-run-quickstart
   cd deploy-params-run-quickstart
   

3. Crea un file denominato skaffold.yaml con i seguenti contenuti:

   GKE

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

   Cloud Run

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

   Questo file è una configurazione Skaffold minima. Per questa guida rapida, crei il file. Tuttavia, puoi anche chiedere a Cloud Deploy di crearne uno per te, per applicazioni semplici non di produzione.

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

4. Crea la definizione per l'applicazione: una definizione di servizio per Cloud Run o un manifest Kubernetes per GKE.

   GKE

   Crea un file denominato kubernetes.yaml con i seguenti contenuti:

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: my-deployment
   spec:
     replicas: 1 # from-param: ${replicaCount}
     selector:
       matchLabels:
         app: my-app
     template:
       metadata:
         labels:
           app: my-app
         annotations:
           commit: defaultShaValue # from-param: ${git-sha}
       spec:
         containers:
         - name: nginx
           image: my-app-image
           env:
           - name: envvar1
             value: default1 # from-param: ${application_env1}
           - name: envvar2
             value: default2 # from-param: ${application_env2}
   

   Questo file è un manifest Kubernetes , 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 i seguenti contenuti:

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: my-parallel-run-service
   spec:
     autoscaling.knative.dev/minScale: 1 # from-param: ${minInstances}
     selector:
       matchLabels:
         app: my-app
     template:
       metadata:
         annotations:
           commit: defaultShaValue # from-param: ${git-sha}
       spec:
         containers:
         - image: my-app-image
           env:
           - name: envvar1
             value: defaultValue1 # from-param: ${application_env1}
           - name: envvar2
             value: defaultValue2 # from-param: ${application_env2}
   

   Questo file è una definizione di servizio Cloud Run di base, 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 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, creiamo un singolo file.

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

   GKE

   Nella directory deploy-params-gke-quickstart, crea un nuovo file: clouddeploy.yaml, con i seguenti contenuti:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-params-demo-app-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: params-prod-multi
       deployParameters:
       - values:
           replicaCount: "2"
         # Apply the deploy parameter replicaCount: "2" to the target with this label
         matchTargetLabels:
           label1: label1
       - values:
           replicaCount: "3"
         # Apply the deploy parameter replicaCount: "3" to the target with this label
         matchTargetLabels:
           label2: label2
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: params-prod-multi
   description: production clusters
   multiTarget:
     targetIds: [params-prod-a, params-prod-b]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: params-prod-a
     labels:
       label1: label1
   description: production cluster 1
   deployParameters:
     application_env1: "sampleValue1"
   gke:
     cluster: projects/PROJECT_ID/locations/us-central1/clusters/deploy-params-cluster-prod1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: params-prod-b
     labels:
       label2: label2
   description: production cluster 2
   deployParameters:
     application_env2: "sampleValue2"
   gke:
     cluster: projects/PROJECT_ID/locations/us-west1/clusters/deploy-params-cluster-prod2
   

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

   Cloud Run

   Nella directory deploy-params-run-quickstart, crea un nuovo file: clouddeploy.yaml, con i seguenti contenuti:

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-params-demo-app-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: params-prod-multi
       deployParameters:
       - values:
           minInstances: "2"
         # Apply the deploy parameter minInstances: "2" to the target with this label
         matchTargetLabels:
           label1: label1
       - values:
           minInstances: "3"
         # Apply the deploy parameter minInstances: "3" to the target with this label
         matchTargetLabels:
           label2: label2
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: params-prod-multi
   description: production clusters
   multiTarget:
     targetIds: [params-prod-a, params-prod-b]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: params-prod-a
     labels:
       label1: label1
   description: production cluster 1
   deployParameters:
     application_env1: "sampleValue1"
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: params-prod-b
     labels:
       label2: label2
   description: production cluster 2
   deployParameters:
     application_env2: "sampleValue2"
   run:
     location: projects/PROJECT_ID/locations/us-west1
   

   Nota: in questo file, i target sono inclusi nella pipeline di distribuzione, ma puoi definire i target in un file separato o in più 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, con un target multiplo composto da due target GKE o Cloud Run, pronta per eseguire il deployment dell'applicazione.

3. Conferma la pipeline e i target:

   Nella Google Cloud console, 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 che hai appena creato. Tieni presente che nella colonna Target è elencato un solo target, anche se nel file clouddeploy.yaml hai configurato tre target (un target multiplo e due target figlio).

   

   Tieni presente che l'unico target elencato è il target multiplo params-prod-multi. I target figlio non vengono visualizzati.

Crea una release

Una release è la risorsa centrale di Cloud Deploy che rappresenta le modifiche di cui è stato 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-gke-parallel-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=my-params-demo-app-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa \
   --deploy-parameters="git-sha=f787cac"

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-run-parallel-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=my-params-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a \
   --deploy-parameters="git-sha=f787cac"

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 sempre, quando crei una release, viene creato automaticamente un rollout per il primo target nella pipeline (a meno che non venga specificato un target specifico utilizzando --to-target=). In questa guida rapida, questo target è un target multiplo, quindi il rollout è un "rollout del controller" per due target figlio e non sono presenti target successivi nella pipeline di distribuzione. Ciò significa che l'applicazione viene sottoposta a deployment ovunque al momento della creazione del rollout.

Visualizza i risultati nella Google Cloud console

Ora che hai creato la release e sono stati creati il rollout del controller e i rollout figlio, questi ultimi vengono sottoposti a deployment (o sono in fase di deployment) nei rispettivi cluster GKE o servizi Cloud Run.

1. Nella Google Cloud console, vai alla pagina Pipeline di distribuzione di Cloud Deploy per visualizzare la pipeline di distribuzione my-parallel-demo-app-1.

   Apri la pagina Pipeline di distribuzione

2. Fai clic sul nome della pipeline di distribuzione "my-parallel-demo-app-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 sul nome della release, test-release-001.

   I rollout vengono visualizzati in Rollout. Puoi fare clic su un rollout per visualizzarne i dettagli, incluso il log di deployment.

   

4. In Dettagli release, seleziona la scheda Artefatti.

   La tabella Parametri di deployment elenca tutti i parametri configurati nel manifest e i valori forniti per questi parametri:

   GKE

   

   Cloud Run

   

   Oltre ai parametri e ai valori, la tabella mostra a quale target si applica ogni parametro.

5. Nella colonna Controllo release, fai clic su Visualizza artefatti per uno dei due target.

6. Fai clic su Mostra differenza, quindi seleziona params-prod-a per un target e params-prod-b per l'altro.

   Viene visualizzata una differenza che confronta i manifest di cui è stato eseguito il rendering dei due target, inclusi i valori specificati:

   GKE

   

   Cloud Run

   

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 i cluster GKE o i servizi Cloud Run:

   GKE

   gcloud container clusters delete deploy-params-cluster-prod1 --region=us-central1 --project=PROJECT_ID \
   && gcloud container clusters delete deploy-params-cluster-prod2 --region=us-west1 --project=PROJECT_ID
   

   Cloud Run

   gcloud run services delete my-parallel-run-service --region=us-central1 --project=PROJECT_ID \
   && gcloud run services delete my-parallel-run-service --region=us-west1 --project=PROJECT_ID
   

2. Elimina la pipeline di distribuzione, il target multiplo, i target figlio, la release e i rollout:

   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

• Scopri di più sull'utilizzo dei parametri di deployment.

• Scopri di più su come eseguire il deployment in più target contemporaneamente.

• Scopri di più su Cloud Deploy.

• Scopri le nozioni di base sul deployment delle applicazioni.

• Scopri come gestire i manifest.

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