Créer un cluster

Profiter des avantages d’une base de données PostgreSQL managée, c’est bénéficier d’une infrastructure optimisée où la gestion des ressources, des sauvegardes et des mises à jour est entièrement automatisée, tout en conservant la flexibilité et la performance de PostgreSQL sans les contraintes opérationnelles habituelles.

Concurrence des opérations

Un nom déjà utilisé par un cluster ne peut être réutilisé si le cluster en question est toujours actif.
Cette action peut être lancée seulement si le cluster en question n'a pas d'opération en cours. Pour rappel, toute opération est une demande qui impacte techniquement le cluster. Voici la liste des opérations:

• Création du cluster
• Gérer les masques réseau (CIDRs) autorisés
• Gérer les caractéristiques du cluster
• Réinitialisation du mot de passe admin
• Activation / désactivation du backup
• Suppression du cluster

Console

Créer un cluster sur la console NumSpot

astuce

Il est primordial de souligner qu'un cluster créé sera lié à l'espace de l'utilisateur et restera visible par le créateur du cluster et tous ceux qui ont le droit de lister les clusters sur le même espace.
Pour accorder l'accès à un autre utilisateur, il sera nécessaire de passer par l'API de gestion des accès.

Depuis la page Services Managés > PostgreSQL > Clusters qui liste les clusters, cliquez sur le bouton Créer un cluster.

La première étape de création d'un cluster apparaît.

Informations générales

1. Dans le champ Nom du cluster, tapez le nom de votre cluster.

   Nomenclature

   Le choix du nom n'a aucun impact technique sur le cluster, il est uniquement utile à l'utilisateur.

   Le nom doit respecter ces critères:

   • Être unique au sein de l'espace NumSpot auquel il appartient
   • Ne contenir que des caractères alphanumériques (a-z, 0-9) et des tirets (-)
   • Le premier caractère doit être (a-z)
   • Avoir une longueur comprise entre 1 et 63 caractères

2. Choisissez l'option de Backup souhaitée.

3. Dans le champ Login admin, saisissez un identifiant administrateur pour votre cluster.

   Nomenclature

   Le login admin doit respecter les critères suivants :

   • Ne contenir que des caractères alphanumériques (a-z, 0-9) et le caractère underscore (_)
   • Avoir une longueur comprise entre 3 et 32 caractères

4. (Optionnel) Ajouter des Tags.

   attention

   Veuillez noter que les tags ne pourront plus être modifiés une fois le cluster créé. Toutefois, la possibilité de gérer et de modifier les tags d’un cluster déjà existant sera prochainement disponible.

   Nomenclature

   Les tags n'ont aucun impact technique sur le cluster, il est uniquement utile à l'utilisateur. Il y a une limite de 20 tags par cluster. Un tag doit respecter ces critères:

   • La clé doit être unique au sein d'un cluster
   • La clé et la valeur ne doivent contenir que des caractères alphanumériques (a-z, A-Z, 0-9) et (_, -)
   • La clé et la valeur doivent avoir une longueur comprise entre 1 et 40 caractères

5. Cliquez sur Suivant pour passer au dimensionnement du cluster.

Dimensionnement du cluster

1. Dans le champ Nombre de vCPUs choisissez le nombre de vCPUs à attribuer au cluster.

2. Sélectionnez la performance de tous les vCPUs pour votre cluster.

3. Dans le champ RAM choisissez le volume de mémoire RAM à allouer à votre cluster.

4. Choisissez un Type de stockage.

Nomenclature

Vous pouvez choisir entre les types de stockage suivants :

• io1 : Si ce type est sélectionné, le champ IOPS s’affichera. Vous devrez alors spécifier une valeur comprise entre 100 et 13 000 IOPS.
• gp2 : Si ce type est sélectionné, aucun champ IOPS ne sera affiché.

Pour chaque type de stockage, vous devez également définir la taille du volume, comprise entre 10 et 500 GiB.

5. Cliquez sur Suivant pour passer à l'étape de Sécurité.

Sécurité

1. CIDR(s) autorisé(s) à communiquer avec le cluster (IPv4)

Nomenclature

• Indiquez une ou plusieurs plages d’adresses IP au format CIDR (par exemple : 192.168.0.0/24).
• Pour autoriser uniquement une adresse IP spécifique, utilisez le format /32 (par exemple : 192.168.1.10/32).
• Vous pouvez entrer jusqu’à 50 plages CIDR.
• Si vous souhaitez permettre l’accès à toutes les adresses IP, vous pouvez utiliser 0.0.0.0/0, mais cela expose votre cluster à toutes les sources. Il est recommandé d’utiliser cette option avec prudence.

2. Cliquez sur le bouton Créer le cluster pour lancer la création du cluster.

Création du cluster

Important

• Ces informations vous seront communiquées une seule fois lors de la création du cluster.
• Si vous quittez cette page sans les enregistrer, vous ne pourrez plus récupérer le mot de passe par la suite.

