Utilizzare i parametri di deployment

Questa pagina mostra come utilizzare Cloud Deploy per pubblicare un'applicazione di esempio su due target contemporaneamente (un deployment parallelo), passando un valore parametro diverso a ogni definizione di manifest o servizio visualizzata, utilizzando tre metodi diversi.

In questa guida rapida imparerai a:

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

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

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

    La definizione del manifest o del servizio sarà la stessa per entrambi i target secondari, ma al momento del deployment la definizione del manifest o del servizio visualizzata per ogni target secondario avrà valori diversi per i parametri specifici configurati in questa guida introduttiva.

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

    Questa pipeline avrà un target multiplo che fa riferimento a due target figli per caricare la tua app nei due cluster o nei due servizi.

  4. Definisci i parametri di deployment in tre punti diversi:

    • Nella progressione della pipeline
    • Sui target secondari
    • Nella riga di comando, durante la creazione della release

  5. Esegui l'inizializzazione della pipeline di distribuzione creando una release, che viene eseguita automaticamente su entrambi i target in parallelo.

  6. Visualizza l'implementazione del controller e le implementazioni secondarie nella console Google Cloud.

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.

    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

  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud 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

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

    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 disattivano la concessione automatica dei ruoli per gli account di servizio predefiniti.

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

    2. Aggiungi il ruolo sviluppatore per il tuo 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 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 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 dall'internet pubblico. I cluster GKE sono accessibili dall'esterno per impostazione predefinita.

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 su come eseguirlo correttamente per i singoli target.

In questa guida rapida, crei un file skaffold.yaml che identifica il manifest Kubernetes o la definizione del 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 accedivi.

    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, crea il file. Puoi anche chiedere a Cloud Deploy di crearne uno per te per applicazioni semplici non di produzione.

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

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

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, creeremo 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 il seguente contenuto:

    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

    Cloud Run

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

    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

  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 multipla composto da due target GKE o Cloud Run, pronta per eseguire il deployment della tua applicazione.

  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 pubblicazione

    Viene visualizzata la pipeline di importazione appena creata. Tieni presente che nella colonna Target è elencato un target anche se nel file clouddeploy.yaml hai configurato tre target (un target multiplo e due target secondari).

    Visualizzazione della pipeline di distribuzione nella console Google Cloud

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

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.

GKE

Esegui il seguente comando dalla directory deploy-gke-parallel-quickstart per creare una risorsa release che rappresenti l'immagine del container da 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"

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

Cloud Run

Esegui il seguente comando dalla directory deploy-run-parallel-quickstart per creare una risorsa release che rappresenti l'immagine del container da 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:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4 \
   --deploy-parameters="git-sha=f787cac"

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

Come sempre, quando crei una release, viene creato automaticamente un rollout per il primo target della pipeline (a meno che non venga specificato un target specifico utilizzando --to-target=). In questa guida rapida, questo target è un multi-target, quindi rollout è un "rollout del controller" per due target secondari e non sono presenti target successivi nella pipeline di pubblicazione. Ciò significa che l'applicazione viene implementata ovunque al momento della creazione dell'implementazione.

Visualizza i risultati nella console Google Cloud

Ora che hai creato la release e le implementazioni del controller e secondarie, queste implementazioni secondarie vengono eseguite (o sono in fase di esecuzione) nei rispettivi cluster GKE o servizi Cloud Run.

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

  2. Fai clic sul nome della pipeline di distribuzione "my-parallel-demo-app-1".

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

    Visualizzazione della pipeline di distribuzione nella console Google Cloud

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

  3. Fai clic sul nome della release, test-release-001.

    Le implementazioni vengono visualizzate in Implementazioni. Puoi fare clic su un'implementazione per visualizzarne i dettagli, incluso il log di implementazione.

    implementazioni nella console Google Cloud

  4. In Dettagli release, seleziona la scheda Artefatti.

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

    GKE

    parametri di deployment e valori mostrati nella console Google Cloud

    Cloud Run

    parametri di deployment e valori mostrati nella console Google Cloud

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

  5. Nella colonna Strumento di controllo delle release, fai clic su Visualizza elementi per ciascun target.

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

    Viene visualizzata una differenza che confronta i manifest visualizzati dei due target, inclusi i valori specificati:

    GKE

    Differenza dei manifest visualizzati, con i valori passati

    Cloud Run

    Un manifest sottoposto a rendering specifico per il target, con i valori trasmessi

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 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, i target multipli, i target secondari, la release e le implementazioni:

    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

È tutto, hai completato questa guida rapida.

Passaggi successivi