Utiliser des paramètres de déploiement

Utiliser des paramètres de déploiement

Cette page explique comment utiliser Cloud Deploy pour diffuser un exemple d'application vers deux cibles en même temps (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 effectuer les opérations suivantes:

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

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

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

   La définition du fichier manifeste ou du service sera identique pour les deux cibles enfants, mais au moment du déploiement, le fichier manifeste affiché ou la définition du service 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éfinir votre pipeline de livraison Cloud Deploy et vos cibles de déploiement

   Ce pipeline comportera un multi-target, qui fait référence à deux cibles enfants, pour diffuser votre application sur les deux clusters ou les deux services.

4. Définissez les paramètres de déploiement à trois emplacements différents:

   • Dans la progression du pipeline
   • Sur les cibles enfants
   • Sur la ligne de commande, lors de la création de la version

5. Instanciez votre pipeline de livraison en créant une version qui se déploie automatiquement 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 gratuits pour exécuter, tester et déployer des charges de travail.

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

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

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

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

   Activer les API

5. Installez Google Cloud CLI.

6. Pour initialiser gcloudCLI, exécutez la commande suivante :

   gcloud init

   Remarque : Vous pouvez exécuter gcloud CLI dans la console Google Cloud sans installer Google Cloud CLI. Pour exécuter gcloud CLI dans la console Google Cloud, utilisez Cloud Shell.

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

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

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

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

   Activer les API

10. Installez Google Cloud CLI.

11. Pour initialiser gcloudCLI, exécutez la commande suivante :

    gcloud init

    Remarque : Vous pouvez exécuter gcloud CLI dans la console Google Cloud sans installer Google Cloud CLI. Pour exécuter gcloud CLI dans la console Google Cloud, utilisez Cloud Shell.

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

gcloud components update

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

    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 permettant 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 effectuez le déploiement 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 via le réseau depuis l'Internet public. Par défaut, les clusters GKE sont accessibles en externe.

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 la configuration et les fichiers manifestes Skaffold

Cloud Deploy utilise Skaffold pour fournir les détails des éléments à déployer et comment 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 Kubernetes ou la définition du service Cloud Run à utiliser pour déployer l'exemple d'application.

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

4. Créez la définition de votre application, à savoir 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 de service Cloud Run simple, utilisée au moment du déploiement pour créer votre service Cloud Run.

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 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 créons un seul fichier.

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

   GKE

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

   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 livraison, 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 clouddeploy.yaml avec le contenu suivant :

   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 livraison, mais vous pouvez les définir dans un ou plusieurs fichiers distincts.

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

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 des 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 cible est répertoriée dans la colonne Cibles, même si vous avez configuré trois cibles (une cible multicible et deux cibles enfants) dans le fichier clouddeploy.yaml.

   

   Notez que la seule cible répertoriée est le params-prod-multi multicible. 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 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-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"

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:6063adf8f687702b4065151acddba6781c47bc602167eb9f3bec8aebc9ce95cc \
   --deploy-parameters="git-sha=f787cac"

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

Afficher les résultats dans la console Google Cloud

Maintenant que vous avez créé la version, et que les déploiements du contrôleur et les déploiements enfants ont été créés, ces déploiements enfants sont déployés (ou sont en cours de déploiement) dans 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 montre l'état du déploiement de l'application. Étant donné qu'il n'y a qu'une seule étape dans le 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.

   Les 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 Release details (Détails de la release), sélectionnez l'onglet Artefacts.

   Le tableau Deploy parameters (Paramètres de déploiement) répertorie tous les paramètres que vous avez configurés dans le 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 paramètre s'applique.

5. Dans la colonne Release Inspector (Outil d'inspection des versions), cliquez sur View artefacts (Afficher les artefacts) pour l'une des cibles.

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

   Un diff 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. Supprimez le pipeline de livraison, les cibles multicibles, 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'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.

Étapes suivantes

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

• En savoir plus sur le déploiement simultané sur plusieurs cibles

• 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 livrer efficacement des logiciels dans GKE.