Définir et utiliser un type de cible personnalisé

Définir et utiliser un type de cible personnalisé

Ce guide de démarrage rapide explique comment utiliser Cloud Deploy pour créer une instance puis effectuer le déploiement sur une cible personnalisée de ce type.

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

1. Créez une configuration Skaffold.

   C'est dans le fichier de configuration Skaffold que vous configurez le comportement cible. Cette configuration fait référence à des images de conteneur et à des commandes shell à exécuter sur ces images, qui sont les actions pour les opérations de rendu et de déploiement.

2. Définissez un type de cible personnalisée et une cible qui fait référence à ce type.

3. Définir votre pipeline de livraison Cloud Deploy

   Ce pipeline ne comprend qu'une seule étape et n'utilise qu'une seule cible. À ce stade, vous allez faire référence à la cible que vous avez configurée.

4. Créez une version, ce qui crée automatiquement un déploiement. des opérations de rendu et de déploiement personnalisées.

   Dans le cadre de cette version et de ce déploiement, les opérations de rendu et de déploiement définies dans votre configuration Skaffold sont toutes deux exécutées.

5. Afficher les résultats des opérations personnalisées Cela inclut un fichier de configuration rendu importé dans Cloud Storage, une chaîne écrite dans ce fichier, ainsi qu'un fichier de résultats qui inclut l'état de l'opération.

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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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. To initialize the gcloud CLI, run the following command:

   gcloud init

   Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

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

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

   Enable the APIs

10. Install the Google Cloud CLI.

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

    gcloud init

    Note: You can run the gcloud CLI in the Google Cloud console without installing the Google Cloud CLI. To run the gcloud CLI in the Google Cloud console, use Cloud Shell.

Si Google Cloud CLI est déjà installé, assurez-vous d'exécuter la dernière version :

gcloud components update

12. Assurez-vous que le compte de service Compute Engine par défaut dispose d'autorisations suffisantes.

    Le compte de service dispose peut-être déjà des autorisations nécessaires. Ces étapes sont inclus pour les projets qui désactivent l'attribution automatique de rôles pour le service par défaut Google Cloud.

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.
3. Ajoutez le rôle iam.serviceAccountUser, qui inclut l'autorisation actAs 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
   

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

Cloud Deploy utilise Skaffold pour fournir les éléments à déployer et la façon de le faire target.

Dans ce guide de démarrage rapide, vous allez créer un fichier skaffold.yaml, qui définit des actions personnalisées représentant les opérations de rendu et de déploiement pour le type de cible personnalisée.

Notez que les actions personnalisées fournies dans ce guide de démarrage rapide ne déploient en réalité aucune application dans un environnement d'exécution. Les actions d'affichage et de déploiement importent une fichier de résultats vers Cloud Storage pour remplir le contrat de cible personnalisée entre Cloud Deploy et le rendu et le déploiement définis par l'utilisateur.

1. Ouvrez une fenêtre de terminal.

