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

Cette page vous explique comment utiliser Cloud Deploy pour déployer un exemple d'image d'application nommée nginx sur une séquence de deux clusters Google Kubernetes Engine.

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

  1. Créer les deux clusters.

  2. Créer une configuration Skaffold et un fichier manifeste Kubernetes pour spécifier l'image de conteneur (précompilée) à déployer.

  3. Définir votre pipeline de diffusion Cloud Deploy et des cibles de déploiement, qui pointent vers les deux clusters.

  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. Afficher les deux déploiements dans la console. Google Cloud

Avant de commencer

  • Connectez-vous à votre Google Cloud compte. 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 sans frais pour exécuter, tester et déployer des charges de travail.
  • In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  • If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

  • Verify that billing is enabled for your Google Cloud project.

  • Enable the Cloud Deploy, Cloud Build, GKE, and Cloud Storage APIs.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the APIs

  • Installez la Google Cloud CLI.

  • Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

  • Pour initialiser la gcloud CLI, exécutez la commande suivante :

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  • If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

  • Verify that billing is enabled for your Google Cloud project.

  • Enable the Cloud Deploy, Cloud Build, GKE, and Cloud Storage APIs.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the APIs

  • Installez la Google Cloud CLI.

  • Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

  • Pour initialiser la gcloud CLI, exécutez la commande suivante :

    gcloud init
  • Rôles requis

    Pour obtenir les autorisations nécessaires pour créer un pipeline de diffusion et une version Cloud Deploy, demandez à votre administrateur de vous accorder le rôle IAM Exécuteur de job Cloud Deploy (roles/clouddeploy.jobrunner) sur votre projet.

    Pour vous assurer que le compte de service Cloud Deploy dispose des autorisations nécessaires pour exécuter des opérations Cloud Deploy et effectuer un déploiement sur Cloud Run, demandez à votre administrateur d'accorder les rôles IAM suivants au compte de service Cloud Deploy sur votre projet :

    Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

    Votre administrateur peut également attribuer au compte de service Cloud Deploy les autorisations requises à l'aide de rôles personnalisés ou d'autres rôles prédéfinis.

    Créer vos clusters Google Kubernetes Engine

    Créez deux clusters, qsdev et qsprod, 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-qsdev --project=PROJECT_ID --region=us-central1 && gcloud container clusters create-auto quickstart-cluster-qsprod --project=PROJECT_ID --region=us-central1
    

    Préparer votre configuration Skaffold et votre fichier manifeste Kubernetes

    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 à utiliser pour déployer l'exemple d'application.

    1. Ouvrez une fenêtre de terminal.

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

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

      apiVersion: skaffold/v4beta7
      kind: Config
      manifests:
        rawYaml:
        - k8s-*
      deploy:
        kubectl: {}
      

      Ce fichier est une configuration Skaffold minimale qui identifie votre fichier manifeste. 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 qui ne sont pas en production.

      Pour en savoir plus sur ce fichier, consultez la documentation de référence sur skaffold.yaml.

    4. Créez un fichier nommé k8s-pod.yaml avec le contenu suivant :

      apiVersion: v1
      kind: Pod
      metadata:
        name: getting-started
      spec:
        containers:
        - name: nginx
          image: my-app-image
      

      Ce fichier est un fichier manifeste Kubernetes de base, 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.

    Créer votre pipeline de diffusion 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-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-gke-demo-app-1
      description: main application pipeline
      serialPipeline:
        stages:
        - targetId: qsdev
          profiles: []
        - targetId: qsprod
          profiles: []
      ---
      
      apiVersion: deploy.cloud.google.com/v1
      kind: Target
      metadata:
        name: qsdev
      description: development cluster
      gke:
        cluster: projects/PROJECT_ID/locations/us-central1/clusters/quickstart-cluster-qsdev
      ---
      
      apiVersion: deploy.cloud.google.com/v1
      kind: Target
      metadata:
        name: qsprod
      description: production cluster
      gke:
        cluster: projects/PROJECT_ID/locations/us-central1/clusters/quickstart-cluster-qsprod
      
    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 des cibles, prêt à déployer votre application sur votre première cible.

    3. Confirmez votre pipeline et vos cibles :

      Dans la Google Cloud console, 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, et les deux cibles sont listées dans la colonne Cibles.

      Visualisation du pipeline de diffusion dans la console Google Cloud

    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 diffusion définit le cycle de vie de cette version. Pour en savoir plus sur ce cycle de vie, consultez Architecture du service Cloud Deploy.

    Exécutez la commande suivante à partir du répertoire deploy-gke-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-gke-demo-app-1 \
      --images=my-app-image=gcr.io/google-containers/nginx@sha256:f49a843c290594dcf4d193535d1f4ba8af7d56cea2cf79d1e9554f077f1e7aaa
    

    Notez l' --images=indicateur, que vous utilisez pour remplacer l'espace réservé (my-app-image) dans le fichier manifeste 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 la version.

    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

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

      Ouvrir la page Pipelines de diffusion

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

      Visualisation du pipeline de diffusion dans la console Google Cloud

    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 vers laquelle vous effectuez la promotion.

    3. Cliquez sur Promouvoir.

      La version est maintenant mise en file d'attente pour être déployée dans qsprod. Une fois le déploiement terminé, la visualisation du pipeline de diffusion indique qu'il a été déployé :

      Visualisation du pipeline de diffusion dans la console Google Cloud

    Afficher les résultats dans la Google Cloud console

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

      Ouvrir la page Pipelines de diffusion

    2. Cliquez sur le nom de votre pipeline de diffusion "my-gke-demo-app-1".

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

      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 dans cette démonstration soient facturées sur votre Google Cloud compte pour les ressources utilisées sur cette page, procédez comme suit :

    1. Supprimez le cluster qsdev :

      gcloud container clusters delete quickstart-cluster-qsdev --region=us-central1 --project=PROJECT_ID
      
    2. Supprimez le cluster qsprod :

      gcloud container clusters delete quickstart-cluster-qsprod --region=us-central1 --project=PROJECT_ID
      
    3. Supprimez le pipeline de diffusion, 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'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.

    Étape suivante