Variables de configuration

Les variables permettent de personnaliser le comportement du conteneur. Elles ont deux rôles principaux :

  1. Variables d’environnement : injectées directement dans le conteneur au moment du lancement.

  2. Formulaire dynamique : elles définissent les champs du formulaire dans la configuration des container profiles côté organisations. Les administrateurs d’organisation peuvent alors configurer des options (champs texte, cases à cocher, listes déroulantes, etc.) définies en amont par l’administrateur d’instance.

Important

  • Seules les variables marquées comme éditables apparaissent dans le formulaire de configuration côté organisation.

  • Les autres variables sont invisibles pour les administrateurs d’organisation et transmises en interne au conteneur.

../../_static/images/instance/images/instance_images_template_variable.png

Configuration des variables et propriétés associées.


Tip

UI Priority : Chaque variable possède une priorité d’affichage. Plus la valeur est élevée, plus le champ apparaîtra en haut du formulaire des options. Cela permet d’organiser les options dans un ordre spécifique et logique.

Options

Type

Le type du template, plusieurs types ont différentes utilitées, certains sont destinés à être configurable via les profiles, d’autres sont statiques.

  • STRING: Du texte

  • BOOLEAN: true/false (checkbox)

  • SELECT: Menu déroulant

  • SELECT_OPTION: Option du menu déroulant

  • SECRET: secret docker swarm

  • HOST: ajoute un enregistrement dans le fichier /etc/hosts du conteneur

Name

Le nom de la variable qui sera affiché dans un profile

Variable

Le nom de la variable d’environnement qui sera envoyé au conteneur ( option -e dans la ligne de commande docker )

Editable

Rendre editable cette variable par les comptes d’administration d’organisation

UI Priority

Permet d’organiser les champs d’un profile, plus l’UI priority est haute, plus le champ apparait en haut du profile. Permet aussi d’organiser les SELECT_OPTION, la plus haute valeur apparait le plus haut dans la liste

Hint

Phrase d’explication sous le champ du template dans un profile

Place Holder

Valeur en grisée dans un champ texte pour donner un exemple sans remplir ce champ dans un profile

Default Value

La valeur par défaut quand on créé un profile

Condition Variable + Condition Operator + Condition Value

Permet d’appliquer une condition sur l’utilisation d’un template en se basant sur la valeur d’un autre template et un opérateur. Par exemple, si je veux que le champ TEMPLATE_1 n’apparaisse que si TEMPLATE_2 == true je peux régler la condition comme ceci dans TEMPLATE_1:

Condition Variable: TEMPLATE_2
Condition Operator: EQUAL
Condition Value: true

Quelques exemples

  • Name: Home Page

  • Type: STRING

  • Variable: REEMO_HOME

  • Editable: true

  • UI Priority: 1000

  • Default Value: https://reemo.io

Ce champ apparait donc tout en haut d’un profile, s’appelle Home Page, a pour défaut https://reemo.io et va remplir la variable d’environnement REEMO_HOME pour le conteneur


  • Name: REEMO_NO_PROXY

  • Type: STRING

  • Variable: REEMO_NO_PROXY

  • Editable: false

  • Default value: true

  • Condition: REEMO_PROXY EQUAL NONE

Ce champ n’apparait pas dans un profile car non editable, il va remplir la variable d’environnement REEMO_NO_PROXY=true à condition que REEMO_PROXY == NONE


  • Name: REEMO_NO_PROXY (encore)

  • Type: STRING

  • Variable: REEMO_NO_PROXY

  • Editable: false

  • Default value: true

  • Condition: REEMO_PROXY EQUAL EXTERNAL

Ce champ n’apparait pas dans un profile car non editable, il va remplir la variable d’environnement REEMO_NO_PROXY=true à condition que REEMO_PROXY == EXTERNAL


  • Name: Embedded Proxy

  • Type: SELECT_OPTION

  • Variable: REEMO_PROXY

  • Value: EMBEDDED

  • UI Priority: 9

Ceci est une option de la liste déroulante de REEMO_PROXY, il apparait en deuxième dans la liste car sa priorité est entre 8 et 10 des 2 autres options, si cette valeur est choisi dans le menu déroulant alors il remplira REEMO_PROXY=EMBEDDED