⌘K
Documentation

Add Cluster Configurations

Clicking the Add Cluster Configuration button triggers a multi-functional panel on the right side of the screen.

Access Requirements

To access this page, the user must either have Administrator privileges or the CREATE permission for the Cluster Configurations module.

The CREATE permission allows users to create new groups. Users without administrator privileges or the required permission cannot access this page.

If you do not have the required permission, ask your administrator to grant it from one of the authorization pages below.

Authorization

Users without the required authorization will receive the following error:

Access Denied

You don't have access to this resource.

1. General Cluster Configuration Fields

Field Required Input Type Description
Name Yes Text Input A unique name for the configuration template (e.g., base-config).
Description No Text Area A detailed summary describing what this configuration includes (character limit: 200).
Is Active Yes Toggle Switch Active by default. Controls whether this configuration is active and available for clusters to consume.

2. Parent Cluster Configurations Selector

This section enables hierarchical inheritance of variables. Inherited variables are automatically merged into the active cluster environment.

  • Search Bar: Quickly locate configurations from the registered list.
  • Show Only Unselected Toggle: Filter to show only parent configurations that have not yet been selected, optimizing workflow for large environments.
  • Multi-Select Checkboxes: Select one or more configurations (e.g., config1, config2, config3) to act as parent profiles.

3. Variables Section

This area allows you to define granular environment variables or parameters that will be injected into the cluster pods at runtime.

Parameter Field Description
Name The key of the variable.
Value The value assigned to the key.
Description Explanatory note indicating the purpose of this specific variable.
Is Secret Switch Toggle to mask/encrypt this value within logs, configurations, and user interfaces.
Add Button (+) Appends the defined key-value pair to the configuration profile.
Delete Button (Trash icon) Removes the respective variable from the configuration.

Default Behavior

When configuring a profile:

  • Is Active defaults to Active (true).
  • The parent configuration list is sorted in alphabetical order by default.
  • Variable list inputs start empty and must be validated (requires Name and Value) before adding to the stack.

Validations

To prevent deployment errors, the platform performs the following validations:

  • Unique Name: The Configuration Name must be unique and cannot match an existing configuration.
  • Character Limit: The Description field has a maximum boundary of 200 characters.
  • Variable Key Integrity: Variable names must follow standard identifier rules (alphanumeric, underscores, no spaces). Duplicate keys are rejected.
ESC

Start typing to search across the documentation.