Déployer votre application

Cette page explique comment utiliser Cloud Deploy pour transférer votre application dans les environnements d'exécution cibles souhaités. Avant cela, vous devez créer votre pipeline de livraison et vos cibles.

Avant de commencer

Cette section décrit les éléments que vous devez avoir en place pour pouvoir déployer votre application à l'aide de Cloud Deploy.

  • Assurez-vous que votre compte de service d'exécution dispose des rôles et autorisations IAM nécessaires.

  • Créez votre pipeline de livraison et vos cibles.

    Cloud Deploy peut être déployé sur des clusters Google Kubernetes Engine, Cloud Run et GKE Enterprise. La configuration cible diffère selon l'emplacement sur lequel vous effectuez le déploiement.

  • Vous devez disposer d'images et de fichiers manifestes de conteneur.

    Vous avez besoin d'une ou de plusieurs images de conteneur à déployer et d'un ou plusieurs fichiers manifestes Kubernetes (à déployer sur GKE) ou de fichiers YAML de service (à déployer sur Cloud Run).

    Vous avez besoin d'un pipeline d'intégration continue ou d'un autre processus pour créer et placer vos images. Votre outil d'intégration continue peut être Cloud Build, Jenkins ou tout autre élément générant des images de conteneur que vous pouvez fournir à votre pipeline de livraison Cloud Deploy.

  • Créez un fichier de configuration skaffold.yaml.

    Cloud Deploy appelle skaffold render pour afficher les fichiers manifestes Kubernetes à l'aide de ce fichier et skaffold apply pour les déployer dans votre cible. Pour ce faire, Skaffold nécessite au moins un skaffold.yaml minimal. Vous pouvez en obtenir un de deux manières:

    • Créez le vôtre.

      Notez que le fichier skaffold.yaml doit faire référence à l'espace de noms correspondant à une version Skaffold compatible sur la première ligne, comme dans cet exemple:

      `apiVersion: skaffold/v4beta7`
      
    • Le faire générer pour vous.

      Si vous ne disposez pas encore d'un fichier skaffold.yaml, vous pouvez demander à Cloud Deploy d'en créer un pour vous. Ce fichier convient à l'intégration, à l'apprentissage ou à la démonstration de Cloud Deploy. Il ne doit pas être utilisé pour des charges de travail de production.

    Pour en savoir plus, consultez la page Utiliser Skaffold avec Cloud Deploy. La page Gérer les fichiers manifestes dans Cloud Deploy contient également plus de détails sur l'utilisation de Skaffold et de Cloud Deploy avec des outils de gestion des fichiers manifestes tels que Helm, Kustomize et kpt.

Configurer Cloud Deploy pour l'environnement d'exécution de votre choix

Cloud Deploy peut déployer votre application dans l'un des environnements d'exécution suivants:

Appeler votre pipeline de livraison pour créer une version

Une fois que vous avez configuré Cloud Deploy pour le déploiement dans votre environnement d'exécution, vous pouvez envoyer votre application à déployer en fonction du pipeline de livraison que vous avez créé.

  1. Exécuter votre processus d'intégration continue (CI) standard pour créer le ou les artefacts déployables

  2. Lancez le pipeline de livraison en appelant Cloud Deploy pour créer une version.

    Exécutez la commande suivante à partir du répertoire contenant votre configuration Skaffold:

    gcloud deploy releases create RELEASE_NAME --delivery-pipeline=PIPELINE_NAME --region=REGION
    

    Étant donné que cette commande crée un fichier tar contenant l'intégralité du contenu du répertoire et de ses sous-répertoires, vous ne souhaiterez peut-être pas l'exécuter à partir du répertoire d'accueil ou racine. Exécutez la commande à partir du répertoire contenant votre configuration Skaffold ou incluez l'option --source=, décrite plus loin.

    Dans cette commande...

    RELEASE_NAME est un nom à attribuer à cette version. Le nom doit être unique parmi toutes les versions de ce pipeline de livraison.

    Vous pouvez spécifier des noms de version dynamiques en incluant '$DATE', '$TIME' ou les deux. Par exemple, si vous appelez cette commande à 15h07 (UTC), 'rel-$TIME' renvoie rel-1507. '$DATE' et '$TIME' doivent être entre guillemets simples, et l'heure correspond à l'heure UTC de la machine sur laquelle vous appelez la commande.

    PIPELINE_NAME est le nom du pipeline de livraison qui gérera le déploiement de cette version via la progression des cibles. Ce nom doit correspondre au champ name de la définition du pipeline.

    REGION est le nom de la région dans laquelle vous créez la version, par exemple us-central1. Ce champ est obligatoire.