2. Créez un répertoire et accédez-y.

   mkdir custom-target-quickstart
   cd custom-target-quickstart
   

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

   apiVersion: skaffold/v4beta7
   kind: Config
   customActions:
   - name: custom-render
     containers:
     - name: render
       image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:66e2681aa3099b4e517e4cdcdefff8f2aa45d305007124ccdc09686f6712d018
       command: ['/bin/bash']
       args:
         - '-c'
         - |-
           echo "Sample manifest rendered content" > manifest.txt
           gcloud storage cp manifest.txt $CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt
           echo {\"resultStatus\": \"SUCCEEDED\", \"manifestFile\": \"$CLOUD_DEPLOY_OUTPUT_GCS_PATH/manifest.txt\"} > results.json
           gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
   - name: custom-deploy
     containers:
     - name: deploy
       image: gcr.io/google.com/cloudsdktool/google-cloud-cli@sha256:66e2681aa3099b4e517e4cdcdefff8f2aa45d305007124ccdc09686f6712d018
       command: ['/bin/bash']
       args:
         - '-c'
         - |-
           echo {\"resultStatus\": \"SUCCEEDED\"} > results.json
           gcloud storage cp results.json $CLOUD_DEPLOY_OUTPUT_GCS_PATH/results.json
   

   Ce fichier inclut la strophe customActions:, qui définit une action de rendu personnalisée et une action de déploiement personnalisée. Chacune de ces actions personnalisées fait référence à une image de conteneur à exécuter et à des commandes à exécuter sur ce conteneur.

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

Créer votre pipeline de livraison, votre type de cible personnalisé et votre cible

Vous pouvez définir votre pipeline de diffusion, votre type de cible personnalisée et votre cible dans un seul fichier ou dans des fichiers distincts. Dans ce guide de démarrage rapide, vous allez créer un fichier unique contenant trois.

1. Dans le répertoire custom-target-quickstart, créez un fichier nommé clouddeploy.yaml avec le contenu suivant :

   apiVersion: deploy.cloud.google.com/v1
   kind: DeliveryPipeline
   metadata:
     name: custom-targets-pipeline
   serialPipeline:
     stages:
     - targetId: sample-env
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: Target
   metadata:
     name: sample-env
   customTarget:
     customTargetType: basic-custom-target
   ---
   
   apiVersion: deploy.cloud.google.com/v1
   kind: CustomTargetType
   metadata:
     name: basic-custom-target
   customActions:
     renderAction: custom-render
     deployAction: custom-deploy
   

   Remarque :Le type de cible personnalisée et la cible sont inclus dans la livraison dans ce fichier, mais vous pouvez les définir dans un fichier distinct ou fichiers distincts.

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 de diffusion avec une seule cible. Il s'agit de votre cible utilisant le type de cible personnalisée. Ce pipeline ne déploie pas d'application dans un environnement d'exécution.

3. Confirmez 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, avec une cible listée dans la colonne Cibles.

   

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 sortie. Voir Architecture du service Cloud Deploy pour en savoir plus sur ce cycle de vie.

Exécutez la commande suivante à partir du répertoire custom-target-quickstart pour créer une ressource release représentant l'action personnalisée à déployer :

gcloud deploy releases create test-release-001 \
  --project=PROJECT_ID \
  --region=us-central1 \
  --delivery-pipeline=custom-targets-pipeline

Comme pour toutes les versions (sauf si elles incluent --disable-initial-rollout), Cloud Deploy crée automatiquement ressource de déploiement. Toutes les phases de ce déploiement sont exécutées, y compris le rendu et le déploiement.

Afficher les résultats dans la console Google Cloud

Le déploiement est terminé au bout de quelques minutes. Dans ce cas, comme les deux actions personnalisées sont des commandes permettant d'afficher des chaînes dans un fichier et d'importer le fichier dans Cloud Storage, rien n'est déployé dans un environnement d'exécution cible.

Vous pouvez toutefois afficher le fichier et les chaînes qu'il contient:

1. Dans la console Google Cloud, accédez à Cloud Deploy Page Pipelines de livraison pour afficher votre pipeline de livraison (custom-targets-pipeline).

   Ouvrir la page Pipelines de diffusion

2. Cliquez sur le nom de votre pipeline de livraison (custom-targets-pipeline).

   La visualisation du pipeline montre l'état du 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.

   La page Détails de la version s'affiche.

4. Cliquez sur l'onglet Artefacts.

5. Sous Artefacts cibles, cliquez sur le lien AFFICHER LES ARTEFACTS.

   Le fichier manifeste rendu s'affiche. Dans ce cas, le fichier est la sortie de L'action d'affichage personnalisé que vous avez définie dans votre configuration skaffold.yaml contenant la chaîne "Exemple de contenu affiché dans le fichier manifeste".

   

6. Recherchez les buckets Cloud Storage créés par cette version.

   uvrez la page du navigateur Cloud Storage

   La page Buckets s'affiche, montrant deux buckets créés pour de sortie. Un bucket contient le fichier de configuration du pipeline de livraison et le a affiché skaffold.yaml. L'autre inclut le fichier de sortie est configurée pour créer.

7. Cliquez sur le bucket dont le nom commence par us-central1.deploy-artifacts...

   

8. Cliquez sur le dossier dont le nom commence par custom-targets-pipeline-, puis cliquez sur le dossier test-release-001.

9. Cliquez sur le dossier portant le nom de votre déploiement, qui devrait être test-release-001-to-sample-env-0001.

10. Cliquez sur le dossier affiché, qui est un UUID, puis sur le dossier custom-output.

11. Cliquez sur results.json, puis sur l'URL hypertexte dans le champ URL authentifiée.

    Ce fichier contient la chaîne que vous avez configurée comme sortie de l'action custom-deploy, dans votre skaffold.yaml :

    

Remarque :Vous pouvez également consulter les résultats du rendu dans l'API Cloud Storage bucket, mais il est plus rapide d'utiliser l'inspecteur de versions, comme illustré premières étapes de cette procédure.

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 pipeline de livraison, la cible, la version et le déploiement:

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

2. Supprimer les deux buckets Cloud Storage que Cloud Deploy créé.

   uvrez la page du navigateur Cloud Storage

Voilà ! Vous avez terminé le guide de démarrage rapide.

Étape suivante

• En savoir plus sur les cibles personnalisées

• Consultez les exemples de types de cibles personnalisées disponibles.

• En savoir plus sur Cloud Deploy

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

• Suivez le tutoriel Cloud Deploy.