You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Replace "virtual cluster(s)" → "tenant cluster(s)" and "host cluster(s)" →
"control plane cluster(s)" across 11 files in platform/configure/ and
platform/install/. Five files were untouched — their only hits were inside
fenced code blocks (terminal output / YAML comments).
Code blocks, inline code, Kubernetes API type names, and import lines
are unchanged.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
As described in [installation modes][install-modes], the vCluster Platform Agent can be installed using the same `vcluster-platform` chart by setting `agentOnly: true`. The configuration of the agent by default will be decided by the configuration of the platform in the primary host cluster and the `agentValues` content.
15
+
As described in [installation modes][install-modes], the vCluster Platform Agent can be installed using the same `vcluster-platform` chart by setting `agentOnly: true`. The configuration of the agent by default will be decided by the configuration of the platform in the primary control plane cluster and the `agentValues` content.
However, this means that all host clusters connecting to the platform will share the same configuration. If different connected host clusters require different agent configurations, there are two supported approaches.
19
+
However, this means that all control plane clusters connecting to the platform will share the same configuration. If different connected control plane clusters require different agent configurations, there are two supported approaches.
Add the `loft.sh/agent-values` annotation to a specific Cluster resource (via the UI or YAML). This annotation overrides the platform-level `agentValues`. The override applies only to the annotated Cluster. For example:
@@ -28,7 +28,7 @@ Add the `loft.sh/agent-values` annotation to a specific Cluster resource (via th
28
28
memory: 2Gi
29
29
```
30
30
## Override values
31
-
When installing the agent directly on a host cluster, you can override values by passing a custom values file to Helm. But first, you should tell vCluster Platform to ignore the agent of the specific cluster by adding annotation:
31
+
When installing the agent directly on a control plane cluster, you can override values by passing a custom values file to Helm. But first, you should tell vCluster Platform to ignore the agent of the specific cluster by adding annotation:
Copy file name to clipboardExpand all lines: platform/configure/agent-settings/least-privilege-mode.mdx
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Least Privilege Mode
3
3
sidebar_label: Least Privilege Mode
4
4
sidebar_position: 5
5
5
sidebar_class_name: pro
6
-
description: Reduce the permissions granted to vCluster Platform Agents on connected host clusters by disabling features that aren't required.
6
+
description: Reduce the permissions granted to vCluster Platform Agents on connected control plane clusters by disabling features that aren't required.
@@ -15,7 +15,7 @@ By default, to minimize operational overhead, the **vCluster Platform Agent** re
15
15
If your organization follows strict RBAC policies, **Least Privilege Mode** can be used to limit the **vCluster Platform Agent** permissions only to your deployment needs.
16
16
17
17
:::important Scope
18
-
**Least Privilege Mode** applies only to agents deployed on **external host clusters**. It does **not** apply to the agent running in the cluster where the platform is installed.
18
+
**Least Privilege Mode** applies only to agents deployed on **external control plane clusters**. It does **not** apply to the agent running in the cluster where the platform is installed.
The following configuration options are available:
34
34
-**Feature toggles** - Enable/disable toggles for the features that should be supported by the agent (ClusterAccess, ProjectQuotas, Secrets, SleepMode).
35
35
-**Cluster scope permissions** – Controls the cluster scope permissions granted to the vCluster Platform Agent. Permissions can be extended to accommodate permissions for custom resources.
36
-
-**Managed namespaces scope permissions** – Controls the permissions granted to the vCluster Platform Agent into the namespaces where virtual cluster instances are installed.
36
+
-**Managed namespaces scope permissions** – Controls the permissions granted to the vCluster Platform Agent into the namespaces where tenant cluster instances are installed.
37
37
38
38
When a feature toggle is disabled, the corresponding permissions will not be requested and the internal Kubernetes controllers will not be started.
39
39
40
-
Requests for the disabled features will not be fulfilled. For example, if the ProjectQuotas feature is disabled, the project quotas will not be enforced for the virtual cluster instances deployed on the connected cluster.
40
+
Requests for the disabled features will not be fulfilled. For example, if the ProjectQuotas feature is disabled, the project quotas will not be enforced for the tenant cluster instances deployed on the connected cluster.
41
41
42
42
See the [Configuration reference](#configuration-reference) section for feature specific disabled state handling.
The vCluster Platform Agent namespace-admin Role provides permissions to allow the agent to manage virtual cluster instances within a managed namespace, without cluster-admin level permissions.
172
-
As part of the virtual cluster instances reconciliation loop, the namespace-admin role is created in the managed namespace and assigned to the vCluster Platform Agent service account.
171
+
The vCluster Platform Agent namespace-admin Role provides permissions to allow the agent to manage tenant cluster instances within a managed namespace, without cluster-admin level permissions.
172
+
As part of the tenant cluster instances reconciliation loop, the namespace-admin role is created in the managed namespace and assigned to the vCluster Platform Agent service account.
Allows granting additional permissions to the vCluster Platform Agent within the managed namespaces where virtual cluster instances are installed.
185
+
Allows granting additional permissions to the vCluster Platform Agent within the managed namespaces where tenant cluster instances are installed.
186
186
</summary>
187
187
188
188
```yaml title="platform.yaml"
@@ -231,7 +231,7 @@ A typical rollout looks like this:
231
231
1. Confirm that the vCluster Platform managed [agent upgrades](agent-upgrade.mdx#disable-agent-upgrades) is disabled for the connected clusters.
232
232
2. Enable **Least Privilege Mode** and **disable** all optional features.
233
233
3. Verify deployment:
234
-
- Confirm that virtual cluster instances can be deployed as expected.
234
+
- Confirm that tenant cluster instances can be deployed as expected.
235
235
- Validate deployment compliance with your organization's policies.
236
236
4. Enable required features one by one and repeat the verification steps.
237
237
5. Test agent behavior in a non-production environment.
@@ -248,6 +248,6 @@ A typical rollout looks like this:
248
248
If the agent stops working after enabling **Least Privilege Mode**:
249
249
250
250
- Review agent logs for RBAC permission errors. `agentValues.env.KUBERNETES_VERBOSITY_LEVEL: "4"` option can be used to gain visibility into the vCluster Platform Agent Kubernetes API requests.
251
-
- Confirm that you are applying this only to the agents running on external host clusters
251
+
- Confirm that you are applying this only to the agents running on external control plane clusters
252
252
253
253
If you need more help troubleshooting agent behavior, see [Troubleshooting](troubleshooting.mdx).
Copy file name to clipboardExpand all lines: platform/configure/agent-settings/overview.mdx
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,19 +25,19 @@ import ConnectPlatform from '../../_fragments/cli-steps/connect-platform.mdx';
25
25
26
26
27
27
# Overview
28
-
When a **vCluster Platform** is deployed on a host cluster (or, primary host cluster), it can act as a centralized control plane. Other host clusters can connect to the vCluster Platform running on the primary host cluster and be managed by it. In this architecture:
29
-
- The primary host cluster runs the vCluster Platform.
30
-
- Other host clusters connect to the primary host cluster and run the vCluster Platform Agent.
31
-
- The Platform coordinates and manages all connected host clusters through their agents.
32
-
- There are both vCluster Platform and vCluster Platform agent running on the primary host cluster. The vCluster Platform manages the primary host cluster through its vCluster Platform Agent as well.
28
+
When a **vCluster Platform** is deployed on a control plane cluster (or, primary control plane cluster), it can act as a centralized control plane. Other control plane clusters can connect to the vCluster Platform running on the primary control plane cluster and be managed by it. In this architecture:
29
+
- The primary control plane cluster runs the vCluster Platform.
30
+
- Other control plane clusters connect to the primary control plane cluster and run the vCluster Platform Agent.
31
+
- The Platform coordinates and manages all connected control plane clusters through their agents.
32
+
- There are both vCluster Platform and vCluster Platform agent running on the primary control plane cluster. The vCluster Platform manages the primary control plane cluster through its vCluster Platform Agent as well.
33
33
34
-
Agent settings are the content in the [`values.yaml`](../introduction.mdx) under the `agentValues`. It controls the behavior of vCluster Platform Agents installed in the host clusters
34
+
Agent settings are the content in the [`values.yaml`](../introduction.mdx) under the `agentValues`. It controls the behavior of vCluster Platform Agents installed in the control plane clusters
35
35
that are managed by the vCluster Platform.
36
36
37
37
The `agentValues` behavior is as follows:
38
38
- By default, `agentValues` is an empty object `{}`.
39
-
- An empty `agentValues` object means that agents installed on connected host clusters will inherit the same configuration as the platform running on the primary host cluster.
40
-
- You can populate `agentValues` to override the default agent configuration globally for all connected host clusters.
39
+
- An empty `agentValues` object means that agents installed on connected control plane clusters will inherit the same configuration as the platform running on the primary control plane cluster.
40
+
- You can populate `agentValues` to override the default agent configuration globally for all connected control plane clusters.
41
41
42
42
## Connect to platform {#connect-to-platform}
43
43
A new cluster can be connected to the platform through the UI or CLI:
Copy file name to clipboardExpand all lines: platform/configure/agent-settings/security-context.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ agentValues:
78
78
```
79
79
80
80
#### Cluster-specific security context
81
-
As mentioned [here](customization.mdx), you can customize the agent in each connected host cluster independently.
81
+
As mentioned [here](customization.mdx), you can customize the agent in each connected control plane cluster independently.
82
82
83
83
To achieve cluster-specific security context, you can override security contexts for specific clusters using the [`loft.sh/agent-values` annotation](overview#loftsh-annotations):
Copy file name to clipboardExpand all lines: platform/configure/installation-options/overview.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Installation options are the content in the [`values.yaml`](../introduction.mdx)
9
9
It contains fields like `resources`, `replicas`, `ingress` and also custom fields like `admin`, `product`, `agentOnly`.
10
10
11
11
You set values of installation options to customize the deployment of vCluster Platform. These installation options are not available in the vCluster Platform UI after the vCluster Platform
12
-
is installed in the host cluster but can only be [applied using `helm`](../introduction#applying-configuration) before the deployment.
12
+
is installed in the control plane cluster but can only be [applied using `helm`](../introduction#applying-configuration) before the deployment.
Copy file name to clipboardExpand all lines: platform/configure/platform-configs/audit.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,8 +19,8 @@ Audit logging in the platform provides a security-relevant, chronological set of
19
19
20
20
The platform can log activities related to:
21
21
22
-
- Management instance changes, such as creation of new virtual clusters, spaces, etc.
23
-
- Changes within a virtual cluster or space
22
+
- Management instance changes, such as creation of new tenant clusters, spaces, etc.
23
+
- Changes within a tenant cluster or space
24
24
- Changes within a connected cluster
25
25
26
26
Auditing in the platform is similar to [auditing Kubernetes clusters](https://kubernetes.io/docs/tasks/debug-application-cluster/audit/) in general.
@@ -62,7 +62,7 @@ The audit logging feature increases the memory consumption of the platform becau
62
62
The platform provides audit levels, which are preconfigured audit policies for the most common use cases. These levels range from 1 to 4 where 1 logs the fewest requests, while 4 logs the most:
63
63
64
64
- **Level 1**: Logs modifying requests such as creation / modification or deletion of any objects
65
-
- **Level 2**: Like Level 1 but also logs the metadata of reading requests, such as listing pods inside a virtual cluster or space. It won't log the response or request payload and instead only the metadata such as request origin, target, etc.
65
+
- **Level 2**: Like Level 1 but also logs the metadata of reading requests, such as listing pods inside a tenant cluster or space. It won't log the response or request payload and instead only the metadata such as request origin, target, etc.
66
66
- **Level 3**: Like Level 2 but instead of only logging the request metadata also logs the complete request payload sent to the platform
67
67
- **Level 4**: Like Level 3 but instead of only logging metadata and request payload, also logs the response the platform has sent to the requester
The platform comes with the cost control dashboard enabled by default, offering insights into potential [cost savings](https://www.vcluster.com/cost-savings) through virtual clusters.
10
+
The platform comes with the cost control dashboard enabled by default, offering insights into potential [cost savings](https://www.vcluster.com/cost-savings) through tenant clusters.
0 commit comments