Utiliser des paramètres de déploiement

Cette page vous explique comment utiliser Cloud Deploy pour déployer un exemple d'application sur deux cibles en même temps (un déploiement parallèle), tout en transmettant une valeur de paramètre différente à chaque définition de service ou fichier manifeste rendu, à l'aide de trois méthodes différentes.

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

  1. Créez deux clusters GKE ou deux services Cloud Run.

    Vous pouvez également utiliser des clusters GKE associés, mais ce guide de démarrage rapide n'utilise que GKE et Cloud Run.

  2. Créez une configuration Skaffold et un fichier manifeste Kubernetes ou une définition de service Cloud Run.

    Le fichier manifeste ou la définition de service seront identiques pour les deux cibles enfants, mais au moment du déploiement, le fichier manifeste ou la définition de service rendus pour chaque cible enfant auront des valeurs différentes pour les paramètres spécifiques configurés dans ce guide de démarrage rapide.

  3. Définissez votre pipeline de diffusion Cloud Deploy et vos cibles de déploiement.

    Ce pipeline comportera une cible multicible faisant référence à deux cibles enfants pour diffuser votre application dans les deux clusters ou les deux services.

  4. Vous pouvez définir les paramètres de déploiement à trois endroits différents :

    • Progression dans le pipeline
    • Sur les cibles enfants
    • Sur la ligne de commande, lors de la création de la version

  5. Instancier votre pipeline de diffusion en créant une version qui est automatiquement déployée sur les deux cibles en parallèle.

  6. Affichez le déploiement du contrôleur et les déploiements enfants dans la console Google Cloud .

Avant de commencer

  1. 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 sans frais pour exécuter, tester et déployer des charges de travail.

  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. Verify that billing is enabled for your Google Cloud project.

  4. 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

  5. Installez la Google Cloud CLI.

  6. Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

  7. Pour initialiser la gcloud CLI, exécutez la commande suivante : 

    gcloud init

  8. 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

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

  10. 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

  11. Installez la Google Cloud CLI.

  12. Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

  13. Pour initialiser la gcloud CLI, exécutez la commande suivante : 

    gcloud init

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

    gcloud components update

  14. 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 concernent les projets qui désactivent les attributions automatiques de rôles pour les comptes de service par défaut.

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

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

    3. Ajoutez le rôle iam.serviceAccountUser, qui inclut l'autorisation actAs pour le déploiement 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

Créer vos environnements d'exécution

Si vous déployez sur Cloud Run, vous pouvez ignorer cette commande.

Pour GKE, créez deux clusters : deploy-params-cluster-prod1 et deploy-params-cluster-prod2, avec les paramètres par défaut. Les points de terminaison de l'API Kubernetes des clusters doivent être accessibles sur le réseau Internet public. Les clusters GKE sont accessibles en externe par défaut.

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

Préparer votre configuration et vos fichiers manifestes Skaffold

Cloud Deploy utilise Skaffold pour fournir les détails de ce que vous devez déployer et de la manière de le 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 Kubernetes ou la définition de service Cloud Run à utiliser pour déployer l'application exemple.

  1. Ouvrez une fenêtre de terminal.

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

    GKE 

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

    Cloud Run 

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

  3. Créez un fichier nommé skaffold.yaml avec le contenu suivant :

    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: {}

    Ce fichier est une configuration Skaffold minimale. Pour ce guide de démarrage rapide, vous allez créer le fichier. Toutefois, vous pouvez également demander à Cloud Deploy de le créer pour vous, pour les applications simples et non destinées à la production.

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

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

    GKE

    Créez un fichier nommé kubernetes.yaml avec le contenu suivant :

    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}

    Ce fichier est un manifeste Kubernetes, qui est appliqué au cluster pour déployer l'application. L'image de conteneur à déployer est définie ici comme espace réservé, my-app-image, qui est remplacé par l'image spécifique lorsque vous créez la version.

    Cloud Run

    Créez un fichier nommé service.yaml avec le contenu suivant :

    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}

    Ce fichier est une définition de service Cloud Run de base, qui est utilisée pour déployer l'application. L'image de conteneur à déployer est définie ici comme espace réservé, my-app-image, qui est remplacé par l'image spécifique lorsque vous créez la version.

Créer votre pipeline de livraison et vos cibles

Vous pouvez définir votre pipeline et vos cibles dans un seul fichier ou dans des fichiers distincts. Dans ce guide de démarrage rapide, nous allons créer un seul fichier.

  1. Créez votre pipeline de livraison et la définition de la cible :

    GKE

    Dans le répertoire deploy-params-gke-quickstart, créez un fichier nommé clouddeploy.yaml contenant les éléments suivants :

    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

    Dans le répertoire deploy-params-run-quickstart, créez un fichier nommé clouddeploy.yaml contenant les éléments suivants :

    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. Enregistrez votre pipeline et vos cibles auprès du service Cloud Deploy :

    gcloud deploy apply --file=clouddeploy.yaml --region=us-central1 --project=PROJECT_ID

    Vous disposez maintenant d'un pipeline avec une cible multiple comprenant deux cibles GKE ou Cloud Run, prêt à déployer votre application.

  3. 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 de vos pipelines de livraison disponibles.

    Ouvrir la page Pipelines de diffusion

    Le pipeline de livraison que vous venez de créer s'affiche. Notez qu'une seule cible est listée dans la colonne Cibles, alors que vous en avez configuré trois (une multicible et deux cibles enfants) dans votre fichier clouddeploy.yaml.

    Visualisation du pipeline de livraison dans la console Google Cloud

    Notez que la seule cible listée est la multicible params-prod-multi. Les cibles enfants ne sont pas affichées.

