Esegui il deployment di un'app in Cloud Run utilizzando Cloud Deploy

Questa pagina mostra come utilizzare Cloud Deploy per distribuire un'immagine di un'applicazione di esempio denominata hello a una sequenza di due servizi Cloud Run, due job Cloud Run o due pool di worker Cloud Run. (I pool di worker Cloud Run sono in anteprima).

In questa guida rapida imparerai a:

  1. Creare una configurazione Skaffold

  2. Creare file di configurazione per due servizi Cloud Run, due job o due pool di worker.

    Questi file definiscono i servizi o i job e specificano le immagini container (precompilate) di cui eseguire il deployment.

  3. Definire la pipeline di distribuzione e i target di deployment di Cloud Deploy, che puntano ai due servizi, ai due job o ai due pool di worker.

  4. Creare un'istanza della pipeline di distribuzione creando una release, che viene eseguita automaticamente nel primo target.

  5. Promuovere la release nel secondo target.

  6. Visualizzare entrambi i rollout nella Google Cloud console.

Prima di iniziare

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

    Go to project selector

  3. If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

  4. Verify that billing is enabled for your Google Cloud project.

  5. Enable the Cloud Deploy, Cloud Build, 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

  6. Installa Google Cloud CLI.

  7. Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

  8. Per inizializzare gcloud CLI, esegui questo comando:

    gcloud init
  9. 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.

    Go to project selector

  10. If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

  11. Verify that billing is enabled for your Google Cloud project.

  12. Enable the Cloud Deploy, Cloud Build, 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

  13. Installa Google Cloud CLI.

  14. Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

  15. Per inizializzare gcloud CLI, esegui questo comando:

    gcloud init

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per creare una pipeline di distribuzione e una release di Cloud Deploy, chiedi all'amministratore di concederti il ruolo IAM Cloud Deploy Job Runner (roles/clouddeploy.jobrunner) nel progetto.

Per assicurarti che il account di servizio Cloud Deploy disponga delle autorizzazioni necessarie per eseguire le operazioni di Cloud Deploy ed eseguire il deployment in Cloud Run, chiedi all'amministratore di concedere i seguenti ruoli IAM al account di servizio Cloud Deploy nel tuo progetto:

Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

L'amministratore potrebbe anche assegnare al account di servizio Cloud Deploy le autorizzazioni richieste tramite ruoli personalizzati o altri ruoli predefiniti.

Prepara la configurazione di Skaffold

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

Per questa guida rapida, crea un file skaffold.yaml che identifica la definizione del servizio o del job Cloud Run da utilizzare per il deployment dell'app di esempio.

  1. Apri una finestra del terminale.

  2. Crea una nuova directory denominata deploy-run-quickstart e accedi alla directory.

    mkdir deploy-run-quickstart
    cd deploy-run-quickstart
    
  3. Crea un file denominato skaffold.yaml con il seguente contenuto:

    Servizi

    apiVersion: skaffold/v4beta7
    kind: Config
    metadata: 
      name: deploy-run-quickstart
    profiles:
    - name: dev
      manifests:
        rawYaml:
        - run-service-dev.yaml
    - name: prod
      manifests:
        rawYaml:
        - run-service-prod.yaml
    deploy:
      cloudrun: {}
    

    Job

    apiVersion: skaffold/v4beta7
    kind: Config
    metadata: 
      name: deploy-run-quickstart
    profiles:
    - name: dev
      manifests:
        rawYaml:
        - run-job-dev.yaml
    - name: prod
      manifests:
        rawYaml:
        - run-job-prod.yaml
    deploy:
      cloudrun: {}
    

    Pool di worker (anteprima)

    apiVersion: skaffold/v4beta7
    kind: Config
    metadata:
      name: deploy-run-quickstart
    profiles:
    - name: dev
      manifests:
        rawYaml:
        - run-worker-pool-dev.yaml
    - name: prod
      manifests:
        rawYaml:
        - run-worker-pool-prod.yaml
    deploy:
      cloudrun: {}
    

    Questo file è una configurazione Skaffold minima che identifica i servizi, i job o i pool di worker Cloud Run. Per ulteriori informazioni su questo file, consulta il skaffold.yaml riferimento.

