Créer une cible personnalisée

Ce document explique comment créer un type de cible Cloud Deploy personnalisé et l'utiliser comme cible dans un pipeline de livraison Cloud Deploy.

Voici le processus général pour créer un type de cible personnalisé et l'utiliser dans votre pipeline de livraison:

  1. Créez une ou plusieurs applications conteneurisées qui incluent la fonctionnalité de déploiement sur votre cible personnalisée et qui répondent aux exigences de Cloud Deploy pour les types de cibles personnalisées.

  2. Définissez une action personnalisée dans skaffold.yaml qui référence ce conteneur et spécifie la ou les commandes à exécuter sur celui-ci.

  3. Créez une définition CustomTargetType faisant référence à l'action personnalisée de l'étape précédente et enregistrez-la en tant que ressource Cloud Deploy.

  4. Définissez une nouvelle cible avec une propriété customTarget qui identifie votre nouveau type de cible personnalisée.

  5. Référencez cette cible à partir de la progression de votre pipeline de livraison.

  6. Créez une version.

Chacune de ces étapes est décrite en détail dans la suite de ce document.

Créer vos applications conteneurisées

La fonctionnalité de déploiement sur votre cible personnalisée est définie dans des applications conteneurisées, que vous fournissez à Cloud Deploy en les référençant à partir de votre fichier skaffold.yaml. Lorsque votre pipeline de livraison inclut une cible qui utilise un type de cible personnalisé, Cloud Deploy appelle les conteneurs d'actions personnalisées définis pour ce type de cible personnalisée, dans Skaffold, pour exécuter les actions de rendu et de déploiement que vous avez définies.

Le comportement de vos applications vous revient entièrement. Toutefois, il doit utiliser les variables d'environnement d'entrée fournies par Cloud Deploy et renvoyer les sorties requises.

Dans la plupart des cas, vous allez créer un conteneur pour votre action de rendu et un autre pour votre action de déploiement, pour chaque type de cible personnalisée que vous créez. L'action de rendu est facultative, mais si vous n'en fournissez pas, Cloud Deploy utilise l'skaffold render par défaut.

Définir vos actions personnalisées dans Skaffold

Une fois votre ou vos images de conteneur d'action personnalisée en place, vous les référencez à partir de votre fichier de configuration skaffold.yaml.

Vous configurez chaque action personnalisée pour une cible personnalisée dans un bloc customActions. Pour tout type de cible personnalisée, vous créez une action personnalisée dans Skaffold pour le rendu et une autre pour le déploiement. La définition CustomTargetType identifie l'action personnalisée utilisée pour le rendu et celle utilisée pour le déploiement.

Voici la configuration des actions d'affichage et de déploiement personnalisées dans skaffold.yaml:

apiVersion: skaffold/v4beta7
kind: Config
customActions:
# custom render action
- name:
  containers:
  - name:
    image:
    command:
    args:
# custom deploy action
- name:
  containers:
  - name:
    image:
    command:
    args:

Dans cette configuration Skaffold:

  • customActions.name

    Nom arbitraire pour l'action de rendu ou de déploiement personnalisée. La définition CustomTargetType fait référence à ce nom, dans la propriété renderAction ou deployAction.

  • Le stanza containers inclut votre référence, ainsi que les commandes permettant d'exécuter ce conteneur.

    Le stanza containers autorise plusieurs conteneurs, mais Google vous recommande de n'en utiliser qu'un seul.

  • customActions.containers.name

    est un nom arbitraire pour le conteneur spécifique que vous utilisez pour cette action ; Une bonne pratique consiste à toujours utiliser la qualification SHA pour ce nom de conteneur.

  • image

    Chemin d'accès à l'image de conteneur

  • command

    est la ou les commandes à exécuter sur le conteneur ;

  • args

    Il s'agit d'une collection d'arguments pour command.

Consultez la documentation de référence de Skaffold sur YAML pour obtenir une documentation détaillée sur les propriétés de configuration utilisées dans customActions.

Définir votre type de cible personnalisée

Pour définir une cible personnalisée, vous devez d'abord créer un type de cible personnalisé, à l'aide de la configuration CustomTargetType. Vous pouvez créer le CustomTargetType dans le même fichier que la définition de votre pipeline de livraison, avec les définitions de cibles ou dans un fichier distinct.

La définition de CustomTargetType est la suivante:

# Custom target type config (preview)
apiVersion: deploy.cloud.google.com/v1
kind: CustomTargetType
metadata:
  name: [CUSTOM_TARGET_TYPE_NAME]
  annotations:
  labels:
description:
customActions:
  renderAction: [RENDER_ACTION_NAME]
  deployAction: [DEPLOY_ACTION_NAME]
  includeSkaffoldModules:

