Déployer une application sur plusieurs cibles à la fois

Cette page vous explique comment utiliser Cloud Deploy pour distribuer un exemple d'application à deux cibles en même temps, c'est-à-dire un déploiement parallèle.

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 effectuer des déploiements en parallèle sur des clusters GKE Enterprise, mais ce 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.

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

    Ce pipeline ne comportera qu'une seule cible, mais il s'agira d'une cible multiple, c'est-à-dire une cible qui représente plusieurs cibles de déploiement. Cette multicible comprendra deux cibles réelles, qui diffuseront votre application sur les deux clusters ou services.

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

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

    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. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  7. To initialize the gcloud CLI, run the following command:

    gcloud init
  8. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  9. Make sure that billing is enabled for your Google Cloud project.

  10. Enable the Cloud Deploy, Cloud Build, GKE, Cloud Run, and Cloud Storage APIs.

    Enable the APIs

  11. Install the Google Cloud CLI.

  12. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  13. To initialize the gcloud CLI, run the following command:

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

    gcloud components update
    

  15. 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 : quickstart-cluster-qsprod1 et quickstart-cluster-qsprod2, avec les paramètres par défaut. Les points de terminaison de l'API Kubernetes des clusters doivent être accessibles sur le réseau depuis l'Internet public. Les clusters GKE sont accessibles en externe par défaut.

    gcloud container clusters create-auto quickstart-cluster-qsprod1 \
                     --project=PROJECT_ID \
                     --region=us-central1 \
                     && gcloud container clusters create-auto quickstart-cluster-qsprod2 \
                     --project=PROJECT_ID \
                     --region=us-west1
    

Préparer votre configuration Skaffold et le fichier manifeste de votre application

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 de l'application à 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-gke-parallel-quickstart
    cd deploy-gke-parallel-quickstart
    

    Cloud Run

    mkdir deploy-run-parallel-quickstart
    cd deploy-run-parallel-quickstart
    
  3. Créez un fichier nommé skaffold.yaml avec le contenu suivant :

    GKE

    apiVersion: skaffold/v4beta1
    kind: Config
    manifests:
      rawYaml:
      - k8s-deployment.yaml
    deploy:
      kubectl: {}
    

    Cloud Run

    apiVersion: skaffold/v4beta1
    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é 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 # from-param: ${replicaCount}
      selector:
        matchLabels:
          app: my-app
      template:
        metadata:
          labels:
            app: my-app
        spec:
          containers:
          - name: nginx
            image: my-app-image
    

    Ce fichier est un simple 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:
      template:
        metadata:
          annotations:
            autoscaling.knative.dev/minScale: 1 # from-param: ${minInstances}
        spec:
          containers:
          - image: my-app-image
    

    Ce fichier est une définition de service Cloud Run simple, qui est utilisée au moment du déploiement pour créer votre service Cloud Run. L'image de conteneur à déployer est définie ici en tant qu'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, vous allez 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-gke-parallel-quickstart, créez un fichier nommé clouddeploy.yaml contenant les éléments suivants :

    apiVersion: deploy.cloud.google.com/v1
    kind: DeliveryPipeline
    metadata:
      name: my-parallel-demo-app-1
    description: main application pipeline
    serialPipeline:
      stages:
      - targetId: qsprod-multi
        profiles: []
        deployParameters:
        - values:
            replicaCount: "1"
          matchTargetLabels:
            label1: label1
        - values:
            replicaCount: "2"
          matchTargetLabels:
            label2: label2
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: qsprod-multi
    description: production clusters
    multiTarget:
      targetIds: [qsprod-a, qsprod-b]
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: qsprod-a
      labels:
        label1: label1
    description: production cluster 2
    gke:
      cluster: projects/PROJECT_ID/locations/us-central1/clusters/quickstart-cluster-qsprod1
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: qsprod-b
      labels:
        label2: label2
    description: production cluster 3
    gke:
      cluster: projects/PROJECT_ID/locations/us-west1/clusters/quickstart-cluster-qsprod2
    

    Cloud Run

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

    apiVersion: deploy.cloud.google.com/v1
    kind: DeliveryPipeline
    metadata:
      name: my-parallel-demo-app-1
    description: main application pipeline
    serialPipeline:
      stages:
      - targetId: qsprod-multi
        profiles: []
        deployParameters:
        - values:
            minInstances: "2"
          matchTargetLabels:
            label1: label1
        - values:
            minInstances: "3"
          matchTargetLabels:
            label2: label2
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: qsprod-multi
    description: production
    multiTarget:
      targetIds: [qsprod-a, qsprod-b]
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: qsprod-a
      labels:
        label1: label1
    description: production us-central1
    run:
      location: projects/PROJECT_ID/locations/us-central1
    ---
    
    apiVersion: deploy.cloud.google.com/v1
    kind: Target
    metadata:
      name: qsprod-b
      labels:
        label2: label2
    description: production us-west1
    run:
      location: projects/PROJECT_ID/locations/us-west1
    

    Notez que ce fichier inclut trois cibles : une multicible et deux cibles enfants. Vous pouvez également configurer des cibles dans un fichier distinct, plutôt qu'avec votre pipeline de diffusion.

    Notez également que le pipeline de diffusion inclut deployParameters avec des libellés, et que les cibles enfants incluent des libellés correspondant à ces paramètres. Cela vous permet de transmettre des valeurs distinctes à des cibles enfants distinctes, si vous le souhaitez. En savoir plus

  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 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 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 diffusion dans la console Google Cloud

    Notez que la seule cible listée est la multicible qsprod-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-parallel-demo-app-1 \
   --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa \
   --to-target=qsprod-multi

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-parallel-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:95ade4b17adcd07623b0a0c68359e344fe54e65d0cb01b989e24c39f2fcd296a \
   --to-target=qsprod-multi

Notez l'option --images=, que vous utilisez pour remplacer l'espace réservé (my-app-image) dans le manifeste ou la définition de service 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 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 (ou, comme 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 une multicible. Par conséquent, rollout est un "déploiement de contrôle" 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 les déploiements 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 le pipeline ne comporte qu'une seule étape, 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

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 quickstart-cluster-qsprod1 --region=us-central1 --project=PROJECT_ID \
    && gcloud container clusters delete quickstart-cluster-qsprod2 --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