Templates
Un template est une stack Kuploy prête à l'emploi — une spécification de stack autonome, accompagnée d'une fiche de catalogue — que vous déployez en un clic. Le catalogue se parcourt depuis votre tableau de bord Kuploy. La galerie publique est sur kuploy.app/templates.
Un template met en place une stack entière — une ou plusieurs applications avec leurs bases de données, reliées entre elles — et non un service isolé. Voyez Stacks pour savoir ce qu'est une stack.
Déployer un template en un clic
Depuis l'environnement d'un projet :
- Ouvrez l'onglet Stacks puis cliquez sur Templates.
- Choisissez un template et cliquez sur Deploy.
Kuploy met alors en place tous les composants déclarés par le template — applications et bases de données — génère les secrets nécessaires, attribue les domaines requis et déploie la stack. Vous arrivez sur la page de la nouvelle stack pour en suivre la mise en ligne.
En coulisses, la spécification de stack du catalogue est exécutée en mode provisionnement : les services sont créés de zéro, vous n'avez donc rien à préparer.
Importer depuis la galerie (manuellement)
Vous pouvez aussi parcourir kuploy.app/templates, ouvrir un template et choisir Import into Kuploy pour en copier la spécification de stack (YAML). Collez une spécification de stack (YAML) dans Stacks → Import, depuis votre environnement. La fenêtre d'import propose deux modes :
- Provision new services — crée chaque composant à partir de la spécification, exactement comme le déploiement en un clic. C'est le mode d'un déploiement neuf.
- Wire existing services — rapproche les composants de services qui existent déjà dans l'environnement, par leur nom ; il ne crée rien. C'est le mode pour envelopper dans une stack des services que vous exploitez déjà.
Niveaux d'accès
Chaque template porte un niveau d'accès, son access :
| Niveau | Qui peut le déployer |
|---|---|
free | Tout le monde. |
pro / cloud | Nécessite une offre payante active. |
Si vous tentez de déployer un template payant que votre offre ne couvre pas, Kuploy affiche une invitation à passer à une offre supérieure au lieu de déployer. C'est l'exploitant de votre plateforme qui décide quelles offres donnent accès à quels templates — voir Offres et consommation.
Particularités de certains templates
Certaines stacks ont besoin d'autre chose que du HTTP. LiveKit (WebRTC), par exemple, demande des ports UDP et un chemin TURN joignable depuis les clients. Avant une mise en production, consultez les liens du template et la documentation du projet amont pour en connaître les contraintes réseau.
Publier un template
Vous souhaitez ajouter un template au catalogue ? Tout se passe dans le dépôt
kuploy/kuploy-templates — son fichier
docs/AUTHORING.md
décrit le schéma du catalogue, les spécifications autonomes et les niveaux d'accès.