Où

  • CUSTOM_TARGET_TYPE_NAME

    Nom arbitraire que vous attribuez à cette définition de type de cible personnalisée. Ce nom est référencé dans la définition de la cible pour toute cible utilisant le type de cible personnalisée que vous définissez.

  • RENDER_ACTION_NAME

    Nom de l'action de rendu personnalisé. Cette valeur correspond au customAction.name défini dans skaffold.yaml pour l'action de rendu.

  • DEPLOY_ACTION_NAME

    Nom de l'action de déploiement personnalisée. Cette valeur correspond à la valeur customAction.name définie dans skaffold.yaml pour l'action de deploy.

  • includeSkaffoldModules

    Est un bloc facultatif à utiliser si vous utilisez des configurations Skaffold distantes. Les propriétés de ce bloc sont présentées dans la section Utiliser des configurations Skaffold distantes.

Utiliser des configurations Skaffold distantes

Vous pouvez stocker les configurations Skaffold dans un dépôt Git public, un bucket Cloud Storage ou un dépôt Cloud Build 2e génération, et les référencer à partir de votre définition de type de cible personnalisée.

L'utilisation de configurations Skaffold distantes signifie que les actions personnalisées n'ont pas besoin d'être définies pour le skaffold.yaml que vous fournissez au moment de la publication. Cela permet de partager des actions personnalisées dans votre organisation.

Pour utiliser des configurations Skaffold distantes:

  1. Créez une configuration Skaffold avec vos actions personnalisées.

  2. Stockez la configuration dans un dépôt Git ou dans un bucket Cloud Storage.

  3. Dans votre définition de type de cible personnalisée, ajoutez un stanza customActions.includeSkaffoldModules.

  4. Sous includeSkaffoldModules, spécifiez les éléments suivants:

    • Éventuellement, un ou plusieurs éléments configs:

      - configs: ["name1", "name2"]

      La valeur de configs est une liste de chaînes correspondant à la propriété metadata.name de chaque configuration Skaffold à inclure. S'il est omis, Cloud Deploy prend toutes les configurations du chemin d'accès spécifié.

    • Un strophe googleCloudStorage, git ou googleCloudBuildRepo.

      Pour Cloud Storage:

      googleCloudStorage:
  source: PATH_TO_GCS_BUCKET
  path: FILENAME

      Pour Git:

      git:
  repo: REPO_URL
  path: PATH_TO_FILE
  ref: BRANCH_NAME

      Pour les dépôts Cloud Build (2e génération):

       googleCloudBuildRepo:
  repository: PATH_TO_GCB_REPO
  path: PATH_TO_FILE
  ref: BRANCH_NAME

      Où :

      PATH_TO_GCS_BUCKET est le chemin d'accès à un répertoire Cloud Storage, qui se termine par /*, où sont stockées les configurations Skaffold. Skaffold télécharge tous les fichiers de ce répertoire, puis trouve le fichier Skaffold approprié avec les configurations, en fonction du chemin d'accès relatif configuré.

      PATH_TO_GCB_REPO est le chemin d'accès au dépôt Cloud Build 2nd gen, où les configurations Skaffold sont stockées. Le chemin d'accès se présente sous la forme suivante : projects/{project}/locations/{location}/connections/{connection}/repositories/{repository}. Skaffold télécharge tous les fichiers de ce répertoire, puis trouve le fichier Skaffold, en fonction du chemin d'accès relatif configuré.

      FILENAME est le nom du fichier qui inclut les configurations Skaffold. Cette propriété path: est facultative. Si vous ne la spécifiez pas, Cloud Deploy suppose que skaffold.yaml. En l'absence de skaffold.yaml ou si le nom de fichier que vous spécifiez n'est pas présent, la création de la version échoue.

      REPO_URL est l'URL du dépôt Git.

      PATH_TO_FILE est le chemin d'accès de ce dépôt au fichier contenant les configurations Skaffold.

      BRANCH_NAME est le nom de la branche (par exemple, main) à partir de laquelle récupérer les configurations Skaffold.

Exemple

Le fichier YAML de type cible personnalisé suivant est un bloc customActions avec un bloc includeSkaffoldModules, pointant vers les configurations Skaffold stockées dans un bucket Cloud Storage:

customActions:
  renderAction: my-custom-action
  deployAction: my-custom-action
  includeSkaffoldModules:
    - configs: ["myConfig"]
      googleCloudStorage:
        source: "gs://my-custom-target-bucket/my-custom/*"
        path: "skaffold.yaml

Le fichier YAML suivant est une configuration Skaffold, à laquelle l'action personnalisée affichée fait référence:

