Automatiser la promotion des versions et l'avancement du déploiement dans Cloud Deploy

Cette page explique comment utiliser Cloud Deploy pour promouvoir automatiquement une version sur une cible et faire passer un déploiement à la phase suivante.

Dans ce guide de démarrage rapide, vous allez effectuer les opérations suivantes:

Créer deux clusters GKE ou deux services Cloud Run
Créez une configuration Skaffold ainsi qu'un fichier manifeste Kubernetes ou une définition de service Cloud Run.
Définir votre pipeline de livraison Cloud Deploy et vos cibles de déploiement

Le pipeline sera déployé sur deux cibles: dev et staging. Enfin, la cible staging utilise une stratégie de déploiement Canary.
Définissez deux règles d'automatisation:
- Une automatisation pour promouvoir la version dans la cible staging lors d'un déploiement réussi vers dev.
- Automatisation pour faire passer le déploiement à la phase stable une fois la phase canary-25 terminée avec succès.
Instanciez votre pipeline de livraison en créant une version, qui se déploie automatiquement sur la cible dev.
Afficher le pipeline de livraison et sa version dans la console Google Cloud

En raison de la promotion automatique, cette version est automatiquement promue dans staging.

Étant donné que la cible staging utilise une stratégie de déploiement Canary et qu'il s'agit du premier déploiement dans cet environnement d'exécution, la phase canary-25 est ignorée. Consultez la section Pourquoi des phases sont parfois ignorées pour en savoir plus sur les raisons pour lesquelles la phase Canary est ignorée la première fois.

En raison de l'avance automatique de la phase automatisée, le déploiement passe à la phase stable.

Avant de commencer

Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

Accéder au sélecteur de projet

Vérifiez que la facturation est activée pour votre projet Google Cloud.

Activer les API Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.

Activer les API

Installez Google Cloud CLI.

Pour initialiser gcloudCLI, exécutez la commande suivante :

gcloud init

Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

Accéder au sélecteur de projet

Vérifiez que la facturation est activée pour votre projet Google Cloud.

Activer les API Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage.

Activer les API

Installez Google Cloud CLI.

Pour initialiser gcloudCLI, exécutez la commande suivante :

gcloud init

Si la CLI est déjà installée, assurez-vous d'utiliser la dernière version:

gcloud components update

Assurez-vous que le compte de service Compute Engine par défaut dispose des autorisations suffisantes.

Le compte de service dispose peut-être déjà des autorisations nécessaires. Ces étapes sont incluses pour les projets qui désactivent les attributions automatiques de rôles pour les comptes de service par défaut.

Commencez par ajouter le rôle 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"

Ajoutez le rôle clouddeploy.releaser:

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.releaser"

Ajoutez le rôle de développeur pour votre environnement d'exécution spécifique.

Pour 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"

Pour 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"

Ajoutez le rôle iam.serviceAccountUser, qui inclut l'autorisation actAs permettant au compte de service par défaut de déployer dans l'environnement d'exécution:

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

Ajoutez le rôle iam.serviceAccountUser, y compris l'autorisation actAs, pour utiliser le compte de service par défaut:

gcloud iam service-accounts add-iam-policy-binding $(gcloud projects describe PROJECT_ID \
    --format="value(projectNumber)")-compute@developer.gserviceaccount.com \
    --member=user:YOUR_EMAIL_ADDRESS \
    --role="roles/iam.serviceAccountUser" \
    --project=PROJECT_ID

Dans ce cas, YOUR_EMAIL_ADDRESS est l'adresse e-mail que vous utilisez pour accéder à Google Cloud.

Créer vos environnements d'exécution

Si vous effectuez le déploiement sur Cloud Run, vous pouvez ignorer cette commande.

Pour GKE, créez deux clusters: automation-quickstart-cluster-dev et automation-quickstart-cluster-staging, avec les paramètres par défaut. Les points de terminaison de l'API Kubernetes des clusters doivent être accessibles via le réseau depuis l'Internet public. Par défaut, les clusters GKE sont accessibles en externe.

gcloud container clusters create-auto automation-quickstart-cluster-dev \
                 --project=PROJECT_ID \
                 --region=us-central1 \
                 && gcloud container clusters create-auto automation-quickstart-cluster-staging \
                 --project=PROJECT_ID \
                 --region=us-central1

