Créer un projet

Vous pouvez créer un projet avec Cockpit et OKS CLI.

Une fois que vous avez créé votre premier projet, vous pouvez commencer à Gérer vos clusters.

Créer un projet avec Cockpit

  1. Dans le dashboard Projets, cliquez sur IconAddFull Créer un projet OKS.
    La boîte de dialogue CRÉER UN PROJET OKS apparaît.

  2. Dans le champ Nom, tapez un nom pour le projet.

    Le nom doit contenir entre 1 et 40 caractères alphanumériques et/ou tirets (-). Le nom doit commencer par une lettre minuscule et ne doit pas finir par un tiret.

  3. Dans le champ CIDR, tapez une plage d’IP, en notation CIDR, qui sera utilisée dans les Subnets du Net, pour toutes les VM sur lesquelles le cluster est utilisé.

    Une fois qu’un projet est créé, vous ne pouvez pas modifier son CIDR.

    • Le CIDR doit être un bloc privé inclus dans les plages RFC 1918. Pour en savoir plus, voir la documentation RFC 1918.

    • La taille minimale autorisée du CIDR est /23, et la taille maximale autorisée du CIDR est /16. Pour en savoir plus, voir À propos des Nets.

    • Le CIDR 172.31.0.0/16 est réservé à un usage interne et ne doit pas être utilisé.

  4. (optionnel) Dans le champ Description, tapez une description du projet.

  5. Cochez ou décochez la case Désactiver la suppression par API :

    • Si la case est cochée, vous ne pouvez pas supprimer le projet par API.

    • Si la case est décochée, vous pouvez supprimer le projet par API.

  6. Cliquez sur Créer.
    Le projet est créé.

Créer un projet avec OKS CLI

Avant de commencer : Installez et configurez OKS CLI. Pour en savoir plus, voir Installer et configurer OKS CLI.

La commande project create vous permet de créer un projet :

Exemple de requête
$ oks-cli project create \
    --project-name NAME_OF_PROJECT \
    --description "DESCRIPTION_OF_PROJECT" \
    --cidr "RANGE_OF_IP_ADDRESSES" \
    --tags "tag1=this,tag2=that" \
    --set net_specific.disable_lan_security_groups=false

Cette commande contient les options suivantes que vous devez spécifier :

  • project-name : Le nom du projet, d’une longueur maximale de 40 caractères alphanumériques et tirets (-). Ce nom doit commencer par une lettre minuscule et ne doit pas finir par un tiret.

  • (optionnel) description : Une description du projet.

  • (optionnel) cidr : Une plage d’IP en notation CIDR qui sera utilisée dans les Subnets du VPC, pour toutes les VM sur lesquelles le cluster est utilisé. Par défaut, 10.50.0.0/16.

    Une fois qu’un projet est créé, vous ne pouvez pas modifier son CIDR.

    • Le CIDR doit être un bloc privé inclus dans les plages RFC 1918. Pour en savoir plus, voir la documentation RFC 1918.

    • La taille minimale autorisée du CIDR est /23, et la taille maximale autorisée du CIDR est /16. Pour en savoir plus, voir À propos des Nets.

    • Le CIDR 172.31.0.0/16 est réservé à un usage interne et ne doit pas être utilisé.

  • (optionnel) output : Le format de sortie de la réponse (json | yaml). Par défaut, le format de la réponse est JSON.

  • (optionnel) tags : Un ou plusieurs tags associés au projet.

  • disable-api-termination : La possibilité de supprimer le projet via l’API. Si la valeur est true, la suppression du projet est désactivée. Si la valeur est false, elle est activée.

  • (optionnel) quirk : Les clés et paramètres avancés à transmettre au control plane du projet. Cette option est obligatoire pour les demandes d’activation de fonctionnalités.

  • (optionnel) filename : Le nom du fichier de définition à partir duquel vous souhaitez créer le projet.

  • (optionnel) set : Permet de définir des propriétés.

    • net_specific.disable_lan_security_groups : S’il est défini sur true, désactive les groupes de sécurité LAN pour le réseau du projet, modifiant ainsi le comportement par défaut du pare-feu au sein du VPC.

      Pour les charges de travail nécessitant une communication entre nodes à faible latence, la désactivation des groupes de sécurité LAN peut contribuer à réduire la latence.