Nous vous recommandons d’utiliser le bouton “Copier le mot de passe” pour stocker ces informations de manière sécurisée. Ne partagez jamais ces identifiants avec des tiers.

Une fois vos identifiants enregistrés, le bouton Aller à la liste des clusters sera activé.

Créer un cluster à partir d'un backup

Depuis la page Services Managés > PostgreSQL > Backups qui affiche la liste des backups, il vous est possible de restaurer un backup en créant un cluster à partir de ce dernier.

1. Identifiez le backup à restaurer dans la liste des clusters

2. Cliquez sur le menu déroulant "Actions" situé au bout de la ligne du backup séléctionné

3. Choisissez l'option Créer un cluster à partir de ce backup du menu déroulant

4. Poursuivez la création du cluster.

API

astuce

Il est primordial de souligner qu'un cluster créé sera lié à l'espace de l'utilisateur et restera visible par le créateur du cluster et tous ceux qui ont le droit de lister les clusters sur le même espace.
Pour accorder l'accès à un autre utilisateur, il sera nécessaire de passer par l'API de gestion des accès.

Prérequis

• Un compte NumSpot
• Un espace NumSpot auquel le compte est associé
• Un compte avec le rôle Postgres Admin sur l'espace
• Un jeton de connexion associé au compte NumSpot utilisé

Ce qu'il faut savoir avant de créer un cluster

Administrateur du cluster

Le login admin est défini dans la requête de création du cluster et le mot de passe lié sera transmis dans la réponse à cette requête.

Masques réseaux (CIDR)

Le(s) masque(s) réseau(x) autorisés à accéder à la base PostgreSQL managée sont définis à la création du cluster au format CIDR.

Nomenclature du nom de cluster

L'utilisateur a la possibilité de définir un nom au cluster pour le reconnaître plus facilement. Le choix du nom n'a aucun impact technique sur le cluster, il est uniquement utile à l'utilisateur. Les noms de cluster sont propres à chaque espace NumSpot. Il est possible de réutiliser le nom d'un cluster supprimé.

Création d'un cluster

Les données qu'il faut avoir

• SPACE_ID est l'identifiant de l'espace NumSpot dans lequel il est souhaité de créer le cluster
• REGION est la région dans laquelle l'espace NumSpot est associé, un espace est disponible qu'à partir d'une seule région
• ACCESS_TOKEN est le jeton (token) généré via la connexion (consulter la génération d'un token d'accès)

Requête de création d'un cluster

Exemple de requête: Création d'un cluster PostgreSQL

export REGION="myregion"
export SPACE_ID="myspaceid"
export ACCESS_TOKEN="myaccesstoken"

curl -X POST https://api.$REGION.numspot.com/postgresql/spaces/$SPACE_ID/clusters \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
  --data '{
    "name": "myCluster",
    "automaticBackup": true,
    "user": "admin",
    "nodeConfiguration": {
        "vcpuCount": 2,
        "performanceLevel": "MEDIUM",
        "memorySizeGiB": 4
    },
    "volume": {
        "type": "IO1",
        "sizeGiB": 10,
        "iops": 5000
    },
    "tags": [
        {"key": "Key2", "value": "Value3"}
    ],
    "allowedIpRanges": ["X.X.X.X/X"]
}'

1. Dans l'attribut name, spécifiez le nom de votre cluster.

Nomenclature

Le nom doit respecter ces critères :

• Être unique au sein de l'espace NumSpot auquel il appartient ;
• Les caractères autorisés sont a-z, A-Z, 0-9, tiret et tiret bas ;
• Un tiret ou tiret bas est forcément suivi d'au moins une lettre ou chiffre ;
• Le premier caractère doit être une lettre ou un chiffre ;
• La longueur doit être comprise entre 3 et 63 caractères inclus.

2. Dans l'attribut automaticBackup, spécifiez si vous souhaitez activer les backups automatiques. true pour activer les backups automatiques, false pour désactiver les backups automatiques.

3. Dans l'attribut user, spécifiez un identifiant administrateur pour votre cluster.

Nomenclature

Le login admin doit respecter les critères suivants :

• Ne contenir que des caractères alphanumériques (a-z, 0-9) et le caractère underscore (_)
• Avoir une longueur comprise entre 3 et 32 caractères

4. Dans l'attribut vcpuCount, spécifiez le nombre de coeurs virtuels associés au cluster (de 2 à 32),

5. Dans l'attribut performanceLevel, spécifiez la performance de tous les vCPUs pour votre cluster parmi les 3 options de capacité de calcul : MEDIUM / HIGH / HIGHEST.

6. Dans l'attribut memorySizeGiB, spécifiez le volume de mémoire RAM à allouer à votre cluster.