apiVersion: skaffold/v4beta7
kind: Config
metadata:
  name: myConfig
customActions:
  - name: my-custom-action
    containers:
      - name: my-custom-container
        image: us-east1-docker.pkg.dev/abcdefg/foldername/myimage@sha256:c56fcf6e0a7637ddf0df3d56a0dd23bfce03ceca06a6fc527b0e0e7430e6e9f9

Enregistrer votre type de cible personnalisée

Après avoir configuré CustomTargetType, exécutez la commande gcloud deploy apply pour enregistrer la ressource CustomTargetType dans un projet Google Cloud:

gcloud deploy apply --file=[FILE] --project=[PROJECT] --region=[REGION]

Où :

FILE est le nom du fichier dans lequel vous avez défini ce type de cible personnalisée.

PROJECT est le projet Google Cloud dans lequel créer cette ressource. CustomTargetType doit se trouver dans le même projet que la ressource Target qui le référence. Vous n'avez pas besoin de spécifier le projet si vous l'avez défini comme projet par défaut pour la Google Cloud CLI.

REGION est la région (par exemple, us-centra1) dans laquelle créer cette ressource. Le CustomTargetType doit se trouver dans la même région que la ressource Target qui le référence. Vous n'avez pas besoin de spécifier la région si vous l'avez définie comme région par défaut pour la gcloud CLI.

Maintenant que CustomTargetType est créé en tant que ressource Cloud Deploy, vous pouvez l'utiliser dans une définition Target pour créer votre cible personnalisée.

Pour en savoir plus sur la définition de CustomTargetType, consultez la documentation de référence du schéma de configuration Cloud Deploy.

Définir votre cible

La seule différence entre une définition de cible pour un type de cible compatible et une définition de cible personnalisée est que celle-ci inclut un bloc customTarget. La syntaxe d'un élément customTarget est la suivante:

customTarget:
  customTargetType: [CUSTOM_TARGET_TYPE_NAME]

Où CUSTOM_TARGET_TYPE_NAME est la valeur de la propriété name définie dans votre configuration du type de cible personnalisée.

Ajouter votre cible au pipeline de livraison

Vous pouvez utiliser une cible personnalisée dans un pipeline de livraison exactement comme vous utiliseriez un type de cible compatible. Autrement dit, il n'existe aucune différence dans la progression du pipeline de livraison entre les cibles d'un type de cible compatible et les cibles personnalisées.

Toutes les cibles d'un pipeline de livraison doivent utiliser le même type de cible. Par exemple, vous ne pouvez pas avoir un pipeline de livraison avec certaines cibles déployées sur Google Kubernetes Engine et certaines cibles personnalisées.

Comme pour les types de cibles compatibles, vous pouvez inclure des paramètres de déploiement dans l'étape du pipeline.

Créer une version

Maintenant que votre type de cible personnalisée est entièrement défini et qu'une cible est créée pour l'utiliser, vous pouvez créer une version normalement:

gcloud deploy releases create [RELEASE_NAME] \
  --project=[PROJECT_NAME] \
  --region=[REGION] \
  --delivery-pipeline=[PIPELINE_NAME]

Lors de la création de la version, votre action de rendu personnalisée est exécutée pour chaque cible du pipeline de livraison. Cela inclut le traitement des paramètres de déploiement configurés sur la version, les cibles ou le pipeline de livraison. Cloud Deploy fournit les paramètres de déploiement en tant qu'entrée au conteneur de rendu personnalisé.

Afficher le résultat de vos cibles personnalisées

Si votre action personnalisée répond aux exigences concernant les cibles personnalisées, vous pouvez afficher les artefacts affichés à l'aide de la console Google Cloud.

Suivez ces étapes pour afficher le résultat de votre action d'affichage personnalisé.

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

    Ouvrir la page Pipelines de diffusion

  2. Cliquez sur le nom de votre pipeline de livraison.

    La visualisation du pipeline affiche l'état du déploiement de l'application et votre version est répertoriée dans l'onglet Releases (Versions) sous Delivery pipeline details (Détails du pipeline de livraison).

  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 la flèche à côté de Afficher les artefacts.

    Les artefacts rendus sont répertoriés, y compris le skaffold.yaml rendu et le fichier manifeste rendu généré par le moteur de rendu personnalisé. Vous pouvez également cliquer sur le lien Emplacement de stockage à côté de chacun d'entre eux pour accéder au bucket Cloud Storage et afficher ces fichiers.

    Vous pouvez également cliquer sur le lien Afficher les artefacts pour afficher ces fichiers par version, par cible ou par phase à l'aide de l'inspecteur de versions.

Étapes suivantes