Guida rapida: utilizzare i parametri di deployment

Utilizzare i parametri di deployment

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

In questa guida rapida:

  1. Creare 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 del servizio Cloud Run.

    La definizione del file manifest o del servizio sarà la stessa per entrambe le target figlio, ma al momento del deployment il manifest o la definizione del servizio sottoposti a rendering per ogni destinazione figlio avranno 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 multi-target, che faccia riferimento a due target figlio, per pubblicare l'app in due cluster o due servizi.

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

    • Nell'avanzamento della pipeline
    • Nei target figlio
    • Nella riga di comando, quando crei la release
  5. Crea l'istanza della pipeline di distribuzione creando una release, che esegue automaticamente il deployment nelle due destinazioni in parallelo.

  6. Visualizza l'"implementazione del controller" e le implementazioni secondarie 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. Nella console di Google Cloud Console, nella pagina del selettore dei progetti, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  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. Installa Google Cloud CLI.
  6. Per inizializzare l'interfaccia a riga di comando gcloud, esegui il comando seguente:

    gcloud init
  7. Nella console di Google Cloud Console, nella pagina del selettore dei progetti, seleziona o crea un progetto Google Cloud.

    Vai al selettore progetti

  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. Installa Google Cloud CLI.
  11. Per inizializzare l'interfaccia a riga di comando gcloud, esegui il comando seguente:

    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 di autorizzazioni sufficienti.

    L'account di servizio potrebbe disporre già delle autorizzazioni necessarie. Questi passaggi sono inclusi per i progetti che disattivano la concessione automatica 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 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 stai eseguendo il deployment in Cloud Run, puoi saltare questo comando.

Per GKE, crea due cluster: deploy-params-cluster-prod1 e deploy-params-cluster-prod2, con impostazioni predefinite. Gli endpoint API Kubernetes dei cluster devono essere raggiungibili in rete da 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 come eseguirne correttamente il deployment per i target separati.

In questa guida rapida, creerai 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 aprila.

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

    GKE

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

    Cloud Run

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

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

    Per ulteriori informazioni su questo file, consulta il riferimento 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 il seguente contenuto:

    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}
    

    Si tratta di 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-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 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, viene creato 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"
          matchTargetLabels:
            label1: label1
        - values:
            replicaCount: "3"
          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"
          matchTargetLabels:
            label1: label1
        - values:
            minInstances: "3"
          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 tua pipeline e i tuoi 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 che comprende due destinazioni GKE o Cloud Run, pronta per 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 distribuzione

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

    visualizzazione della pipeline di distribuzione nella console Google Cloud

    Tieni presente che l'unico target elencato è params-prod-multi target multipli. I target secondari non vengono mostrati.

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 quella release. Consulta Architettura del servizio Cloud Deploy per i dettagli su quel ciclo di vita.

GKE

Esegui questo comando dalla directory deploy-gke-parallel-quickstart per creare una risorsa release che rappresenti 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"

Cloud Run

Esegui questo comando dalla directory deploy-run-parallel-quickstart per creare una risorsa release che rappresenti 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/cloudrun/hello@sha256:7c0aeb55b25b12c656ad0856b13126ca0346c16dc631d9d7fa9dc335dd4a05df \
   --deploy-parameters="git-sha=f787cac"

Come sempre, quando crei una release, viene creata automaticamente un'implementazione per la prima destinazione nella pipeline (o, come in questo caso, per una destinazione specifica specificata utilizzando --to-target=). In questa guida rapida, questa destinazione è un target multiplo, quindi rollout è un'"implementazione del controller" per due target figlio e non ci sono destinazioni successive nella pipeline di distribuzione. Ciò significa che il deployment dell'applicazione viene eseguito ovunque al momento della creazione dell'implementazione.

Visualizza i risultati nella console Google Cloud

Ora che hai creato la release e sono stati creati l'implementazione del controller e le implementazioni figlio, il deployment di queste implementazioni figlio viene eseguito (o è in fase di deployment) 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 distribuzione

  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 una sola fase, la visualizzazione mostra un solo nodo.

    visualizzazione della pipeline di distribuzione nella console Google Cloud

    La release è elencata nella scheda Uscite, nella sezione Dettagli pipeline di distribuzione.

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

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

    lanci nella console Google Cloud

  4. In Dettagli della release, seleziona la scheda Artefatti.

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

    GKE

    eseguire il deployment di parametri
e valori mostrati nella console Google Cloud

    Cloud Run

    eseguire il deployment di parametri
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 Controllo release, fai clic su Visualizza artefatti per entrambi i target.

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

    Viene mostrata una differenza che confronta i manifest sottoposti a rendering dei due target, inclusi i valori specificati:

    GKE

    differenza dei manifest sottoposti a rendering, con valori trasmessi

    Cloud Run

    Un manifest sottoposto a rendering specifico per la destinazione, con 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 pipeline di distribuzione, target multipli, destinazioni figlio, release e implementazioni:

    gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
    
  3. Eliminare i bucket Cloud Storage creati da Cloud Deploy.

    Una termina con _clouddeploy e l'altra è [region].deploy-artifacts.[project].appspot.com.

    Apri la pagina del browser di Cloud Storage

È tutto, hai completato questa guida rapida.

Passaggi successivi