Creating a Project

You can create a project using OKS CLI.

Once you have created your first project, you can then start Managing Your Clusters.

Creating a Project Using OKS CLI

Before you begin: Install and configure OKS CLI. For more information, see Installing and Configuring OKS CLI.

The project create command allows you to create a project:

Request sample
$ oks-cli project create \
    --project-name NAME_OF_PROJECT \
    --description "DESCRIPTION_OF_PROJECT" \
    --cidr "RANGE_OF_IP_ADDRESSES" \
    --tags "tag1=this,tag2=that"

This command contains the following options that you need to specify:

  • project-name: The name of the project you want to create.

  • description: The description for the project you want to create.

  • (optional) cidr: A range of IP addresses in CIDR (Classless Inter-Domain Routing) notation that will be used in VPC subnets for all VMs on which the cluster will run. If not included, defaults to 10.50.0.0/16.

    • Once a project is created, you cannot change its CIDR.

    • CIDR should be a private block from RFC1918.

    • Minimal accepted CIDR size is /23.

    • The 172.31.0.0/16 CIDR must not be used, as it is reserved for internal usage.

  • (optional) tags: One or more tags associated with the project.

The project create command returns the following elements:

  • id: The unique identifier of the project.

  • name: The name of the project.

  • description: The description of the project.

  • cidr: CIDR block allocated for VPC subnets where cluster VMs will run.

  • region: The Region where the project is deployed.

  • status: Current state of the project.

    A project can be in one of the following states:

    • Pending: The underlying resources of the project are being initialized.

    • Available: The project is fully set up and ready for use.

    • Deleting: The project is in the process of being deleted, and its associated resources are being cleaned up.

  • tags: One or more tags associated with the project.

  • disable-api-termination: Disables or enables the ability to delete the project.

  • created_at: The date and time, in UTC format, at which the project was created.

  • updated_at: The date and time, in UTC format, at which the project was last updated.

  • deleted_at: The date and time, in UTC format, at which the project was deleted (null if the project is still active).

Result sample
{
    "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"
    },
    "disable_api_termination": false,
    "created_at": "2025-01-01T12:10:00.000000Z",
    "updated_at": "2025-01-01T12:12:10.000000Z",
    "deleted_at": null
}

Related Pages

Export to PDF