Obtenez le numéro de votre projet.

Vous avez besoin de votre numéro de projet pour identifier le compte de service par défaut. Cela est nécessaire pour configurer la ressource d'automatisation.

Exécutez la commande suivante pour obtenir le numéro de votre projet:
```
gcloud projects describe PROJECT_ID
```
Copiez le numéro de projet indiqué dans le résultat de la ligne de commande et collez-le ici.

Vous n'avez pas besoin de l'exécuter en tant que commande. Si vous le collez ici, la référence du compte de service sera insérée dans la configuration d'automatisation plus loin dans ce guide de démarrage rapide.
```
PROJECT_NUMBER
```

Préparer la configuration Skaffold et le fichier manifeste de l'application

Cloud Deploy utilise Skaffold pour fournir des informations sur les éléments à déployer et sur la manière de les déployer correctement pour vos cibles distinctes.

Dans ce guide de démarrage rapide, vous allez créer un fichier skaffold.yaml qui identifie le fichier manifeste à utiliser pour déployer l'exemple d'application.

Ouvrez une fenêtre de terminal.

Créez un répertoire et accédez-y.

GKE

mkdir deploy-automation-gke-quickstart
cd deploy-automation-gke-quickstart

Cloud Run

mkdir deploy-automation-run-quickstart
cd deploy-automation-run-quickstart

Créez un fichier nommé skaffold.yaml avec le contenu suivant :
GKE
```
apiVersion: skaffold/v4beta7
kind: Config
metadata:
  name: gke-automation
manifests:
  rawYaml:
  - k8s-deployment.yaml
deploy:
  kubectl: {}
```
Cloud Run
```
apiVersion: skaffold/v4beta7
kind: Config
metadata:
  name: run-automation
profiles:
- name: dev
  manifests:
    rawYaml:
    - run-dev.yaml
- name: staging
  manifests:
    rawYaml:
    - run-staging.yaml
deploy:
  cloudrun: {}
```
Ce fichier est une configuration Skaffold minimale. Pour ce guide de démarrage rapide, vous allez créer le fichier. Mais vous pouvez également demander à Cloud Deploy d'en créer un pour vous, pour les applications simples hors production.

Pour en savoir plus sur ce fichier, consultez la documentation de référence sur skaffold.yaml.

Créez la définition de votre application : une paire de définitions de service pour Cloud Run ou un fichier manifeste Kubernetes pour GKE.

GKE

Créez un fichier nommé k8s-deployment.yaml avec le contenu suivant :

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-deployment
  labels:
    app: my-app
  namespace: default
spec:
  replicas: 1
  selector:
    matchLabels:
      app: my-app
  template:
    metadata:
      labels:
        app: my-app
    spec:
      containers:
      - name: nginx
        image: my-app-image
---
apiVersion: v1
kind: Service
metadata:
  name: my-service
  namespace: default
spec:
  selector:
    app: my-app
  ports:
    - protocol: TCP
      port: 80

Ce fichier est un fichier manifeste Kubernetes simple, qui est appliqué au cluster pour déployer l'application.

Cloud Run

Créez un fichier nommé run-dev.yaml avec le contenu suivant :

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

Créez un fichier nommé run-staging.yaml avec le contenu suivant :

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

Ce fichier est une définition de service Cloud Run simple, utilisée au moment du déploiement pour créer votre service Cloud Run.

Créer votre pipeline de livraison, vos cibles et votre automatisation

Vous pouvez définir votre pipeline de livraison et vos cibles dans un ou plusieurs fichiers distincts. Vous pouvez également définir une action d'automatisation dans un fichier distinct. Ce guide de démarrage rapide utilise un seul fichier pour le pipeline, les cibles et l'automatisation.

Créez le pipeline de livraison, les définitions des cibles et l'action d'automatisation:

GKE