7. Dans l'attribut type, spécifiez un type de stockage. Vous pouvez choisir entre io1 et gp2. Si vous retenez l'option io1 pour le stockage de vos données, vous devez également définir le niveau d'IOPS que vous souhaitez allouer à votre cluster. Le niveau d'IOPS que vous demandez est soumis à quelques règles :

Info

• Performance minimale : 100 IOPS
• Performance maximale : 13 000 IOPS
• Ratio de performance maximale : 300 IOPS par Gio

8. Dans l'attribut sizeGiB, définissez la taille du volume, comprise entre 10 et 500 GiB.

9. (Optionnel) Ajoutez des tags.

attention

Veuillez noter que les tags ne pourront plus être modifiés une fois le cluster créé. Toutefois, la possibilité de gérer et de modifier les tags d’un cluster déjà existant sera prochainement disponible.

Nomenclature

Les tags n'ont aucun impact technique sur le cluster, il est uniquement utile à l'utilisateur.

Il y a une limite de 20 tags par cluster.

Un tag doit respecter ces critères :

• La clé doit être unique au sein d'un cluster ;
• La clé et la valeur ne doivent contenir que des caractères alphanumériques (a-z, A-Z, 0-9) et (_, -) ;
• La clé et la valeur doivent avoir une longueur comprise entre 1 et 40 caractères inclus ;

10. Dans l'attribut allowedIpRanges, déclarez le(s) CIDR(s) autorisé(s) à communiquer avec le cluster (IPv4)

Nomenclature

• Indiquez une ou plusieurs plages d’adresses IP au format CIDR (par exemple : 192.168.0.0/24).
• Pour autoriser uniquement une adresse IP spécifique, utilisez le format /32 (par exemple : 192.168.1.10/32).
• Vous pouvez entrer jusqu’à 50 plages CIDR.
• Si vous souhaitez permettre l’accès à toutes les adresses IP, vous pouvez utiliser 0.0.0.0/0, mais cela expose votre cluster à toutes les sources. Il est recommandé d’utiliser cette option avec prudence.

Si l'opération est refusée, consultez la réponse HTTP pour connaître la cause du refus.

Exemple de réponse : Création d'un cluster PostgreSQL managé

{
    "allowedIpRanges": ["X.X.X.X/X"],
    "automaticBackup": true,
    "createdOn": "2024-10-17T08:26:32Z",
    "id": "b95f6603-96f9-4c28-89c8-42555048afde",
    "lastOperationName": "CREATE",
    "lastOperationResult": "IN_PROGRESS",
    "name": "myCluster",
    "nodeConfiguration": {
        "memorySizeGiB": 4,
        "performanceLevel": "MEDIUM",
        "vcpuCount": 2
    },
    "password": "gOMsGFN~HdUuSCq9syfc.695Pao+H/}2",
    "status": "CREATING",
    "tags": [
        {"key": "Key2", "value": "Value3"}
    ],
    "user": "admin",
    "volume": {
        "sizeGiB": 10,
        "type": "GP2"
    }

• L'attribut lastOperationName indique que la dernière opération demandée est la création.
• L'attribut lastOperationResult indique que l’état actuel de la dernière opération demandée est en cours.
• L'attribut password est le mot de passe de l’utilisateur administrateur spécifié lors de la demande de création.

Important

• Le mot de passe admin ne sera communiqué qu'une seule fois lors de la création du cluster.
• Si vous ne l'enregistrez pas, vous ne pourrez plus récupérer le mot de passe par la suite.

Dès que la demande de création d'un cluster est reçue, et que le cluster en cours de création, il devient visible dans la liste des clusters de l'espace.

Exemple de requête: Lister ses clusters

export REGION="myregion"
export SPACE_ID="myspaceid"
export ACCESS_TOKEN="myaccesstoken"

curl -X GET https://api.$REGION.numspot.com/postgresql/spaces/$SPACE_ID/clusters \
    --header "Authorization: Bearer $ACCESS_TOKEN" \
    --header "Content-Type: application/json"

Créer un cluster à partir d'un backup

Il vous est possible de restaurer un backup en créant un cluster à partir de ce dernier.

Exemple de requête : créer un cluster à partir d'un backup

export REGION="myregion"
export SPACE_ID="myspaceid"
export ACCESS_TOKEN="myaccesstoken"
export BACKUP_ID="my_backup_id"

curl -X POST https://api.$REGION.numspot.com/postgresql/spaces/$SPACE_ID/clusters \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
  --data '{
    "name": "myCluster",
    "automaticBackup": true,
    "user": "admin",
    "nodeConfiguration": {
        "vcpuCount": 2,
        "performanceLevel": "MEDIUM",
        "memorySizeGiB": 4
    },
    "volume": {
        "type": "IO1",
        "sizeGiB": 10,
        "iops": 5000
    },
    "sourceBackupId": "$BACKUP_ID",
    "tags": [
        {"key": "Key2", "value": "Value3"}
    ],
    "allowedIpRanges": ["X.X.X.X/X"]
}