Créer une version

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

GKE

Exécutez la commande suivante à partir du répertoire deploy-gke-parallel-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-params-demo-app-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa \
   --deploy-parameters="git-sha=f787cac"

Notez le flag --images=, que vous utilisez pour remplacer l'espace réservé (my-app-image) dans le manifeste par l'image spécifique qualifiée par SHA. Google vous recommande de créer des modèles de vos fichiers manifestes de cette manière et d'utiliser des noms d'images qualifiés SHA lors de la création de la version.

Cloud Run

Exécutez la commande suivante à partir du répertoire deploy-run-parallel-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-params-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a \
   --deploy-parameters="git-sha=f787cac"

Notez l'option --images=, que vous utilisez pour remplacer l'espace réservé (my-app-image) dans la définition de service par l'image spécifique qualifiée par SHA. Google vous recommande de créer des modèles pour vos définitions de services et de jobs de cette manière, et d'utiliser des noms d'images qualifiés par SHA lors de la création de versions.

Comme toujours, lorsque vous créez une version, un déploiement est créé automatiquement pour la première cible de votre pipeline (sauf si une cible spécifique est spécifiée à l'aide de --to-target=). Dans ce guide de démarrage rapide, cette cible est une multicible. Par conséquent, rollout est un "déploiement de contrôleur" pour deux cibles enfants. Il n'y a pas d'autres cibles dans le pipeline de livraison. Cela signifie que votre application est déployée partout lors de la création du déploiement.

Afficher les résultats dans la console Google Cloud

Maintenant que vous avez créé la version, ainsi que les déploiements du contrôleur et des enfants, ces déploiements enfants sont désormais déployés (ou en cours de déploiement) sur leurs clusters GKE ou services Cloud Run respectifs.

  1. Dans la console Google Cloud , accédez à la page Pipelines de livraison de Cloud Deploy pour afficher votre pipeline de livraison my-parallel-demo-app-1.

    Ouvrir la page Pipelines de diffusion

  2. Cliquez sur le nom de votre pipeline de livraison "my-parallel-demo-app-1".

    La visualisation du pipeline indique l'état de déploiement de l'application. Comme il n'y a qu'une seule étape dans le pipeline, la visualisation n'affiche qu'un seul nœud.

    Visualisation du pipeline de diffusion dans la console Google Cloud

    Votre version est répertoriée dans l'onglet Versions sous Détails du pipeline de diffusion.

  3. Cliquez sur le nom de la version, test-release-001.

    Vos déploiements s'affichent sous Déploiements. Vous pouvez cliquer sur un déploiement pour afficher ses détails, y compris le journal de déploiement.

    Déploiements dans la console Google Cloud

  4. Sous Détails de la version, sélectionnez l'onglet Artifacts.

    Le tableau Déployer les paramètres liste tous les paramètres que vous avez configurés dans votre fichier manifeste et les valeurs que vous avez fournies pour ces paramètres :

    GKE

    Paramètres et valeurs de déploiement affichés dans la console Google Cloud

    Cloud Run

    Paramètres et valeurs de déploiement affichés dans la console Google Cloud

    En plus des paramètres et des valeurs, le tableau indique à quelle cible s'applique chaque paramètre.

  5. Dans la colonne Outil d'inspection de versions, cliquez sur Afficher les artefacts pour l'une des cibles.

  6. Cliquez sur Afficher la différence, puis sélectionnez params-prod-a pour une cible et params-prod-b pour l'autre.

    Une comparaison s'affiche, comparant les fichiers manifestes rendus des deux cibles, y compris les valeurs que vous avez spécifiées :

    GKE

    Différence entre les fichiers manifeste affichés et les valeurs transmises

    Cloud Run

    Fichier manifeste rendu spécifique à la cible, avec les valeurs transmises

Effectuer un nettoyage

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

  1. Supprimez les clusters GKE ou les services 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. Supprimez le pipeline de livraison, le groupe multicible, les cibles enfants, la version et les déploiements :

    gcloud deploy delete --file=clouddeploy.yaml --force --region=us-central1 --project=PROJECT_ID

  3. Supprimez les buckets Cloud Storage créés par Cloud Deploy.

    L'un se termine par _clouddeploy et l'autre est [region].deploy-artifacts.[project].appspot.com.

    uvrez la page du navigateur Cloud Storage

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

Étapes suivantes