Déployer une application sur Cloud Run à l'aide de Cloud Deploy

Déployer une application sur Cloud Run à l'aide de Cloud Deploy

Cette page explique comment utiliser Cloud Deploy pour diffuser un exemple d'image d'application nommée hello dans une séquence de deux services Cloud Run ou de deux tâches Cloud Run.

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

1. Créer une configuration Skaffold

2. Créez des fichiers de configuration pour deux services Cloud Run ou deux tâches.

   Ces fichiers définissent les services ou les tâches, et spécifient les images de conteneur (prédéfinies) à déployer.

3. Définissez votre pipeline de livraison Cloud Deploy et vos cibles de déploiement, qui pointent vers les deux services ou les deux tâches.

4. Instancier votre pipeline de diffusion en créant une version qui est automatiquement déployée sur la première cible.

5. Effectuer la promotion de la version vers la deuxième cible.

6. Affichez les deux déploiements 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, 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, 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. Cette procédure concerne les projets pour lesquels l'attribution automatique de rôles est désactivée pour les comptes de service par défaut.

1. Ajoutez 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. Accordez au compte de service d'exécution par défaut actAs l'autorisation de déployer des charges de travail dans Cloud Run:

   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
   

3. Ajoutez les autorisations de développeur 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"
   

   Si vous ne parvenez pas à ajouter l'un de ces rôles, contactez votre administrateur de projet.

Préparer la configuration Skaffold

Cloud Deploy utilise Skaffold pour fournir des informations sur les éléments à déployer et sur la manière de les déployer correctement pour vos cibles distinctes.

Pour ce guide de démarrage rapide, vous allez créer un fichier skaffold.yaml qui identifie le service ou la définition de tâche Cloud Run à utiliser pour déployer l'exemple d'application.

1. Ouvrez une fenêtre de terminal.

2. Créez un répertoire nommé deploy-run-quickstart et accédez-y.

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

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

   Services

   apiVersion: skaffold/v4beta7
   kind: Config
   metadata:
     name: deploy-run-quickstart
   profiles:
   - name: dev
     manifests:
       rawYaml:
       - run-service-dev.yaml
   - name: prod
     manifests:
       rawYaml:
       - run-service-prod.yaml
   deploy:
     cloudrun: {}
   

   Jobs

   apiVersion: skaffold/v4beta7
   kind: Config
   metadata:
     name: deploy-run-quickstart
   profiles:
   - name: dev
     manifests:
       rawYaml:
       - run-job-dev.yaml
   - name: prod
     manifests:
       rawYaml:
       - run-job-prod.yaml
   deploy:
     cloudrun: {}
   

   Ce fichier est une configuration Skaffold minimale, qui identifie vos services ou tâches Cloud Run. Pour en savoir plus sur ce fichier, consultez la documentation de référence sur skaffold.yaml.

Préparer vos services ou tâches Cloud Run

Pour ce guide de démarrage rapide, vous allez créer deux services Cloud Run différents ou deux tâches Cloud Run dans le même projet. Cloud Deploy est également compatible avec les déploiements sur plusieurs projets. De plus, nous utilisons des profils Skaffold pour permettre d'avoir deux services ou tâches dans le même projet. Lorsque vous utilisez différents projets, vous n'avez peut-être pas besoin d'utiliser les profils Skaffold.

Services

1. Créez un fichier nommé run-service-dev.yaml avec le contenu suivant :

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: deploy-run-service-dev
   spec:
     template:
       spec:
         containers:
         - image: my-app-image
   

   Ce fichier définit un service Cloud Run. Comme l'indique le nom deploy-run-service-dev, il s'agit de votre service dev, qui correspond à la première cible de la progression de votre pipeline de livraison.

2. Créez un fichier nommé run-service-prod.yaml avec le contenu suivant :

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: deploy-run-service-prod
   spec:
     template:
       spec:
         containers:
         - image: my-app-image
   

   Ce fichier définit un autre service Cloud Run et, comme l'indique son nom deploy-run-service-prod, il s'agit de votre service prod. Il correspond à la deuxième cible dans la progression de votre pipeline de livraison.

Jobs

1. Créez un fichier nommé run-job-dev.yaml avec le contenu suivant :

   apiVersion: run.googleapis.com/v1
   kind: Job
   metadata:
     name: deploy-run-job-dev
   spec:
     template:
       spec:
         template:
           spec:
             containers:
             - image: my-app-image
   

   Ce fichier définit un job Cloud Run. Comme son nom l'indique, deploy-run-job-dev correspond à votre tâche dev et correspond à la première cible de la progression de votre pipeline de livraison.