Cette commande importe un fichier tar contenant vos configurations dans un bucket Cloud Storage et crée la version. Cloud Deploy crée également automatiquement un déploiement et déploie votre image sur la première cible définie dans le pipeline de livraison.

En plus des paramètres présentés dans cette commande, vous pouvez inclure l'une des options suivantes:

  • --images=<name=path/name:$IMAGE_SHA>,<name=path/name:$IMAGE_SHA>

    Ensemble de remplacements de nom d'image par un chemin d'accès complet d'image.

  • --build-artifacts=<path/file>

    Référence à un fichier de sortie d'artefacts de compilation Skaffold, qui peut être transmis pour représenter les remplacements de chemin d'accès complet de l'image.

Ces deux options s'excluent mutuellement.

Vous pouvez également inclure l'un des indicateurs suivants pour que Cloud Deploy génère un fichier skaffold.yaml à votre place:

  • --from-k8s-manifest=K8S_MANIFEST

    La configuration Skaffold générée est basée sur le fichier manifeste Kubernetes que vous transmettez à cet indicateur. L'utilisation de cette option avec l'option --skaffold-file ou --source génère une erreur. Pour en savoir plus, consultez Générer votre skaffold.yaml.

  • --from-run-manifest=RUN_MANIFEST

    La configuration Skaffold générée est basée sur le fichier YAML du service Cloud Run que vous transmettez à cet indicateur. L'utilisation de cette option avec l'option --skaffold-file ou --source génère une erreur. Pour en savoir plus, consultez Générer votre skaffold.yaml.

Ces deux options s'excluent mutuellement.

Vous pouvez également inclure un fichier .gcloudignore si le répertoire contient des fichiers que vous ne souhaitez pas inclure dans le fichier tar.

Créer une version à partir de la console Google Cloud

Vous pouvez utiliser la console Google Cloud afin de créer une version pour un pipeline de livraison. Cette approche est utile pour tester Cloud Deploy, mais n'est pas adaptée aux charges de travail de production.

La procédure suivante suppose que vous avez déjà créé un pipeline de livraison et une ou plusieurs cibles. (Vous pouvez également utiliser la console Google Cloud pour créer votre pipeline de livraison).

  1. Sur la page Détails du pipeline de livraison, cliquez sur Créer une version pour un pipeline de livraison spécifique.

    Détails du pipeline de livraison, avec le bouton "Create release" (Créer une version)

  2. Dans le champ Choisir un conteneur, collez ou saisissez le chemin d'accès à l'image de conteneur que vous souhaitez déployer. Vous pouvez aussi utiliser le conteneur par défaut prérempli dans ce champ pour l'évaluation.

    Vous pouvez également cliquer sur Sélectionner pour choisir une image de conteneur dans Artifact Registry ou Container Registry.

  3. Indiquez un nom unique pour cette version dans le champ Nom de la version ou utilisez le nom par défaut fourni.

  4. Attribuez un nom au déploiement dans le champ Nom du déploiement ou utilisez le nom par défaut fourni.

    Ce nom est utilisé pour le déploiement sur la première cible, pour cette version. Pour les cibles suivantes, vous pouvez nommer le déploiement dans la boîte de dialogue promote ou dans la commande gcloud deploy releases promote.

  5. Incluez éventuellement une description de cette version dans le champ Description.

  6. Sous Détails du déploiement, saisissez un nom pour votre déploiement GKE ou votre service Cloud Run, ou utilisez le nom par défaut fourni.

    Pour GKE, Cloud Deploy génère le fichier manifeste pour vous. Pour Cloud Run, Cloud Deploy génère la définition de service, qui permet de créer le service.

  7. Cliquez sur Créer.

    Boîte de dialogue "Créer une version"

Cloud Deploy utilise le fichier manifeste ou la définition de service Cloud Run générés et le fichier skaffold.yaml généré pour créer la version.

Modifier le délai avant expiration du déploiement