La commande project create renvoie les éléments suivants :

  • id : L’identifiant unique du projet.

  • name : Le nom du projet.

  • description : La description du projet.

  • cidr : Le bloc CIDR alloué aux Subnets du VPC où les VM du cluster seront lancées.

  • region : La Région où le projet est déployé.

  • status : L’état actuel du projet.

    Un projet peut être dans l’un des états suivants :

    • pending : Les ressources sous-jacentes du projet sont en cours d’initialisation.

    • ready : Le projet est entièrement paramétré et prêt à être utilisé.

    • updating : Le projet est en cours de mise à jour.

    • failed : Le projet a rencontré une erreur. Pour y remédier, contactez notre équipe Support à l’adresse support@outscale.com.

    • deleting : Le projet est en cours de suppression, et ses ressources associées sont en train d’être nettoyées.

  • tags : Un ou plusieurs tags associés au projet.

  • net_specific : Un ensemble d’options de configuration spécifiques au réseau pour le projet.

    • disable_lan_security_groups : Indique si les groupes de sécurité LAN sont désactivés pour le projet.

  • disable-api-termination : La possibilité de supprimer le projet via l’API. Si la valeur est true, la suppression du projet est désactivée. Si la valeur est false, elle est activée.

  • created_at : La date et l’heure de la création du projet, au format UTC.

  • updated_at : La date et l’heure de la dernière mise à jour du projet, au format UTC.

  • deleted_at : La date et l’heure de la suppression du projet, au format UTC (null si le projet est encore actif).

Exemple de résultat
{
  "id": "12ca0d38-2927-4cf1-93de-049135f88f00",
  "name": "NAME_OF_PROJECT",
  "description": "DESCRIPTION_OF_PROJECT",
  "cidr": "10.50.0.0/16",
  "region": "eu-west-2",
  "status": "pending",
  "tags": {
    "tag1": "this",
    "tag2": "that"
  },
  "net_specific": {
    "disable_lan_security_groups": false
  },
  "disable_api_termination": false,
  "created_at": "2025-01-01T12:10:00.000000Z"
}

Créer un project avec un fichier manifeste

Avant de commmencer :

  1. Définissez la configuration de votre projet dans un fichier de manifeste YAML :

    Exemple de manifeste
    name: NAME_OF_PROJECT
    description: DESCRIPTION_OF_PROJECT
    cidr: RANGE_OF_IP_ADDRESSES
    region: REGION
    tags:
      tag1: this
      tag2: that
    disable_api_termination: false
    net_specific:
      disable_lan_security_groups: false

    Cette commande contient les options suivantes que vous devez spécifier :

    • project-name : Le nom du projet, d’une longueur maximale de 40 caractères alphanumériques et tirets (-). Ce nom doit commencer par une lettre minuscule et ne doit pas finir par un tiret.

    • (optionnel) description : Une description du projet.

    • (optionnel) cidr : Une plage d’IP en notation CIDR qui sera utilisée dans les Subnets du VPC, pour toutes les VM sur lesquelles le cluster est utilisé. Par défaut, 10.50.0.0/16.

      Une fois qu’un projet est créé, vous ne pouvez pas modifier son CIDR.

      • Le CIDR doit être un bloc privé inclus dans les plages RFC 1918. Pour en savoir plus, voir la documentation RFC 1918.

      • La taille minimale autorisée du CIDR est /23, et la taille maximale autorisée du CIDR est /16. Pour en savoir plus, voir À propos des Nets.

      • Le CIDR 172.31.0.0/16 est réservé à un usage interne et ne doit pas être utilisé.

    • (optionnel) output : Le format de sortie de la réponse (json | yaml). Par défaut, le format de la réponse est JSON.

    • (optionnel) tags : Un ou plusieurs tags associés au projet.

    • disable-api-termination : La possibilité de supprimer le projet via l’API. Si la valeur est true, la suppression du projet est désactivée. Si la valeur est false, elle est activée.

    • (optionnel) quirk : Les clés et paramètres avancés à transmettre au control plane du projet. Cette option est obligatoire pour les demandes d’activation de fonctionnalités.

    • (optionnel) filename : Le nom du fichier de définition à partir duquel vous souhaitez créer le projet.

    • (optionnel) set : Permet de définir des propriétés.

      • net_specific.disable_lan_security_groups : S’il est défini sur true, désactive les groupes de sécurité LAN pour le réseau du projet, modifiant ainsi le comportement par défaut du pare-feu au sein du VPC.

        Pour les charges de travail nécessitant une communication entre nodes à faible latence, la désactivation des groupes de sécurité LAN peut contribuer à réduire la latence.

  2. Appliquez votre fichier de configuration à votre profil à l’aide de la commande project create :

