Aller au contenu

Référence des variables et des secrets

Écrans, champs, formats, clés fournies par la plateforme, sources d'une variable et limites de la configuration des services.

RéférenceDéveloppeur
Voir en Markdown

La configuration des services se gère depuis la console Wakastart. Il n'existe pas d'API publique pour ces opérations.

Écrans

ÉcranChemin dans la consoleAccès
Variables consomméesApp > Architecture > Services > serviceDroit « Infra Client »
Configuration (pool)App > Environnements > environnement > onglet Configuration« Gérer les variables » pour une variable, « Gérer les secrets » pour un secret ; plus « Accès infrastructure en production » en prod
Configuration du serviceEnvironnement > Services > service > onglet Configuration du serviceDroit « Infra Client »
Ce qu'il reste à configurerEnvironnement > onglet RésuméDroit « Infra Client »

Variable consommée

ChampFormatDéfautNotes
Mode de consommationVariable d'environnement ou Fichier montéVariable d'environnement—
Nom de variable^[A-Z][A-Z0-9_]*$, 255 caractères au plus—Obligatoire en mode variable ; unique dans la définition
Valeur par défautTexte, sans modèle {{ … }}—Stockée en clair, commune à tous les environnements
Chemin de montageChemin absolu, ^/[a-zA-Z0-9._/-]+$, sans / final, 255 caractères au plus—Obligatoire en mode fichier ; nom de fichier compris
Permissions0400, 0440, 0444, 0600, 06440400Mode fichier
Description500 caractères au plus——

Entrée du pool

ChampVariableSecret
Nom^[A-Z][A-Z0-9_]*$, 255 caractères au plus, unique dans l'environnementIdem
ValeurTexte, obligatoireTexte ou fichier (900 Ko au plus, encodé en base64), obligatoire
Description500 caractères au plusIdem
StockageEn clairCoffre de l'application, chiffré
Valeur relisibleOuiNon
ModificationNonRemplacer la valeur du secret
FiltreSource affichéeContenu
UtilisateurutilisateurVos variables en clair
SecretsecretVos secrets
PlateformeplateformeVariables communes à toute la plateforme, définies par Wakastart
AutoautoValeurs calculées pour l'environnement
BasebaseChamps des bases de données de l'environnement
StockagestockageChamps des buckets de l'environnement
HarborharborIdentifiants du registre d'images, utilisés par la plateforme

Sources d'une variable dans la configuration du service

Choix à l'écranType de source
Utiliser la valeur par défautValeur par défaut de la définition, sinon variable absente
Saisir une valeur libreValeur saisie, modèles {{ CLE }} résolus sur les entrées non sensibles
Entrée utilisateurVariable en clair de l'environnement
Entrée secretSecret de l'environnement
Entrée plateformeVariable de la plateforme
Entrée autoValeur calculée
Entrée baseChamp d'une base de données
Entrée stockageChamp d'un bucket

Un Fichier monté n'accepte qu'un secret déposé en fichier.

Valeurs fournies par la plateforme

<SERVICE>, <BASE> et <BUCKET> désignent l'identifiant court de la définition, en majuscules, tirets remplacés par _.

Valeurs calculées (auto)

CléValeurExemple
WAKASTART_APP_NAMEIdentifiant court de l'appmonapp
WAKASTART_ENV_SLUGSlug de l'environnement (<nom court>-<type>)stg-staging
WAKASTART_NAMESPACEEspace de noms de l'environnement dans le clusterwakapp-ab12cd-stg-staging
SVC_<SERVICE>_URLURL interne du service déployéhttp://svc-ab12cd-stg-staging-api.wakapp-ab12cd-stg-staging.svc.cluster.local:3000
SVC_<SERVICE>_HOSTNom d'hôte interne du servicesvc-ab12cd-stg-staging-api.wakapp-ab12cd-stg-staging.svc.cluster.local
SVC_<SERVICE>_PORTPort déclaré dans la définition du service3000
ROUTE_<SERVICE>_URLURL publique de la première route vers le service : https://, nom d'hôte préfixe compris, puis chemin de la route (/ pour la racine)https://app.staging.exemple.fr/api
ROUTE_<SERVICE>_URL_2, _3…URLs des routes suivantes vers le même service—

Les clés SVC_* existent pour chaque service déployé dans l'environnement. Les clés ROUTE_* existent pour chaque route déclarée dans l'architecture sur une URL qui a un domaine, qu'elle soit en ligne ou non.

Champs d'une base (base)

CléContenuSensible
<BASE>_URLURL de connexion complèteOui
<BASE>_HOSTHôteNon
<BASE>_PORTPortNon
<BASE>_DATABASENom de la baseNon
<BASE>_USERNAMEUtilisateurNon
<BASE>_PASSWORDMot de passeOui
<BASE>_SSL_MODEMode SSLNon

Champs d'un bucket (stockage)

CléContenuSensible
<BUCKET>_S3_URLURL S3 du bucketOui
<BUCKET>_ENDPOINTEndpoint S3Non
<BUCKET>_REGIONRégionNon
<BUCKET>_BUCKETNom du bucketNon
<BUCKET>_ACCESS_KEY_IDClé d'accèsNon
<BUCKET>_SECRET_ACCESS_KEYClé secrèteOui

Les entrées sensibles ne sont jamais affichées et ne peuvent pas être citées dans une valeur libre.

Limites

ÉlémentValeur
Taille d'un secret déposé en fichier900 Ko
Rafraîchissement de la copie d'un secret dans le clustertoutes les heures
Prise en charge d'un changement de configurationdemandes explicites toutes les 10 s
Une source par variable consommée et par service—
Nom d'une variable en clair suppriméereste réservé dans l'environnement