Utiliser des paramètres de déploiement

Utiliser des paramètres de déploiement

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

Dans ce guide de démarrage rapide, vous allez :

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

   Vous pouvez également utiliser des clusters GKE Enterprise, mais ce guide de démarrage rapide utilise GKE et Cloud Run uniquement.

2. Créer une configuration Skaffold, puis un cluster Kubernetes un fichier manifeste ou une définition de service Cloud Run.

   Le fichier manifeste ou la définition de service sera le même pour les deux cibles enfants, mais au moment du déploiement, le fichier manifeste ou la définition de service affichée pour chaque cible enfant aura 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 comporte une multicible, qui fait référence à deux cibles enfants, pour diffuser votre application dans les deux clusters ou les deux services.

4. Définissez les paramètres de déploiement dans trois lieux:

   • Dans la progression du 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. Afficher le déploiement du contrôleur et les déploiements enfants dans la console Google Cloud.

Avant de commencer

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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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

   Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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

    Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

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

gcloud components update

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

    Le compte de service dispose peut-être déjà des autorisations nécessaires. Ces étapes sont inclus pour les projets qui désactivent l'attribution automatique de rôles pour le service par défaut Google Cloud.

    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)")[e-mail] \
           --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)")[e-mail] \
          --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)")[e-mail] \
          --role="roles/run.developer"
      

    3. Ajoutez le rôle iam.serviceAccountUser, qui inclut l'autorisation actAs 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)")[e-mail] \
           --member=serviceAccount:$(gcloud projects describe PROJECT_ID \
           --format="value(projectNumber)")[e-mail] \
           --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 à partir de l'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 Skaffold et vos fichiers manifestes

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 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. Vous pouvez également laisser Cloud Deploy en créer une pour vous pour les applications simples hors production.

   Consultez la documentation de référence sur skaffold.yaml. pour en savoir plus sur ce fichier.

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 fichier manifeste Kubernetes simple, qui est appliqué au cluster pour déployer l'application.

   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 simple de service Cloud Run, utilisé au moment du déploiement pour créer Google Cloud.

Remarque :Si vous souhaitez utiliser différents fichiers manifestes par cible, consultez cet article sur la gestion des fichiers manifestes pour en savoir plus sur l'utilisation des profils Skaffold.

Créer votre pipeline de diffusion et vos cibles

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

1. Créez votre pipeline de diffusion et votre définition de 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"
         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
   

   Remarque : Dans ce fichier, les cibles sont incluses dans le pipeline de diffusion, mais vous pouvez les définir dans un ou plusieurs fichiers distincts.

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

   Remarque : Dans ce fichier, les cibles sont incluses dans le pipeline de diffusion, mais vous pouvez les définir dans un ou plusieurs fichiers distincts.

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 à présent d'un pipeline avec une cible multicible comprenant deux Cibles GKE ou Cloud Run, prêtes à être déployées votre application.

3. Vérifiez votre pipeline et vos cibles :

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

   Ouvrir la page Pipelines de diffusion

   Le pipeline de diffusion que vous venez de créer s'affiche. Notez qu'il y a un bouton dans la colonne Cibles, même si vous avez configuré trois cibles cibles (une cible multicible et deux cibles enfants) dans votre clouddeploy.yaml .

   

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

Créer une version

Une version est la ressource Cloud Deploy centrale qui représente des modifications en cours de déploiement. Le pipeline de livraison définit le cycle de vie de sortie. Voir Architecture du service Cloud Deploy pour en savoir plus sur ce cycle de vie.

GKE

Exécutez la commande suivante à partir de deploy-gke-parallel-quickstart. pour créer une ressource release qui représente le 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"

Cloud Run

Exécutez la commande suivante à partir de deploy-run-parallel-quickstart. pour créer une ressource release qui représente le 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:4a856b6f1c3ce723a456ddc2adfbb794cbfba93f727e2d96fcf6540bd0d6fff4 \
   --deploy-parameters="git-sha=f787cac"

Comme toujours, lorsque vous créez une version, un déploiement est automatiquement créé pour le première cible de votre pipeline (sauf si une cible spécifique est spécifiée via --to-target=). Dans ce guide de démarrage rapide, cette cible est multicible. rollout est un "déploiement du contrôleur" pour deux cibles enfants et aucune cible ultérieure dans le pipeline de livraison. Cela signifie que votre application est déployée partout dès sa création.

Afficher les résultats dans la console Google Cloud

Maintenant que vous avez créé la version, le déploiement du contrôleur et la version enfant sont créés, les déploiements enfants sont maintenant déployés (ou se trouvent dans processus de déploiement) vers leurs clusters GKE respectifs. ou Cloud Run.

1. Dans la console Google Cloud, accédez à Cloud Deploy Pipelines de livraison 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 diffusion "my-parallel-demo-app-1".

   La visualisation du pipeline indique l'état de déploiement de l'application. Parce qu’il y a une seule étape du pipeline, la visualisation ne montre qu'un seul nœud.

   

   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.

   

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

   Le tableau Paramètres de déploiement répertorie 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

   

   Cloud Run

   

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

5. Dans la colonne Inspecteur de versions, cliquez sur Afficher les artefacts pour cible.

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

   Une différence s'affiche, comparant les fichiers manifestes affichés des deux cibles. y compris les valeurs que vous avez spécifiées:

   GKE

   

   Cloud Run

   

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 :

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. supprimer le pipeline de livraison, les cibles multiples, les cibles enfants, la version et 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 par [region].deploy-artifacts.[project].appspot.com.

   uvrez la page du navigateur Cloud Storage

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

Étape suivante

• En savoir plus sur l'utilisation des paramètres de déploiement

• Découvrez comment déployer des applications sur plusieurs cibles à la fois.

• En savoir plus sur Cloud Deploy

• Découvrez les principes de base du déploiement d'applications.

• Suivez le tutoriel Cloud Deploy.

• Découvrez comment gérer vos fichiers manifestes.

• Découvrez comment combiner les outils CI/CD Google Cloud pour développer et déployer efficacement des logiciels sur GKE.