Dans le répertoire deploy-automation-gke-quickstart, créez un fichier clouddeploy.yaml avec le contenu suivant :

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: my-automation-demo-app-1
description: Automation demonstration pipeline
serialPipeline:
  stages:
  - targetId: automation-quickstart-dev
  - targetId: automation-quickstart-staging
    profiles: []
    strategy:
      canary:
        runtimeConfig:
          kubernetes:
            serviceNetworking:
              service: "my-service"
              deployment: "my-deployment"
        canaryDeployment:
          percentages: [25]
          verify: false
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: automation-quickstart-dev
description: Dev cluster to demonstrate deploy automation
gke:
  cluster: projects/PROJECT_ID/locations/us-central1/clusters/automation-quickstart-cluster-dev
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: automation-quickstart-staging
description: Staging cluster to demonstrate deploy automation
gke:
  cluster: projects/PROJECT_ID/locations/us-central1/clusters/automation-quickstart-cluster-staging
---

apiVersion: deploy.cloud.google.com/v1
kind: Automation
metadata:
  name: my-automation-demo-app-1/promote
description: promotes a release
suspended: false
serviceAccount: PROJECT_NUMBER-compute@developer.gserviceaccount.com
selector:
- targets:
    id: automation-quickstart-dev
rules:
- promoteReleaseRule:
    name: "promote-release"
    wait: 1m
    toTargetId: "@next"
---

apiVersion: deploy.cloud.google.com/v1
kind: Automation
metadata:
  name: my-automation-demo-app-1/advance
description: advances a rollout
suspended: false
serviceAccount: PROJECT_NUMBER-compute@developer.gserviceaccount.com
selector:
- targets:
    id: automation-quickstart-staging
rules:
- advanceRolloutRule:
    name: "advance-rollout"
    sourcePhases: ["canary-25"]
    wait: 1m

Cloud Run

Dans le répertoire deploy-automation-run-quickstart, créez un fichier clouddeploy.yaml avec le contenu suivant :

apiVersion: deploy.cloud.google.com/v1
kind: DeliveryPipeline
metadata:
  name: my-automation-demo-app-1
description: Automation demonstration pipeline
serialPipeline:
  stages:
  - targetId: automation-quickstart-dev
    profiles: [dev]
  - targetId: automation-quickstart-staging
    profiles: [staging]
    strategy:
      canary:
        runtimeConfig:
          cloudRun:
            automaticTrafficControl: true
        canaryDeployment:
          percentages: [25]
          verify: false
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: automation-quickstart-dev
description: Dev cluster to demonstrate deploy automation
run:
  location: projects/PROJECT_ID/locations/us-central1
---

apiVersion: deploy.cloud.google.com/v1
kind: Target
metadata:
  name: automation-quickstart-staging
description: Staging cluster to demonstrate deploy automation
run:
  location: projects/PROJECT_ID/locations/us-central1
---

apiVersion: deploy.cloud.google.com/v1
kind: Automation
metadata:
  name: my-automation-demo-app-1/promote
description: Promotes a release to the next target
suspended: false
serviceAccount: PROJECT_NUMBER-compute@developer.gserviceaccount.com
selector:
- targets:
    id: automation-quickstart-dev
rules:
- promoteReleaseRule:
    name: "promote-release"
    wait: 1m
    toTargetId: "@next"
---

apiVersion: deploy.cloud.google.com/v1
kind: Automation
metadata:
  name: my-automation-demo-app-1/advance
description: advances a rollout
suspended: false
serviceAccount: PROJECT_NUMBER-compute@developer.gserviceaccount.com
selector:
- targets:
    id: automation-quickstart-staging
rules:
- advanceRolloutRule:
    name: "advance-rollout"
    sourcePhases: ["canary-25"]
    wait: 1m

Enregistrez votre pipeline et vos cibles avec le service Cloud Deploy:
```
gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID
```
Vous disposez maintenant d'un pipeline avec un groupe multicible comprenant deux cibles GKE ou Cloud Run, prêt à déployer votre application.
Confirmez votre pipeline et vos cibles:

Dans la console Google Cloud, accédez à la page Pipelines de livraison de Cloud Deploy pour afficher la liste des pipelines de livraison disponibles.

Ouvrir la page Pipelines de diffusion

Le pipeline de livraison que vous venez de créer s'affiche, avec deux cibles répertoriées dans la colonne Cibles.
Cliquez sur le nom du pipeline pour ouvrir la visualisation et les détails du pipeline de livraison.
Sélectionnez l'onglet Automatisations sous Informations sur le pipeline de livraison.

Les deux automatisations que vous avez créées s'affichent.

