Skip to main content
Version: main 🚧

Use the platform

This section is for project users. You work inside projects that an admin set up for you, and the project decides most of what you can do. Knowing what it controls tells you why an option is or isn't there.

What your project decides​

Each project sets the same limits for everyone who works in it.

  • Your role in the project decides what you can do with its resources.
  • Allowed templates decide which clusters you can create. Your project's template settings and your role decide whether you can create one without a template.
  • Allowed control plane clusters decide where your clusters run.
  • Quotas cap what the whole project can use, and can also cap what each user or team owns. A create request fails when it would exceed either limit.

If something these pages describe isn't available to you, your project, your role, or the platform license doesn't allow it. Ask your project admin.

Each project's pages show only that project's resources. To see your clusters and instances across every project you belong to, use All projects.

Get started​

Most project users start with a cluster.

  1. Create a cluster from a template that your project allows. If your project allows it, you can also configure a cluster manually.
  2. Connect to it by getting a kubeconfig for its API server.
  3. Share access with the users or teams who need it.

Then put workloads on it. Install an app or deploy a Stack, and sync a project secret into the cluster when a workload needs credentials.

If your project offers servers directly, see Instances. An instance is a claim on a physical or virtual server that the platform provisions through a node provider.

The sidebar has the rest of the cluster, app, and secret tasks, such as sleep, deletion protection, and app updates. To update the password you use to log in, see Change your password.

Covered in other sections​

This section covers using the platform. Setting it up for others is covered elsewhere.

  • To create projects, templates, quotas, and project secrets for other users, start with what projects are and what templates are in Deliver services to tenants.
  • To install, configure, and run the platform itself, see Administer the management plane.
  • To work inside a cluster after you connect to it, see Operate in the vCluster docs. The cluster's Kubernetes runtime, including configuration, upgrades, backups, and integrations, is documented there.