Les conventions de nommage
Introduction
Lorsque le nombre de ressources Azure augmente, des noms définis sans règle commune rendent leur identification plus difficile. Une convention de nommage permet d'attribuer des noms qui donnent des informations sur les ressources. Cela permet de faciliter leur recherche dans le portail Azure et leur utilisation dans les scripts de déploiement.
Microsoft propose des recommandations dans le CAF (Cloud Adoption Framework). Chaque entreprise utilisant Azure peut les adapter à ses besoins, tout en respectant les contraintes techniques imposées par les services Azure.
Les principaux éléments des noms
Une convention peut combiner plusieurs informations pour décrire une ressource. Le tableau suivant présente les principaux éléments et des exemples de valeurs :
| Élément | Rôle | Exemples |
|---|---|---|
| Type de ressource | Identifier la nature de la ressource | vm, vnet, st |
| Application ou projet | Identifier l'application ou le projet auquel la ressource contribue | boutique, facturation |
| Environnement | Distinguer les environnements | dev, test, prod |
| Région | Identifier la région de déploiement, lorsque cette information est pertinente | frc, weu |
| Numéro d'instance | Distinguer plusieurs ressources ayant les mêmes caractéristiques | 001, 002 |
Ces éléments correspondent aux éléments de nommage proposés par Microsoft. Leur ordre et leur présence doivent être définis dans la convention de l'organisation. Dans les exemples donnés dans ce chapitre, frc désigne la région France Central et weu la région West Europe. Ces abréviations sont des choix propres à la convention présentée. Nous pouvons aussi ajouter un aspect fonctionnel, comme web, api ou data, s'ils permettent de distinguer les ressources d'une même application.
La structure du nom
Pour les ressources qui autorisent les tirets, la convention retenue dans ce chapitre est la suivante :
Par exemple :
Ce nom désigne :
-
vm: une machine virtuelle -
boutique: l'application concernée -
prod: l'environnement de production -
frc: la région France Central -
001: le numéro de l'instance
L'application de cette structure permet de construire d'autres noms :
| Ressource | Exemple de nom |
|---|---|
| Machine virtuelle de développement | vm-boutique-dev-frc-001 |
| Machine virtuelle de production | vm-boutique-prod-frc-001 |
| Deuxième machine virtuelle de production | vm-boutique-prod-frc-002 |
| Réseau virtuel de production | vnet-boutique-prod-frc-001 |
Tous les éléments ne sont pas indispensables pour toutes les ressources. Par exemple, on peut choisir rg-boutique-prod pour un groupe de ressources réunissant les ressources de production de l'application, y compris lorsqu'elles sont réparties dans plusieurs régions.
Les abréviations des types de ressources
Microsoft publie une liste d'abréviations recommandées qui permettent de conserver des noms relativement courts et d'utiliser un vocabulaire commun.
| Type de ressource | Abréviation recommandée |
|---|---|
| Groupe de ressources | rg |
| Machine virtuelle | vm |
| Groupe de machines virtuelles identiques (VM Scale Set) | vmss |
| Réseau virtuel | vnet |
| Sous-réseau | snet |
| Interface réseau | nic |
| Adresse IP publique | pip |
| Groupe de sécurité réseau | nsg |
| Application web (App Service) | app |
| Application de fonctions (Azure Functions) | func |
| Compte de stockage | st |
| Azure Key Vault | kv |
| Azure Application Gateway | agw |
| Registre de conteneurs (Azure Container Registry) | cr |
Ces abréviations sont des recommandations et leur utilisation doit être documentée, afin que les personnes intervenant sur l'environnement Azure puissent interpréter les noms de la même manière.
Les contraintes techniques à respecter
Une convention doit tenir compte des règles propres à chaque type de ressource. Azure impose notamment des restrictions concernant :
-
La longueur minimale et maximale du nom
-
Les caractères autorisés
-
Les caractères autorisés au début ou à la fin du nom
-
Le périmètre dans lequel le nom doit être unique
Un format accepté pour une ressource peut être refusé pour une autre. Il est donc nécessaire de vérifier les règles du service avant de construire son nom.
Les caractères et la longueur
Un compte de stockage doit posséder un nom de 3 à 24 caractères, composé uniquement de lettres minuscules et de chiffres. Les tirets ne sont pas autorisés. La convention doit donc être adaptée :
Ce nom conserve les mêmes informations que les exemples précédents, sans les séparateurs.
Le périmètre d'unicité
Le périmètre d'unicité dépend du type de ressource.
| Ressource | Périmètre d'unicité du nom |
|---|---|
| Groupe de ressources | Dans l'abonnement |
| Machine virtuelle / Réseau virtuel | Dans le groupe de ressources, pour ce type de ressource |
| Sous-réseau | Dans le réseau virtuel |
| Compte de stockage | À l'échelle d'Azure |
Ainsi, deux réseaux virtuels peuvent porter le même nom s'ils appartiennent à des groupes de ressources différents. Cependant, un nom de compte de stockage déjà utilisé ne peut être utilisé de nouveau pour créer un autre compte. Pour les ressources dont le nom doit être mondialement unique, la convention peut prévoir un identifiant d'organisation ou un suffixe supplémentaire.
Le nom et les balises
Le nom doit permettre d'identifier rapidement la ressource. Les balises (tags), peuvent compléter cette identification avec des balises de gestion. Par exemple, nous pourrions associer à la machine virtuelle vm-boutique-prod-frc-001, les balises suivantes :
| Balise | Valeur d'exemple |
|---|---|
Application |
boutique |
Environment |
prod |
OwnerTeam |
ecommerce |
CostCenter |
cc042 |
Dans cet exemple, le nom facilite l'identification visuelle et les balises permettent d'organiser la gestion des ressources. La plupart des ressources Azure ne peuvent pas être renommées après leur création. C'est pourquoi, il est préférable de réserver le nom avec informations stables et d'utiliser les balises pour les informations susceptibles d'évoluer.