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 mettre en place avant de 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 effectuer des déploiements sur des clusters Google Kubernetes Engine, Cloud Run et GKE Enterprise. La configuration de la cible diffère selon celle sur laquelle vous effectuez le déploiement.

• Avoir vos images de conteneurs et vos fichiers manifestes

  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 service YAML (à 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 de CI peut être Cloud Build, Jenkins ou tout autre outil générant des images de conteneur que vous pouvez fournir à votre pipeline de livraison Cloud Deploy.

• Disposez d'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 sur 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 référencer l'espace de noms correspondant à une version de Skaffold compatible sur la première ligne, comme dans cet exemple:

    `apiVersion: skaffold/v4beta7`
    

  • Demandez-le pour vous.

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

  Pour en savoir plus, consultez la page Utiliser Skaffold avec Cloud Deploy. Vous trouverez également des informations supplémentaires sur l'utilisation de Skaffold et de Cloud Deploy avec des outils de gestion des fichiers manifestes tels que Helm, Kustomize et Kpt dans la section Gérer les fichiers manifestes dans Cloud Deploy.

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:

• GKE
• GKE Enterprise
• Cloud Run

Appeler votre pipeline de livraison pour créer une version

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

1. Exécutez votre processus d'intégration continue (CI) standard en créant le ou les artefacts déployables.

2. Pour lancer le pipeline de livraison, appelez 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 de l'intégralité du contenu du répertoire et des sous-répertoires, vous ne souhaiterez peut-être pas l'exécuter à partir de votre 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 à donner à 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' est résolu en 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.

Remarque :Vous pouvez éventuellement inclure --source=SOURCE_PATH pour spécifier l'emplacement du fichier skaffold.yaml. Le répertoire par défaut est le répertoire actuel.

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.

Outre les paramètres affichés avec 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 transmise 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 auquel vous transmettez cette option. Si vous utilisez cette option avec l'option --skaffold-file ou --source, cela 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 auquel vous transmettez cette option. Si vous utilisez cette option avec l'option --skaffold-file ou --source, cela 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 depuis la console Google Cloud

Vous pouvez utiliser la console Google Cloud pour créer une version pour un pipeline de livraison. Cette solution 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.

   

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

   Vous pouvez également cliquer sur Sélectionner pour choisir une image de conteneur à partir d'Artifact Registry ou de Container Registry.

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

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

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

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

6. Sous Deployment details (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 automatiquement le fichier manifeste. 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.

   

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

Modifier le délai d'expiration du déploiement

Pour les déploiements sur les clusters cibles GKE et GKE Enterprise, il existe trois délais avant expiration distincts qui affectent le délai d'attente du système pour que Kubernetes indique un déploiement stable:

• Cloud Build a un délai avant expiration d'une heure sur les opérations qu'il effectue pour Cloud Deploy.

  Vous pouvez modifier ce délai 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 délai d'attente, en secondes, avant la stabilisation des déploiements.

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

• Pour les ressources Kubernetes de kind: Deployment, il existe Deployment.spec.progressDeadlineSeconds, qui correspond à la durée pendant laquelle Kubernetes attend que le déploiement soit considéré comme stable.

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

  • Si Deployment.spec.progressDeadlineSeconds, dans Kubernetes, n'est pas défini, 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 et le délai de progression de Kubernetes correspond au délai avant 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éfini) et l'ignore. Le délai avant expiration Skaffold est utilisé (s'il est défini).

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

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

  Si Skaffold (ou Cloud Build) expire, le déploiement GKE continue de s'exécuter. Cloud Deploy indique 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 de l'état signalent un déploiement stable, en fonction de la valeur du délai avant expiration à 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 ce délai pour un déploiement stable. Si ce délai est dépassé avant que le déploiement ne soit stable, le déploiement é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 déploiement unique, mais de tolérer les échecs jusqu'à l'expiration de statusCheckDeadlineSeconds. Ce paramètre peut être utile dans les cas où des ressources pourraient 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 Cloud Service Mesh, le déploiement peut échouer et afficher 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 n'est compatible 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

• Apprenez-en davantage sur le déploiement sur GKE.

• Obtenez plus d'informations sur le déploiement sur Cloud Run.

• Apprenez-en davantage sur le déploiement sur GKE Enterprise.

• Découvrez comment créer votre pipeline de livraison et vos cibles.

• Découvrez comment promouvoir un titre