Utiliser des paramètres de déploiement

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

   Il s'agit d'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.

   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 fichier 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 permet de déployer l'application. L'image de conteneur à déployer est définie ici comme un 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 diffusion et vos cibles

Vous pouvez définir votre pipeline et vos cibles dans un même 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 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"
         # 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 désormais d'un pipeline, avec une multicible comprenant deux cibles GKE ou Cloud Run, prêt à déployer 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'une seule cible est listée dans la colonne Cibles, même si vous avez configuré trois cibles (un groupe multicible et deux cibles enfants) dans votre fichier clouddeploy.yaml.

   

   Notez que la seule cible listée est la cible 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 diffusion 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.

 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"

 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 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 multicible. rollout est donc un "déploiement du contrôleur" pour deux cibles enfants, et il n'y a pas de cibles ultérieures dans le pipeline de diffusion. 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, et que le déploiement du contrôleur et des déploiements enfants sont créés, ces déploiements enfants sont maintenant 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 diffusion de Cloud Deploy pour afficher votre pipeline de diffusion 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. Comme il n'y a qu'une seule étape dans le pipeline, la visualisation n'affiche 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 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

   

   Cloud Run

   

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

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 affichés des deux cibles, y compris les valeurs que vous avez spécifiées:

   GKE

   

   Cloud Run