Prepara i servizi, i job o i pool di worker Cloud Run

Per questa guida rapida, creerai due servizi Cloud Run, due job Cloud Run o due pool di worker Cloud Run diversi nello stesso progetto. Cloud Deploy supporta anche il deployment in più progetti. Inoltre, utilizziamo i profili Skaffold per consentire di avere due servizi, job o pool di worker nello stesso progetto. Quando utilizzi progetti diversi, potresti non dover utilizzare i profili Skaffold.

Servizi

  1. Crea un file denominato run-service-dev.yaml con il seguente contenuto:

    apiVersion: serving.knative.dev/v1
    kind: Service
    metadata:
      name: deploy-run-service-dev
    spec:
      template:
        spec:
          containers:
          - image: my-app-image
    

    Questo file definisce un servizio Cloud Run. Come suggerisce il nome deploy-run-service-dev, questo è il tuo servizio dev e corrisponde al primo target nella progressione della pipeline di distribuzione.

  2. Crea un file denominato run-service-prod.yaml con il seguente contenuto:

    apiVersion: serving.knative.dev/v1
    kind: Service
    metadata:
      name: deploy-run-service-prod
    spec:
      template:
        spec:
          containers:
          - image: my-app-image
    

    Questo file definisce un altro servizio Cloud Run e, come suggerisce il nome deploy-run-service-prod questo è il tuo servizio prod e corrisponde al secondo target nella progressione della pipeline di distribuzione.

Questi file sono definizioni di servizi Cloud Run, utilizzate per 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.

Job

  1. Crea un file denominato run-job-dev.yaml con il seguente contenuto:

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: deploy-run-job-dev
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - image: my-app-image
    

    Questo file definisce un job Cloud Run. Come suggerisce il nome deploy-run-job-dev, questo è il tuo job dev e corrisponde a il primo target nella progressione della pipeline di distribuzione.

  2. Crea un file denominato run-job-prod.yaml con il seguente contenuto:

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      name: deploy-run-job-prod
    spec:
      template:
        spec:
          template:
            spec:
              containers:
              - image: my-app-image
    

    Questo file definisce un altro job Cloud Run. Come suggerisce il nome deploy-run-job-prod, questo è il tuo job prod e corrisponde al secondo target nella progressione della pipeline di distribuzione.

Questi file sono definizioni di job Cloud Run, utilizzate per 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.

Pool di worker (anteprima)

  1. Crea un file denominato run-worker-pool-dev.yaml con il seguente contenuto:

    apiVersion: run.googleapis.com/v1
    kind: WorkerPool
    metadata:
      name: deploy-run-worker-pool-dev
      annotations:
        run.googleapis.com/launch-stage: BETA
    spec:
      template:
        spec:
          containers:
          - image: my-app-image
    

    Questo file definisce un pool di worker Cloud Run. Come suggerisce il nome deploy-run-worker-pool-dev, questo è il tuo pool di worker dev e corrisponde al primo target nella progressione della pipeline di distribuzione.

  2. Crea un file denominato run-worker-pool-prod.yaml con il seguente contenuto:

    apiVersion: run.googleapis.com/v1
    kind: WorkerPool
    metadata:
      name: deploy-run-worker-pool-prod
      annotations:
        run.googleapis.com/launch-stage: BETA
    spec:
      template:
        spec:
          containers:
          - image: my-app-image
    

    Questo file definisce un altro pool di worker Cloud Run. Come suggerisce il nome deploy-run-worker-pool-prod questo è il tuo prod pool di worker e corrisponde al secondo target nella progressione della pipeline di distribuzione.

Questi file sono definizioni di pool di worker Cloud Run, utilizzate per 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.

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, creerai un singolo file.

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

    apiVersion: deploy.cloud.google.com/v1
    kind: DeliveryPipeline
    metadata:
      name: my-run-demo-app-1
    description: main application pipeline
    serialPipeline:
      stages:
      - targetId: run-qsdev
        profiles: [dev]
      - targetId: run-qsprod
        profiles: [prod]
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: run-qsdev
    description: Cloud Run development service
    run:
      location: projects/PROJECT_ID/locations/us-central1
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: run-qsprod
    description: Cloud Run production 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, con i target, pronta per il deployment dell'applicazione nel primo target.

  3. Conferma la pipeline e i target:

    Nella Google Cloud console, 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 e i due target sono elencati nella colonna Target.

    Pipeline di distribuzione mostrata nella console Google Cloud