2. Créez un fichier nommé run-job-prod.yaml avec le contenu suivant :

   apiVersion: run.googleapis.com/v1
   kind: Job
   metadata:
     name: deploy-run-job-prod
   spec:
     template:
       spec:
         template:
           spec:
             containers:
             - image: my-app-image
   

   Ce fichier définit une autre tâche Cloud Run. Comme son nom l'indique, deploy-run-job-prod correspond à votre tâche prod et correspond à la deuxième cible de la progression de votre pipeline de livraison.

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. Dans le répertoire deploy-run-quickstart, créez un fichier clouddeploy.yaml avec le contenu suivant :

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: my-run-demo-app-1
   description: main application pipeline
   serialPipeline:
     stages:
     - targetId: run-qsdev
       profiles: [dev]
     - targetId: run-qsprod
       profiles: [prod]
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: run-qsdev
   description: Cloud Run development service
   run:
     location: projects/PROJECT_ID/locations/us-central1
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: run-qsprod
   description: Cloud Run production service
   run:
     location: projects/PROJECT_ID/locations/us-central1
   

   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 avec le service Cloud Deploy:

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

   Vous disposez maintenant d'un pipeline avec des cibles prêt à déployer votre application sur votre première cible.

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, et les deux cibles sont répertoriées dans la colonne Cibles.

   

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.

Exécutez la commande suivante à partir du répertoire deploy-run-quickstart pour créer une ressource release qui représente l'image de conteneur à déployer:

Services

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-run-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/hello@sha256:6063adf8f687702b4065151acddba6781c47bc602167eb9f3bec8aebc9ce95cc

Jobs

 gcloud deploy releases create test-release-001 \
   --project=PROJECT_ID \
   --region=us-central1 \
   --delivery-pipeline=my-run-demo-app-1 \
   --images=my-app-image=us-docker.pkg.dev/cloudrun/container/job@sha256:d7c33651fbad911a9a0a0c16f2f9b3a79f0b9e3e89afb205603af706067feac5

Comme pour toutes les versions (sauf si elles incluent --disable-initial-rollout), Cloud Deploy crée également automatiquement une ressource de déploiement. L'application est automatiquement déployée sur la première cible de la progression.

Promouvoir la version

Remarque :Une fois la version créée, vous devrez peut-être attendre quelques minutes avant de passer à cette étape.

1. Sur la page Pipelines de livraison, cliquez sur le pipeline my-run-demo-app-1.

   Ouvrir la page Pipelines de diffusion

   La page "Détails du pipeline de livraison" affiche une représentation graphique de la progression de votre pipeline de livraison. Dans ce cas, cela indique que la version a été déployée sur la cible run-qsdev.

   

2. Sur la première cible de la visualisation du pipeline de diffusion, cliquez sur Promouvoir.

   La boîte de dialogue Promouvoir la version s'affiche. Elle affiche les détails de la cible de l'annonce.

3. Cliquez sur Promouvoir.

   La version est désormais en file d'attente en vue d'un déploiement dans run-qsprod. Une fois le déploiement terminé, la visualisation du pipeline de livraison la montre comme déployée:

   

Afficher les résultats dans la console Google Cloud

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

   Ouvrir la page Pipelines de diffusion

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

   La visualisation du pipeline montre la progression de l'application dans le pipeline.

   

   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.

   

Accéder à votre service Cloud Run

Par défaut, vous devez être authentifié pour accéder aux nouveaux services Cloud Run. Consultez la présentation de l'authentification de Cloud Run pour savoir comment fournir des identifiants et identifier la configuration Identity and Access Management requise pour accéder au service sans authentification. Cela ne s'applique pas aux tâches 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 le service ou le job Cloud Run deploy-qs-dev:

   Services

   gcloud run services delete deploy-run-service-dev --region=us-central1 --project=PROJECT_ID
   

   Jobs

   gcloud run jobs delete deploy-run-job-dev --region=us-central1 --project=PROJECT_ID
   

2. Supprimez le service deploy-qs-prod:

   Services

   gcloud run services delete deploy-run-service-prod --region=us-central1 --project=PROJECT_ID
   

   Jobs

   gcloud run jobs delete deploy-run-job-prod --region=us-central1 --project=PROJECT_ID
   

3. Supprimez le pipeline de livraison, les cibles, la version et les déploiements:

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

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

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

• Lisez l'article pratique sur le déploiement sur Cloud Run.

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