$ oks-cli project create \
    --profile YOUR_PROFILE \
    --filename ~/PATH/NAME_OF_PROJECT_FILE.yaml
  • disable-api-termination : La possibilité de supprimer le projet via l’API. Si la valeur est true, la suppression du projet est désactivée. Si la valeur est false, elle est activée.

  • (optionnel) quirk : Clés et paramètres avancés à transmettre au control plane du projet. Cette option est obligatoire pour les demandes d’activation de fonctionnalités.

  • (optionnel) filename : Le nom du fichier de définition à partir duquel vous souhaitez créer le projet.

  • (optionnel) set : Permet de définir des propriétés.

    • net_specific.disable_lan_security_groups : S’il est défini sur true, désactive les groupes de sécurité LAN pour le réseau du projet, modifiant ainsi le comportement par défaut du pare-feu au sein du VPC.

La commande project create renvoie les éléments suivants :

  • id : L’identifiant unique du projet.

  • name : Le nom du projet.

  • description : La description du projet.

  • cidr : Le bloc CIDR alloué aux Subnets du VPC où les VM du cluster seront lancées.

  • region : La Région où le projet est déployé.

  • status : L’état actuel du projet.

    Un projet peut être dans l’un des états suivants :

    • pending : Les ressources sous-jacentes du projet sont en cours d’initialisation.

    • ready : Le projet est entièrement paramétré et prêt à être utilisé.

    • updating : Le projet est en cours de mise à jour.

    • failed : Le projet a rencontré une erreur. Pour y remédier, contactez notre équipe Support à l’adresse support@outscale.com.

    • deleting : Le projet est en cours de suppression, et ses ressources associées sont en train d’être nettoyées.

  • tags : Un ou plusieurs tags associés au projet.

  • net_specific : Un ensemble d’options de configuration spécifiques au réseau pour le projet.

    • disable_lan_security_groups : Indique si les groupes de sécurité LAN sont désactivés pour le projet.

  • disable-api-termination : La possibilité de supprimer le projet via l’API. Si la valeur est true, la suppression du projet est désactivée. Si la valeur est false, elle est activée.

  • created_at : La date et l’heure de la création du projet, au format UTC.

  • updated_at : La date et l’heure de la dernière mise à jour du projet, au format UTC.

  • deleted_at : La date et l’heure de la suppression du projet, au format UTC (null si le projet est encore actif).

Exemple de résultat
{
  "id": "12ca0d38-2927-4cf1-93de-049135f88f00",
  "name": "NAME_OF_PROJECT",
  "description": "DESCRIPTION_OF_PROJECT",
  "cidr": "10.50.0.0/16",
  "region": "eu-west-2",
  "status": "pending",
  "tags": {
    "tag1": "this",
    "tag2": "that"
  },
  "net_specific": {
    "disable_lan_security_groups": false
  },
  "disable_api_termination": false,
  "created_at": "2025-01-01T12:10:00.000000Z",
  "updated_at": "2025-01-01T12:12:10.000000Z",
  "deleted_at": null
}

Pages connexes

Méthode API correspondante