Pour accélérer votre développement local dans Cloud Code pour VS Code, tirez parti de la synchronisation des fichiers, du hot reload, du déploiement automatique à l'enregistrement et de l'utilisation des modules Skaffold pour développer des parties d'une application séparément.
Activer la synchronisation des fichiers Skaffold et le hot reload
Pour améliorer l'efficacité de votre workflow de développement local et éviter de devoir recompiler, redéployer et redémarrer vos pods, Skaffold permet de copier les fichiers modifiés dans un conteneur déployé. Cela signifie que lorsque vous apportez des modifications à des fichiers statiques et de code source, celles-ci prennent effet en quelques secondes, ce qui accélère la boucle de rétroaction.
Pour les fichiers statiques (tels que les fichiers HTML et CSS), ce comportement de copie de fichiers est appelé synchronisation de fichiers.
Pour les fichiers de code source, ce comportement est appelé rechargement à chaud et est compatible avec les types de fichiers suivants :
- Go : *.go
- Java: *.java, *.kt, *.scala, *.groovy, *.clj
- NodeJS : *.js, *.mjs, *.coffee, *.litcoffee, *.json
Une fois le hot reload configuré, Skaffold détecte les modifications apportées aux fichiers compatibles et les synchronise avec le conteneur en cours d'exécution sur votre cluster. Les modifications apportées aux types de fichiers incompatibles avec le hot reload déclenchent une recompilation de l'image et un redémarrage du pod.
La synchronisation automatique des fichiers et le rechargement à chaud sont activés par défaut lorsque vous utilisez Buildpacks comme compilateur préféré. Pour les autres compilateurs tels que Docker, vous pouvez spécifier une section sync
dans votre fichier skaffold.yaml
pour l'artefact que vous personnalisez.
Vous pouvez choisir l'un des paramètres de synchronisation suivants (par ordre de préférence) :
auto
: Skaffold configure automatiquement la synchronisation. (uniquement pour les artefacts Jib et Buildpacks). Il s'agit de la valeur par défaut pour Buildpacks.infer
: les destinations de chaque fichier modifié sont déduites du compilateur.manual
: vous devez spécifier les fichiers de votre espace de travail local et leur destination dans le conteneur en cours d'exécution.
L'exemple de section sync
suivant dans un fichier skaffold.yaml
spécifie une synchronisation manual
pour synchroniser tous les fichiers HTML /static-html
avec le dossier static
d'un conteneur:
build: artifacts: - image: gcr.io/k8s-skaffold/node-example context: node sync: manual: - src: 'static-html/*.html' dest: static
Pour en savoir plus sur la synchronisation des fichiers et la spécification des règles de synchronisation, consultez le guide Skaffold sur la synchronisation des fichiers.
Ajoutez de nouvelles fonctionnalités lors du développement sur Kubernetes
Après avoir configuré la synchronisation des fichiers et le hot reload, démarrez un cycle d'itération et ajoutez des fonctionnalités à votre projet. Vos modifications sont déployées sur votre cluster Kubernetes sans arrêter et supprimer le déploiement, sans créer ni ajouter manuellement des tags à l'image, ni mettre à jour le cluster.
Un cycle d'itération standard se présente comme suit:
Apportez une modification à votre projet. Par exemple, si vous utilisez l'application de livre d'or Java Cloud Code, ajoutez un nouveau point de terminaison à la classe
FrontendController
comme suit:Ouvrez le fichier
FrontendController.java
à partir desrc/main/java/cloudcode/guestbook/frontend
et ajoutez les éléments suivants:@RequestMapping("/greeting") @ResponseBody public String greeting(@RequestParam(value="name", defaultValue="World") String name) { return String.format("Hello from Kubernetes with IntelliJ, %s!", name); }
Ajoutez les importations nécessaires pour les nouvelles annotations,
RequestMapping
etResponseBody
.
Enregistrez vos modifications (
Ctrl
/Cmd+S
) ou créez le projet.Vous pouvez suivre les journaux de progression et de déploiement dans la fenêtre de la console. Une fois les modifications déployées, confirmez les mises à jour.
Pour mettre fin à la session de développement continu, cliquez sur l'icône Arrêter.
Cloud Code supprime toutes les ressources Kubernetes utilisées pour la session de développement.
Développer des applications de microservices à l'aide de configurations Skaffold
Lors du développement d'applications de microservices, il peut être utile de travailler sur des sections distinctes indépendamment pour simplifier le débogage et le déploiement.
Vous pouvez développer et déboguer des parties de votre application indépendamment en la divisant en modules Skaffold. Par exemple, l'exemple Bank of Anthos est une application contenant dix microservices. Le fichier skaffold.yaml
de l'exemple regroupe ces services en cinq modules Skaffold nommés setup
, db
, frontend
, backend
et loadgenerator
.
Définir les modules Skaffold et les dépendances de configuration
Pour définir des modules Skaffold et des dépendances de configuration, procédez comme suit :
Ouvrez le projet dans lequel vous souhaitez définir les modules.
Ouvrez le fichier
skaffold.yaml
.Si votre fichier
skaffold.yaml
comporte plusieurs configurations, spécifiez la ligne suivante pour créer une configuration en tant que module Skaffold:metadata: name: MODULE_NAME_1
Par exemple, dans le
skaffold.yaml
Bank of Anthos, le moduledb
définit les déploiements de bases de données:Pour les configurations qui reposent sur une autre configuration en cours de déploiement avant que la configuration actuelle puisse être déployée, vous devez ajouter la configuration à vos dépendances. Pour spécifier une dépendance de configuration, ajoutez une liste
configs
à la sectionrequires
de votre fichierskaffold.yaml
.Par exemple, le fichier
skaffold.yaml
de Bank of Anthos inclut la dépendance de configurationsetup
.Pour définir une dépendance, ajoutez ce qui suit à votre fichier
skaffold.yaml
, où DEPENDENCY_NAME est le nom de votre dépendance.requires: - configs: DEPENDENCY_NAME
Les configurations répertoriées de cette manière peuvent référencer des dépendances définies dans le même fichier ou d'autres fichiers
skaffold.yaml
du projet actuel.Testez vos dépendances de configuration en compilant chacun des modules Skaffold séparément pour vous assurer qu'ils sont déployés avec leurs dépendances. Pour ce faire, suivez les étapes décrites dans la section Créer des modules Skaffold spécifiques et leurs dépendances.
Créer des modules Skaffold spécifiques et leurs dépendances
Après avoir défini vos modules et leurs dépendances, vous pouvez spécifier les modules que vous souhaitez exécuter avec le code cloud dans votre fichier launch.json
.
Si aucun fichier launch.json
n'est défini pour votre projet, lorsque vous exécutez Cloud Code: Run on Kubernetes ou Cloud Code: Debug on Kubernetes, vous êtes invité à sélectionner les modules à compiler:
- Ouvrez la palette de commandes (
Ctrl
/Cmd
+Shift
+P
), puis exécutez Cloud Code: Run on Kubernetes (Cloud Code : Exécuter sur Kubernetes). - Cliquez sur Sélectionner des modules.
- Choisissez les modules que vous souhaitez déployer, puis cliquez sur OK. Chaque module est construit avec ses dépendances.
- Lorsque vous y êtes invité, choisissez un registre d'images puis appuyez sur
Enter
.
Si votre projet possède un launch.json
, procédez comme suit pour choisir les modules Skaffold à compiler:
Ouvrez le fichier
launch.json
de votre projet.Modifiez la configuration de lancement pour ajouter l'option
skaffoldFlags
avec une liste demodules
séparées par des virgules à compiler. SiskaffoldFlags
est omis, tous les modules sont compilés.{ "name": "Run on Kubernetes", "type": "cloudcode.kubernetes", "request": "launch", "skaffoldConfig": "${workspaceFolder}/skaffold.yaml", "skaffoldFlags": { "modules": ["MODULE_NAME_2,MODULE_NAME_2"], "watch": true, "cleanUp": true, } }
Exécutez la configuration de lancement que vous avez modifiée.
Développement continu sur Kubernetes
Une fois que vous avez configuré votre cible d'exécution avec les options de votre choix, vous pouvez opter pour une exécution régulière de votre application ou démarrer un cycle d'itération de développement sur votre IDE pour propager les modifications apportées à votre source et vos dépendances à votre application active.
La cible d'exécution Exécuter sur Kubernetes lance le cycle de développement sur votre cluster Kubernetes. Une fois le cycle de développement lancé, Cloud Code crée, à l'aide de Skaffold, une image pour le projet, ajoute un tag, la transfère vers le dépôt configuré et utilise kubectl pour déployer les fichiers manifestes Kubernetes du projet.
- Personnalisez votre déploiement à l'aide des options de configuration disponibles.
- Si votre application est configurée pour utiliser des modules Skaffold, vous pouvez sélectionner des modules spécifiques à compiler ou à déployer.
- Ouvrez la palette de commandes (
Ctrl
/Cmd
+Shift
+P
), puis exécutez la commande Cloud Code : Run on Kubernetes (Cloud Code : Exécuter sur Kubernetes). - Confirmez que vous souhaitez utiliser le contexte Kubernetes actuel pour exécuter l'application (ou basculez vers le contexte de votre choix). Pour en savoir plus sur la définition d'un contexte Kubernetes, consultez la section Définir la configuration.
Si vous avez choisi un cluster distant comme contexte, choisissez un registre d'images vers lequel transférer les images lorsque vous y êtes invité. Si vous utilisez Container Registry, vous pouvez accéder à un registre existant ou spécifier le nom d'un registre à créer. Si l'API Artifact Registry est activée et au moins un dépôt Artifact Registry pour votre projet, vous pouvez parcourir et sélectionner un dépôt Artifact Registry existant.
Cloud Code crée ensuite vos conteneurs, les transfère dans le registre, applique les configurations Kubernetes au cluster et attend le déploiement.
Étapes suivantes
- Utilisez le cluster Minikube intégré de Cloud Code pour le développement local.
- Déboguer votre application dans Cloud Code
- Découvrez en détail la fonctionnalité de synchronisation de fichiers de Skaffold.