Crea una release

Una release è la risorsa Cloud Deploy centrale 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.

Esegui il comando seguente dalla directory deploy-run-quickstart per creare una risorsa release che rappresenta l'immagine container di cui eseguire il deployment:

Servizi

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-run-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

Job

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-run-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/job@sha256:8eb3f5e72586de6375abe95aa67511c57c61d35fb37d5670e4d68624a68ef916

Pool di worker (anteprima)

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-run-demo-app-1 \
   --skaffold-version=2.17.0 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a

Nota il --images= flag, che utilizzi per sostituire il segnaposto (my-app-image) nella definizione del servizio, del job o del pool di worker 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.

Il --skaffold-version= flag specifica la versione di Skaffold da utilizzare per il deployment. Per il supporto dei pool di worker Cloud Run, devi utilizzare la versione di Skaffold 2.17 o successive.

Come per tutte le release (a meno che non includano --disable-initial-rollout), Cloud Deploy crea automaticamente anche una risorsa di rollout. L'applicazione viene eseguita automaticamente nel primo target della progressione.

Promuovi la release

  1. Nella pagina Pipeline di distribuzione, fai clic sulla pipeline my-run-demo-app-1.

    Apri la pagina Pipeline di distribuzione

    La pagina dei dettagli della pipeline di distribuzione mostra una rappresentazione grafica dell'avanzamento della pipeline di distribuzione. In questo caso, mostra che la release è stata eseguita nel target run-qsdev.

    visualizzazione della pipeline di distribuzione nella console Google Cloud

  2. Nel primo target della visualizzazione della pipeline di distribuzione, fai clic su Promuovi.

    Viene visualizzata la finestra di dialogo Promuovi release. Mostra i dettagli del target a cui stai eseguendo la promozione.

  3. Fai clic su Promuovi.

    La release è ora in coda per il deployment in run-qsprod. Al termine del deployment, la visualizzazione della pipeline di distribuzione lo mostra come eseguito:

    Visualizzazione della pipeline di distribuzione nella console Google Cloud , che mostra la release di cui è stato eseguito il deployment in produzione.

Visualizza i risultati nella Google Cloud console

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

    Apri la pagina Pipeline di distribuzione

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

    La visualizzazione della pipeline mostra l'avanzamento dell'app nella pipeline.

    visualizzazione della pipeline di distribuzione nella console Google Cloud

    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.

    implementazioni nella console Google Cloud

Accedi al servizio Cloud Run

Per impostazione predefinita, devi essere autenticato per accedere ai servizi o ai pool di worker Cloud Run appena creati. Consulta la panoramica dell'autenticazione di Cloud Run per scoprire come fornire le credenziali e quali configurazioni di Identity and Access Management sono necessarie per accedere al servizio senza autenticazione. Questo non si applica ai job 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 il servizio, il job o il pool di worker Cloud Run deploy-qs-dev:

    Servizi

    gcloud run services delete deploy-run-service-dev --region=us-central1 --project=PROJECT_ID
    

    Job

    gcloud run jobs delete deploy-run-job-dev --region=us-central1 --project=PROJECT_ID
    

    Pool di worker (anteprima)

    gcloud beta run worker-pools delete deploy-run-worker-pool-dev --region=us-central1 --project=PROJECT_ID

  2. Elimina il servizio, il job o il pool di worker deploy-qs-prod:

    Servizi

    gcloud run services delete deploy-run-service-prod --region=us-central1 --project=PROJECT_ID
    

    Job

    gcloud run jobs delete deploy-run-job-prod --region=us-central1 --project=PROJECT_ID
    

    Pool di worker (anteprima)

    gcloud beta run worker-pools delete deploy-run-worker-pool-prod --region=us-central1 --project=PROJECT_ID
    
  3. Elimina la pipeline di distribuzione, i target, la release e i rollout:

    gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
    
  4. 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