> For the complete documentation index, see [llms.txt](https://docs.verge.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.verge.io/automate-protect-and-extend/fr/automatisation/tenant-recipes.md).

# Recettes locataire

Les recettes de locataire permettent d’automatiser le déploiement des locataires. Une recette de locataire peut inclure tout ce qui est nécessaire pour créer une nouvelle instance de locataire entièrement fonctionnelle, notamment : les paramètres du locataire, la configuration réseau, les machines virtuelles incluses, ainsi que l’automatisation de tâches telles que la création de mots de passe aléatoires, la définition de noms d’hôte/mots de passe/noms d’utilisateur uniques, l’enregistrement des entrées DHCP et DNS, l’envoi de notifications, et bien plus encore. Cette page vous guidera à travers le processus de base de création et d’utilisation des recettes de locataire.

**Avantages de l’utilisation des recettes de locataire :**

* Déploiement rapide de locataires entiers
* Cohérence entre les configurations des locataires
* Réduction du temps de configuration manuelle, réduisant par conséquent la possibilité d’erreur humaine
* Images dorées pour la conformité

## Créer une recette de locataire

1. **Créez un locataire qui servira de modèle de base.** Une recette de locataire est basée sur un locataire qui sert de modèle de départ. Créez le locataire de manière à inclure les paramètres, les VM et les réseaux qui doivent faire partie de la configuration générique. Le locataire doit être arrêté avant la création de la recette.

{% hint style="success" %}
**Un locataire utilisé comme base d’une recette doit être dédié à cet usage. Si vous souhaitez baser une recette sur un locataire déjà en utilisation, vous pouvez travailler à partir d’un clone de l’original. Veillez à supprimer toute information spécifique, telle que les mots de passe, les noms d’utilisateur particuliers, les données client, etc., de l’instance du locataire cloné avant de l’utiliser comme modèle de recette.**
{% endhint %}

2. Accédez à la **Tableau de bord des recettes de locataire** (Référentiels > Recettes de locataire).
3. Cliquez sur **Nouveau** dans le menu de gauche.
4. Configurer la recette de locataire **champs :**

   * **Nom :** Utilisez un nom qui identifie suffisamment la recette pour aider les utilisateurs à trouver les recettes appropriées.
   * **Description :** (facultatif) Vous pouvez stocker ici des informations supplémentaires sur la recette. Cela peut être un bon endroit pour fournir une documentation de base sur l’objectif prévu et des निर्देश générales.
   * **Icône :** (facultatif) une icône Font Awesome peut être associée à la recette. Les icônes peuvent aider les utilisateurs à identifier facilement différentes recettes/types de recettes. Une liste des icônes disponibles est accessible à [FontAwesome](https://fontawesome.com/v4/icons/) .
   * **Catalogue :** Sélectionnez un catalogue dans lequel stocker la recette. Les catalogues sont utiles pour organiser les recettes. Voir [Organisation des recettes](/automate-protect-and-extend/fr/automatisation/recipes-organization.md) pour plus d’informations sur les catalogues.
   * **Locataire :** Sélectionnez le locataire qui servira de base à la recette.
   * **Version :** Ce champ sera automatiquement incrémenté à chaque modification de la recette, afin d’aider au suivi des changements. La valeur par défaut est 1.0.0, mais elle peut être modifiée si vous souhaitez commencer le versionnement avec un autre nombre.

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>Numérotation des versions</strong></p><p>Un numéro de version de 1.0.0 serait incrémenté en 1.0.0-1 puis 1.0.0-2, et ainsi de suite. De plus, vous pouvez modifier manuellement le numéro de version pour refléter des changements de version plus importants, par exemple passer la version à 2.0.0 après avoir apporté des modifications importantes à la recette.</p></div>

   * **Conserver les certificats SSL :** Lorsqu’elle est sélectionnée, les certificats SSL installés dans le locataire de base sont copiés vers les instances de locataire créées avec la recette.
   * **Dépendances de version :** (non applicable aux recettes qui ne seront utilisées que sur le système local et ses propres locataires). Des dépendances peuvent être spécifiées lorsque certaines fonctionnalités VergeOS sont requises pour que la recette fonctionne correctement (afin d’empêcher qu’un système distant utilise une recette qu’il ne peut pas prendre en charge).
5. Cliquez sur **Soumettre** pour enregistrer la recette. Le tableau de bord de la recette de locataire indiquera où les questions de la recette peuvent être personnalisées.

## Questions

Les questions fournissent des valeurs de personnalisation pour les locataires individuels créés avec une recette, en capturant des entrées de l’utilisateur ou en interagissant avec la base de données VergeOS. Une recette de locataire inclura automatiquement des questions système. Certaines de ces questions sont désactivées par défaut et devront être activées si vous souhaitez les utiliser.

**(Facultatif) Activer la ou les questions désactivées par défaut :**\
Cliquez sur **Questions** (menu de gauche ou carte du tableau de bord), **sélectionnez la ou les question(s)**, puis cliquez sur **Activer** dans le menu de gauche.

{% hint style="success" %}
**Les questions système peuvent être désactivées, mais ne peuvent pas être supprimées.**
{% endhint %}

Pour configurer des questions supplémentaires, cliquez sur **Questions** dans le menu de gauche, puis sur **Nouveau**.

**Champs de la question**:

* **Section :** Les sections vous permettent de regrouper vos questions sur le formulaire de saisie. Certaines sections sont créées automatiquement et vous pouvez créer des sections supplémentaires pour vos questions depuis le tableau de bord de la recette de locataire.
* **Nom :** sert de nom de variable pouvant être référencé dans les scripts ; utilisez un nom descriptif pour faciliter la maintenance et le dépannage des scripts ; uniquement des caractères alphanumériques, sans espaces ni caractères spéciaux.
* **Type :** détermine comment les données sont collectées : via la saisie utilisateur, l’interaction avec la base de données VergeOS, etc.
* **ID de l’ordre :** utilisé pour déterminer l’ordre dans lequel les questions sont affichées, dans la section sélectionnée.
* **Affichage :** l’étiquette textuelle affichée sur le formulaire de saisie utilisateur pour la question
* **Valeur par défaut :** (facultatif) définit une valeur de réponse initiale pour la question
* **Validation Regex :** (facultatif) chaîne d’expression régulière utilisée pour valider la saisie (syntaxe Regex standard)
* **Texte de remplacement :** (facultatif) texte grisé affiché pour donner à l’utilisateur un exemple de la saisie attendue
* **Texte d’info-bulle :** (facultatif) texte d’aide utilisateur affiché dans une fenêtre contextuelle lorsque le champ est survolé à la souris
* **Texte de note :** (facultatif) texte d’aide utilisateur affiché directement sous le champ de saisie pour fournir des indications supplémentaires.
* **À la modification :** permet de masquer/afficher d’autres questions lorsque ce champ est modifié. (Un exemple de code est affiché dans ce champ lors de la création d’une nouvelle question.)

Des options de configuration supplémentaires peuvent être disponibles selon le type sélectionné.

### Interaction avec la base de données VergeOS

Certains types de questions vous permettent de rechercher des informations dans la base de données ou de créer/modifier des enregistrements de la base de données. Remarquez le texte de remplacement (texte grisé affichant un exemple de saisie) lors de la configuration des questions d’interaction avec la base de données pour obtenir des indices. Ces articles de la base de connaissances fournissent des informations supplémentaires sur l’utilisation de la base de données VergeOS : [Description des tables de l’API](/knowledge-base/fr/automation-api/api-tables-description.md) et [Le guide de l’API](/knowledge-base/fr/automation-api/verge-api-guide.md)

#### Contexte de base de données

Le *Contexte de base de données* le champ vous permet de choisir d’interagir avec la base de données locale (le système parent) ou la base de données du locataire nouvellement créé. Cela s’applique aux types de questions : *Création en base de données, modification en base de données et recherche en base de données*.

### Référence des questions système

Lorsqu’une recette de locataire est créée, le système génère automatiquement un ensemble de questions intégrées organisées en sections. Bon nombre de ces questions sont **désactivées par défaut** et doivent être activées si vous souhaitez les utiliser. Les questions système ne peuvent pas être supprimées, mais elles peuvent être activées ou désactivées.

Pour activer une question système désactivée : accédez à **Questions** (menu de gauche ou carte du tableau de bord), **sélectionnez la ou les question(s)**, puis cliquez sur **Activer** dans le menu de gauche.

#### Section Locataire

Ces questions contrôlent les paramètres principaux du locataire, tels que l’identité, les identifiants administrateur et la configuration SSL.

| Nom                          | Affichage                            | Type               | Par défaut | Activé par défaut |
| ---------------------------- | ------------------------------------ | ------------------ | ---------- | ----------------- |
| YB\_URL                      | URL                                  | Chaîne             |            | Oui               |
| YB\_DESCRIPTION              | Description                          | Zone de texte      |            | Oui               |
| YB\_USER\_NAME               | Utilisateur administrateur           | Chaîne             | admin      | Oui               |
| YB\_USER\_PASSWORD           | Mot de passe                         | Mot de passe       |            | Oui               |
| YB\_USER\_EMAIL              | E-mail                               | Chaîne             |            | Non               |
| YB\_USER\_CHANGE\_PASSWORD   | Exiger le changement de mot de passe | Booléen            | false      | Non               |
| YB\_EXPOSE\_CLOUD\_SNAPSHOTS | Exposer les instantanés système      | Booléen            | true       | Non               |
| YB\_HELP\_URL                | URL d’aide                           | Chaîne             | par défaut | Non               |
| YB\_THEME\_ACCESS            | Accès au thème                       | Liste              | host\_only | Oui               |
| YB\_SPECIFIED\_THEME         | Thème                                | Sélection de ligne |            | Oui               |
| YB\_CLUSTER                  | Cluster                              | Cluster            |            | Non               |
| YB\_CERT\_TYPE               | Type de certificat SSL               | Masqué             | manuel     | Non               |
| YB\_CERT\_DOMAIN             | Domaine du certificat SSL            | Chaîne             |            | Non               |
| YB\_CERT\_PUBLIC             | Certificat SSL public                | Zone de texte      |            | Non               |
| YB\_CERT\_PRIVATE            | Certificat SSL privé                 | Zone de texte      |            | Non               |
| YB\_CERT\_CHAIN              | Chaîne de certificats SSL            | Zone de texte      |            | Non               |

#### Section Nœuds

Ces questions définissent les ressources de calcul allouées au(x) nœud(s) du locataire.

| Nom                            | Affichage                        | Type    | Par défaut | Activé par défaut |
| ------------------------------ | -------------------------------- | ------- | ---------- | ----------------- |
| YB\_NODE\_1\_CPU\_CORES        | Cœurs du nœud 1                  | Nombre  | 8          | Oui               |
| YB\_NODE\_1\_RAM               | RAM du nœud 1                    | RAM     | 16384      | Oui               |
| YB\_NODE\_1\_INSTANCES         | Instances du nœud 1              | Nombre  | 1          | Non               |
| YB\_NODE\_1\_CLUSTER           | Cluster du nœud 1                | Cluster |            | Non               |
| YB\_NODE\_1\_CLUSTER\_FAILOVER | Cluster de basculement du nœud 1 | Cluster |            | Non               |

#### Section Réseau

Ces questions configurent les adresses réseau du locataire.

| Nom            | Affichage                             | Type                 | Par défaut | Activé par défaut |
| -------------- | ------------------------------------- | -------------------- | ---------- | ----------------- |
| YB\_NET\_1\_IP | Adresse IP de l’interface utilisateur | Adresse IP virtuelle |            | Oui               |
| YB\_NET\_2\_IP | Adresse IP                            | Adresse IP virtuelle |            | Oui               |

{% hint style="success" %}
**Ce sont les questions système par défaut à partir de VergeOS 26.1. Vous pouvez ajouter des questions personnalisées en plus de celles-ci pour capturer des informations supplémentaires telles que des dates d’expiration, des noms d’hôte personnalisés ou d’autres valeurs spécifiques au locataire.**
{% endhint %}

## Modifier une recette

Lorsque des modifications sont apportées à une recette, celle-ci doit être republiée afin que ces changements soient pris en compte. Le haut du tableau de bord de la recette affichera un message indiquant qu’elle doit être republiée pour que les changements prennent effet. Vous pouvez utiliser le **Republier** lien dans ce message ou cliquer sur Republier dans le menu de gauche.

{% hint style="success" %}
**Lorsque vous apportez des modifications et republiez une recette, les systèmes distants et les locataires ayant accès à la recette sont informés qu’une mise à jour est disponible (notification en haut du tableau de bord de la recette de locataire et case à cocher de mise à jour disponible) ; ils doivent mettre à jour la recette pour accéder aux modifications.**
{% endhint %}

## Utiliser une recette de locataire

### Créer un locataire à partir d’une recette

1. Depuis le menu supérieur, accédez à **Locataires** > **+ Nouveau locataire**.
2. Cliquez sur le **catalogue** souhaité depuis la section des catalogues à gauche.
3. Les recettes de locataire individuelles disponibles dans le catalogue sélectionné apparaîtront sur le côté droit. **Sélectionnez la recette souhaitée** et cliquez sur **Suivant** en bas de l’écran.
4. Les champs de saisie sont présentés tels que définis par les questions de la recette.
5. Saisissez/configurez les champs et cliquez sur **Soumettre** pour créer le nouveau locataire. La configuration des questions de la recette déterminera les champs requis et les autres validations de champ.

## Instances de recette

Une instance désigne un locataire spécifique associé à une recette de locataire. Lorsqu’un locataire est créé à partir d’une recette, il est considéré comme une instance de la recette jusqu’à ce qu’il soit supprimé ou détaché de la recette.

Cliquez sur **Instances** dans le menu de gauche du tableau de bord d’une recette de locataire pour accéder rapidement à une liste des locataires associés. Une recette ne peut pas être supprimée lorsqu’il existe des instances associées.

Les recettes permettent une grande variété de solutions potentielles. Contactez le support VergeOS pour obtenir une assistance supplémentaire afin d’automatiser les déploiements de vos locataires à l’aide de recettes.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.verge.io/automate-protect-and-extend/fr/automatisation/tenant-recipes.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.