Skip to content

How to Create a Project#

Learn how to create an isolated project in your organisation.

Alex, a platform user at ACME Corp, needs a dedicated environment to deploy applications and provision cloud services. A project provides network isolation, role-based access, and quota controls for your team's resources.

Prerequisites#

  • Access to your organisation's SCO platform
  • The project.tenant.cloud.stakater.com API available
  • kubectl configured with your organisation project kubeconfig

What Gets Created#

When you create a Project claim, the platform provisions:

  • An isolated project environment scoped to your team
  • Configurable resource quota for the project
  • Network isolation with your chosen CIDR block
  • Identity groups for read-only and admin access
  • Role-based access control within the project

Step 1: Define Your Project Claim#

Create a file named project.yaml with the following minimal configuration:

apiVersion: tenant.cloud.stakater.com/v1
kind: Project
metadata:
  name: my-project
spec:
  parameters:
    name: my-project
    network:
      name: app-network
      cidr: 10.0.0.0/16

Required Parameters#

Parameter Description
parameters.name Project name used for resource naming
parameters.network.name Network identifier for the project's isolated network
parameters.network.cidr CIDR block for the project network (e.g., 10.0.0.0/16)

Optional Parameters#

Parameter Default Description
parameters.tenantQuota small Quota size for the project (small, medium, large)
parameters.access — Role-based access entries for users and groups

Step 2: Add Access Control (Optional)#

To grant specific users and groups access to the project, add an access block:

apiVersion: tenant.cloud.stakater.com/v1
kind: Project
metadata:
  name: my-project
spec:
  parameters:
    name: my-project
    network:
      name: app-network
      cidr: 10.0.0.0/16
    tenantQuota: small
    access:
      - role: cluster-admin
        groups:
          - platform-admins
        users:
          - alex@acmecorp.example.com
      - role: view
        groups:
          - developers

Each entry in access specifies a role and lists users or groups to bind to that role within the project.

Step 3: Apply the Claim#

kubectl apply -f project.yaml

Step 4: Verify the Project#

Check that the project claim was created and is progressing:

kubectl get project my-project

Wait for the project to become ready:

NAME         READY   SYNCED   AGE
my-project   True    True     2m

You can also describe the claim to inspect status conditions:

kubectl describe project my-project

Full Example#

The following example creates a project with multiple access roles:

apiVersion: tenant.cloud.stakater.com/v1
kind: Project
metadata:
  name: team-dev
spec:
  parameters:
    name: team-dev
    network:
      name: dev-network
      cidr: 10.100.0.0/16
    tenantQuota: medium
    access:
      - role: cluster-admin
        groups:
          - platform-admins
        users:
          - alex@acmecorp.example.com
      - role: view
        groups:
          - developers
          - qa-team

What's Next?#