Créer une version

Une version est la ressource Cloud Deploy centrale qui représente les modifications en cours de déploiement. Le pipeline de livraison définit le cycle de vie de cette version. Pour en savoir plus sur ce cycle de vie, consultez la section Architecture du service Cloud Deploy.

GKE

Exécutez la commande suivante à partir du répertoire deploy-automation-gke-quickstart pour créer une ressource release qui représente l'image de conteneur à déployer:

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-automation-demo-app-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa

Cloud Run

Exécutez la commande suivante à partir du répertoire deploy-automation-run-quickstart pour créer une ressource release qui représente l'image de conteneur à déployer:

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

Par défaut, lorsque vous créez une version, un déploiement est créé automatiquement pour la première cible de votre pipeline.

Étant donné que ce guide de démarrage rapide inclut deux automatisations, deux choses se produisent automatiquement:

Après un déploiement réussi dans la première cible, la version est automatiquement promue à la deuxième cible.

Un temps d'attente d'une minute est nécessaire pour l'automatisation de la promotion.
Dans la deuxième cible, où une version Canary de 25% est configurée, la deuxième automatisation fait passer le déploiement de canary-25 à stable.

Pour cette première version, la phase canary-25 est ignorée, car il n'existe pas de version préexistante de l'application pour la version Canary. Et le déploiement est automatiquement avancé à stable.

L'automatisation avancée est retardée d'une minute.

Une fois l'opération terminée, l'application est déployée sur les deux cibles sans que vous ayez à faire quoi que ce soit.

Si vous souhaitez en savoir plus sur l'exécution d'une stratégie de déploiement Canary, consultez le guide de démarrage rapide de Canary.

Afficher les résultats dans la console Google Cloud

Vous pouvez consulter les résultats, y compris les exécutions d'automatisation, dans la console Google Cloud.

Accédez à la page Pipelines de livraison de Cloud Deploy pour afficher votre pipeline de livraison.

Ouvrir la page Pipelines de diffusion
Cliquez sur le nom de votre pipeline de livraison "my-automation-demo-app-1".

La visualisation du pipeline montre l'état du déploiement de l'application. Si suffisamment de temps s'est écoulé, les deux cibles apparaissent en vert.

Votre version est répertoriée dans l'onglet Versions sous Détails du pipeline de diffusion.
Cliquez sur l'onglet Exécutions d'automatisation.

Il existe deux entrées, une pour chacune des deux automatisations que vous avez créées. Vous pouvez cliquer sur l'une ou l'autre pour afficher les détails de cette exécution.

Effectuer un nettoyage

Pour éviter que les ressources utilisées sur cette page soient facturées sur votre compte Google Cloud, procédez comme suit :

Supprimez les clusters GKE ou les services Cloud Run:

GKE

gcloud container clusters delete automation-quickstart-cluster-dev --region=us-central1 --project=PROJECT_ID \
&& gcloud container clusters delete automation-quickstart-cluster-staging --region=us-west1 --project=PROJECT_ID

Cloud Run

gcloud run services delete my-automation-run-service-dev --region=us-central1 --project=PROJECT_ID \
&& gcloud run services delete my-automation-run-service-staging --region=us-central1 --project=PROJECT_ID

Supprimez le pipeline de livraison, les cibles, les automatisations, la version et les déploiements:
```
gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID
```
Supprimez les buckets Cloud Storage créés par Cloud Deploy.

L'une se termine par _clouddeploy, l'autre se termine par [region].deploy-artifacts.[project].appspot.com.

uvrez la page du navigateur Cloud Storage

Voilà ! Vous avez terminé le guide de démarrage rapide.

Automatiser la promotion des versions et l'avancement du déploiement dans Cloud Deploy

Avant de commencer

Créer vos environnements d'exécution

Obtenez le numéro de votre projet.

Préparer la configuration Skaffold et le fichier manifeste de l'application

GKE

Cloud Run

GKE

Cloud Run

GKE

Cloud Run

Créer votre pipeline de livraison, vos cibles et votre automatisation

GKE

Cloud Run

Créer une version

GKE

Cloud Run

Afficher les résultats dans la console Google Cloud

Effectuer un nettoyage

GKE

Cloud Run

Étapes suivantes