Pour les déploiements sur les clusters cibles GKE et GKE Enterprise, trois délais avant expiration distincts affectent le délai d'attente du système jusqu'à ce que Kubernetes signale un déploiement stable:

  • Cloud Build a un délai d'inactivité d'une heure pour les opérations effectuées pour Cloud Deploy.

    Vous pouvez modifier ce délai avant expiration dans la configuration de votre environnement d'exécution.

  • Skaffold dispose d'un délai avant expiration de la vérification de l'état (deploy.statusCheckDeadlineSeconds), qui correspond au temps, en secondes, nécessaire pour attendre la stabilisation des déploiements.

    La valeur par défaut est de 600 secondes (10 minutes). Pour utiliser ce délai, deploy.statusCheck doit être défini sur true. Par défaut, c'est le cas. Si statusCheck est défini sur false, il n'y a pas de vérification de l'état et le déploiement est marqué comme réussi une fois l'opération kubectl apply terminée.

  • Pour les ressources Kubernetes de kind: Deployment, il existe Deployment.spec.progressDeadlineSeconds, qui correspond au temps pendant lequel Kubernetes attend que le déploiement soit signalé comme stable.

    Ce délai avant expiration ne s'applique qu'aux ressources Deployment. Voici comment ces deux premiers délais d'expiration fonctionnent ensemble:

    • Si Deployment.spec.progressDeadlineSeconds n'est pas défini dans Kubernetes, le délai avant expiration de la vérification d'état Skaffold correspond au délai avant expiration effectif, qu'il s'agisse de la valeur par défaut ou qu'il soit explicitement défini.

    • Si Deployment.spec.progressDeadlineSeconds est défini dans Kubernetes, Skaffold ignore son propre délai avant expiration de la vérification de l'état. Le délai de progression de Kubernetes correspond au délai d'expiration effectif. Toutefois, si le délai avant expiration de Kubernetes est explicitement défini sur 600 (10 minutes), Skaffold suppose qu'il s'agit de la valeur par défaut (non définie) et l'ignore. Le délai avant expiration Skaffold est alors utilisé (s'il est défini).

    • Si aucun délai avant expiration n'est défini, le délai avant expiration effectif est défini par défaut sur 600 dans Skaffold (10 minutes).

    Outre les Deployment, d'autres ressources Kubernetes peuvent présenter des délais avant expiration, qui n'influencent pas le délai avant expiration de la stabilité. Si l'un de ces éléments est présent, vérifiez-le pour vous assurer qu'il n'entre pas en conflit avec le délai avant expiration de la stabilité.

    Si Skaffold (ou Cloud Build) expire, le déploiement GKE continue de s'exécuter. Cloud Deploy affiche un échec, mais il peut tout de même réussir ou échouer sur le cluster GKE.

Pour modifier le délai avant expiration de la stabilité du déploiement:

  1. Assurez-vous que deploy.statusCheck est défini sur true dans skaffold.yaml.

    true est la valeur par défaut. Lorsque la valeur est true, Skaffold attend que les vérifications d'état signalent un déploiement stable, sous réserve de la valeur du délai avant expiration de l'étape suivante.

  2. Dans skaffold.yaml, définissez statusCheckDeadlineSeconds sur le nombre de secondes que vous souhaitez attendre.

    deploy:
      ...
      statusCheck: true
      statusCheckDeadlineSeconds: 600
      ...
    

    La valeur par défaut est 600 (10 minutes). Skaffold attend pendant cette durée un déploiement stable. Si ce délai est dépassé avant que le déploiement ne soit stable, celui-ci échoue.

  3. Vous pouvez éventuellement ajouter tolerateFailuresUntilDeadline: true après statusCheckDeadlineSeconds.

    Ce paramètre indique à Skaffold de ne pas se fermer en cas d'échec d'un seul déploiement, mais de tolérer des échecs jusqu'à l'expiration de statusCheckDeadlineSeconds. Ce paramètre peut être utile dans les cas où des ressources peuvent avoir besoin de plus de temps (jusqu'à la date limite de vérification de l'état) pour atteindre un état stable.

    Par exemple, si vous utilisez Istio ou Anthos Service Mesh, un déploiement ayant échoué peut s'afficher avec un message semblable à celui-ci:

    error iptables validation failed; workload is not ready for Istio.
    When using Istio CNI, this can occur if a pod is scheduled before the node is ready.
    

    Ce paramètre ne fonctionne qu'avec Skaffold 2.0 ou version ultérieure.

  4. Dans votre fichier manifeste Kubernetes, pour les ressources de kind: Deployment, définissez Deployment.spec.progressDeadlineSeconds sur la même valeur que celle définie pour statusCheckDeadlineSeconds.

Étapes suivantes