Démarrage rapide
Suivez ce guide pour commencer à créer une extension Docker de base. Le guide de démarrage rapide génère automatiquement des fichiers de base pour vous.
Prérequis
NoteNodeJS et Go ne sont requis que lorsque vous suivez le guide de démarrage rapide pour créer une extension. Il utilise la commande
docker extension init
pour générer automatiquement des fichiers de base. Cette commande utilise un modèle basé sur une application ReactJS et Go.
Dans les paramètres Docker Desktop, assurez-vous que vous pouvez installer l'extension que vous développez. Vous devrez peut-être naviguer vers l'onglet Extensions dans les paramètres Docker Desktop et désélectionner Autoriser uniquement les extensions distribuées via le Marketplace Docker.
Étape 1 : Configurer votre répertoire
Pour configurer votre répertoire, utilisez la sous-commande init
et fournissez un nom pour votre extension.
$ docker extension init <my-extension>
La commande pose une série de questions sur votre extension, comme son nom, une description, et le nom de votre dépôt Hub. Cela aide la CLI à générer un ensemble de fichiers de base pour vous aider à démarrer. Elle stocke les fichiers de base dans le répertoire my-extension
.
L'extension générée automatiquement contient :
- Un service backend Go dans le dossier
backend
qui écoute sur un socket. Il a un endpoint/hello
qui retourne une charge JSON. - Un frontend React dans le dossier
frontend
qui peut appeler le backend et afficher la réponse du backend.
Pour plus d'informations et de directives sur la construction de l'UI, voir la section Conception et style UI.
Étape 2 : Construire l'extension
Pour construire l'extension, déplacez-vous dans le répertoire nouvellement créé et exécutez :
$ docker build -t <name-of-your-extension> .
docker build
construit l'extension et génère une image nommée comme le dépôt hub choisi. Par exemple, si vous avez tapé john/my-extension
comme réponse à la question suivante :
? Hub repository (eg. namespace/repository on hub): john/my-extension`
Le docker build
génère une image avec le nom john/my-extension
.
Étape 3 : Installer et prévisualiser l'extension
Pour installer l'extension dans Docker Desktop, exécutez :
$ docker extension install <name-of-your-extension>
Pour prévisualiser l'extension dans Docker Desktop, une fois l'installation terminée, vous devriez voir un élément Démarrage rapide sous le menu Extensions. Sélectionner cet élément ouvre le frontend de l'extension.
TipPendant le développement de l'UI, il est utile d'utiliser le rechargement à chaud pour tester vos changements sans reconstruire toute votre extension. Voir Prévisualiser lors du développement de l'UI pour plus d'informations.
Vous pourriez également vouloir inspecter les conteneurs qui appartiennent à l'extension. Par défaut, les conteneurs d'extension sont cachés du tableau de bord Docker. Vous pouvez changer cela dans Paramètres, voir comment afficher les conteneurs d'extension pour plus d'informations.
Étape 4 : Soumettre et publier votre extension sur le Marketplace
Si vous voulez rendre votre extension disponible à tous les utilisateurs Docker Desktop, vous pouvez la soumettre pour publication dans le Marketplace. Pour plus d'informations, voir Publier.
Nettoyage
Pour supprimer l'extension, exécutez :
$ docker extension rm <name-of-your-extension>
Et ensuite
- Construire un frontend plus avancé pour votre extension.
- Apprendre comment tester et déboguer votre extension.
- Apprendre comment configurer CI pour votre extension.
- En savoir plus sur l'architecture des extensions.
- En savoir plus sur la conception de l'UI.