vCluster
Create a Compute Profile for K8s¶
This page outlines the process for creating a Compute Profile using the vCluster compute type. vCluster profiles enable workload provisioning inside virtual Kubernetes clusters that run as workloads on shared host clusters. These profiles offer enhanced multi-tenancy and namespace-level isolation while retaining Kubernetes-native capabilities.
Refer to the Compute Profile Overview for general information.
Steps to Create a vCluster Compute Profile¶
- In the Developer Console, navigate to Compute Profiles from the left navigation pane
- Click the + New Compute Profile button
- In the Compute Profile form:
- Name: Provide a unique identifier for the profile (e.g.,
vcluster-dev-profile) - Display Name (Optional): Enter a user-friendly label (e.g.,
Development vCluster Profile) - Description (Optional): Add notes to describe the profile’s purpose or vCluster configuration
- Choose the appropriate Environment Template from the dropdown
- Choose the Template Version
- Compute Type: From the dropdown, select vCluster
- Name: Provide a unique identifier for the profile (e.g.,
⚠️ This determines that workloads associated with this profile will be provisioned inside virtual Kubernetes clusters hosted on shared infrastructure.
- Once all required fields are filled, click Save & Continue to proceed to configuration.
Compute Profile Configuration¶
Once saved, the Compute Profile Configuration page appears.
The values provided during profile creation, such as Name, Display Name, Description, Allocation Type, Environment Template, Template Version, and Compute Type, are shown under the General section.
Advanced Configuration¶
| Name | Default Value | Value Type | Description |
|---|---|---|---|
| Labels | N/A | key-value | Optional metadata to help categorize and identify the compute profile |
| Annotations | N/A | key-value | Optional key-value pairs for additional context (e.g., 'env': 'prod') |
| Extra Configuration | N/A | key-value | Custom key-value metadata for advanced customization or integration |
Display Settings¶
| Name | Sample Value | Value Type | Description |
|---|---|---|---|
| Icon URL | https://cdn.example.com/icons/vcluster-profile.svg |
string | URL to a custom icon used to visually identify the compute profile |
| Read Me | This profile provisions vCluster environments for isolated tenant workloads. |
string | Short summary describing the purpose or characteristics of the profile |
Input Settings Table¶
| Name | Sample Value | Value Type | Description |
|---|---|---|---|
| Admin API Key | ******** |
text | API key used for authenticating with the controller |
| Controller Admin Endpoint | ops-console.rafay.dev |
text | Admin access endpoint for the Rafay Controller |
| ethernet_network_fabric | true |
text | Indicates if Ethernet network fabric is enabled |
| infiniband_network_fabric | false |
text | Indicates if InfiniBand network fabric is enabled |
| network_operation | tenant-onboard |
text | Specifies the type of network operation (e.g., onboarding) |
| organization | rafay-dev |
text | Identifier for the organization or tenant |
Input Configuration Controls¶
-
Override (Checkbox): Allows environment-level overrides for specific input parameters. When enabled, users can modify the input value directly within their environment-specific configurations.
-
Allow Override For All: A global control that enables the override option for all listed inputs at once. Useful for quickly granting flexibility across the entire configuration.
-
Preview Input Form: Displays a preview of how the configured inputs will appear to users. It includes field labels, tooltips, input types, validation rules, and grouping settings.
-
Display Config (Edit): Opens a configuration panel where display-related settings can be customized. Options include changing the display name, adding user guidance tooltips, setting default values, selecting input types, and organizing fields into logical groups.
Example: Edited Input for ethernet_network_fabric
| Field | Description |
|---|---|
| Alias | Display label shown to users (e.g., ethernet_fabric_flag) |
| Tooltip | Help text shown when hovering over the info icon (e.g., Enable Ethernet fabric support) |
| Disabled | Toggle to make the field read-only for end users |
| Order/Weight | Determines the order of fields in the UI (e.g., 10, lower values appear higher in the form) |
| Type | Input type for the field (e.g., Text, Dropdown, File Upload) |
| Validation Type | Defines the validation mechanism (e.g., Boolean, Length, Regex, Required) |
| Validation Pattern | Used with validation type; for example, a regex like true|false to limit input to boolean values |
| Section | Logical grouping under which the field will be displayed (e.g., Network Settings) |
| Section Description | Optional description for the section (e.g., Configure the network fabric settings for compute provisioning) |
Output Settings¶
| Name | Sample Value | Value Type | Description |
|---|---|---|---|
| Name | vcluster-access-url |
text | Unique identifier for the output variable capturing a vCluster endpoint URL |
| Label | vCluster Access URL |
text | Display name shown in the UI for readability (optional) |
| Resource | vcluster-dev-profile |
text | Optional reference to the compute profile or environment linked to the output |
- Each output entry includes Edit and Delete options on the right side, allowing modifications or removal of the configuration as needed
- The Preview Output Form button allows visual verification of how the output fields will be rendered in the UI
Once all configurations are complete, click Save Changes to apply the updates.