Skip to content

Commit fe2c9ec

Browse files
djwfyiclaude
andcommitted
docs(doc-1410): terminology — platform/configure/ + install/ batch 3
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>
1 parent bae0589 commit fe2c9ec

11 files changed

Lines changed: 65 additions & 65 deletions

File tree

platform/configure/advanced/cors-policy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Configure Cross-Origin Resource Sharing (CORS) headers at the ingress level so e
1717
## Prerequisites
1818

1919
- A deployed vCluster Platform instance with [external access configured](../installation-options/domain.mdx).
20-
- An ingress controller (such as ingress-nginx) deployed on the host cluster.
20+
- An ingress controller (such as ingress-nginx) deployed on the control plane cluster.
2121
- `helm` v3.10+ and `kubectl` with admin access to the cluster.
2222

2323
## Overview

platform/configure/agent-settings/customization.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Per-host cluster customization
3-
sidebar_label: Per-Host Cluster Customization
2+
title: Per-control plane cluster customization
3+
sidebar_label: Per-Control Plane Cluster Customization
44
sidebar_position: 2
55
---
66

@@ -12,11 +12,11 @@ import Input from "@site/src/components/Input";
1212
import Expander from "@site/src/components/Expander";
1313
import InterpolatedCodeBlock from "@site/src/components/InterpolatedCodeBlock";
1414

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 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.
1616

1717
[install-modes]: ../installation-options/overview#installation-modes
1818

19-
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.
2020

2121
## `loft.sh/agent-values` annotation {#loftsh-annotations}
2222
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
2828
memory: 2Gi
2929
```
3030
## 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:
3232
```
3333
kubectl annotate cluster cluster-B loft.sh/cluster-ignore-agent="true"
3434
```
@@ -40,7 +40,7 @@ helm install vcluster-platform vcluster-platform \
4040
--values custom-values.yaml
4141
```
4242
<!-- vale on -->
43-
This approach allows full control over agent configuration at installation time for that specific host cluster.
43+
This approach allows full control over agent configuration at installation time for that specific control plane cluster.
4444

4545
You can also update the agent settings in vCluster Platform UI.
4646
<Flow id="cluster-extravalues-vcluster-platform-agent">

platform/configure/agent-settings/least-privilege-mode.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Least Privilege Mode
33
sidebar_label: Least Privilege Mode
44
sidebar_position: 5
55
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.
77
---
88

99
import FeatureTable from '@site/src/components/FeatureTable';
@@ -15,7 +15,7 @@ By default, to minimize operational overhead, the **vCluster Platform Agent** re
1515
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.
1616

1717
:::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.
1919
:::
2020

2121
:::important Agent Upgrades
@@ -33,11 +33,11 @@ See [**Self-managed agents / Disable agent upgrades**](agent-upgrade.mdx#disable
3333
The following configuration options are available:
3434
- **Feature toggles** - Enable/disable toggles for the features that should be supported by the agent (ClusterAccess, ProjectQuotas, Secrets, SleepMode).
3535
- **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.
3737

3838
When a feature toggle is disabled, the corresponding permissions will not be requested and the internal Kubernetes controllers will not be started.
3939

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.
4141

4242
See the [Configuration reference](#configuration-reference) section for feature specific disabled state handling.
4343

@@ -96,7 +96,7 @@ agentValues:
9696
##### `enabled` <span className="config-field-type">boolean</span> <span className="config-field-default">true</span> <span className="config-field-enum"></span>
9797
Controls whether the agent supports the vCluster Platform **Project Quotas** feature.
9898
</summary>
99-
If set to `false`, project quotas will not be enforced for the virtual cluster instances deployed on the connected cluster.
99+
If set to `false`, project quotas will not be enforced for the tenant cluster instances deployed on the connected cluster.
100100
</details>
101101
</details>
102102
<details className="config-field" data-expandable="true">
@@ -122,7 +122,7 @@ agentValues:
122122
##### `enabled` <span className="config-field-type">boolean</span> <span className="config-field-default">true</span> <span className="config-field-enum"></span>
123123
Controls whether the agent supports the vCluster Platform **SleepMode** feature.
124124
</summary>
125-
If set to `false`, sleep/auto-sleep/wake actions will be ignored for the virtual cluster instances deployed on the connected cluster.
125+
If set to `false`, sleep/auto-sleep/wake actions will be ignored for the tenant cluster instances deployed on the connected cluster.
126126
</details>
127127
</details>
128128
<details className="config-field" data-expandable="true">
@@ -168,8 +168,8 @@ agentValues:
168168
Managed namespace admin configuration
169169
</summary>
170170

171-
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.
173173

174174
<details className="config-field" data-expandable="true" open>
175175
<summary>
@@ -182,7 +182,7 @@ agentValues:
182182
<details className="config-field" data-expandable="true">
183183
<summary>
184184
##### `extraRules` <span className="config-field-type">object[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span>
185-
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.
186186
</summary>
187187

188188
```yaml title="platform.yaml"
@@ -231,7 +231,7 @@ A typical rollout looks like this:
231231
1. Confirm that the vCluster Platform managed [agent upgrades](agent-upgrade.mdx#disable-agent-upgrades) is disabled for the connected clusters.
232232
2. Enable **Least Privilege Mode** and **disable** all optional features.
233233
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.
235235
- Validate deployment compliance with your organization's policies.
236236
4. Enable required features one by one and repeat the verification steps.
237237
5. Test agent behavior in a non-production environment.
@@ -248,6 +248,6 @@ A typical rollout looks like this:
248248
If the agent stops working after enabling **Least Privilege Mode**:
249249

250250
- 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
252252
253253
If you need more help troubleshooting agent behavior, see [Troubleshooting](troubleshooting.mdx).

platform/configure/agent-settings/overview.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,19 @@ import ConnectPlatform from '../../_fragments/cli-steps/connect-platform.mdx';
2525

2626

2727
# 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.
3333

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
3535
that are managed by the vCluster Platform.
3636

3737
The `agentValues` behavior is as follows:
3838
- 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.
4141

4242
## Connect to platform {#connect-to-platform}
4343
A new cluster can be connected to the platform through the UI or CLI:

platform/configure/agent-settings/security-context.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ agentValues:
7878
```
7979

8080
#### 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.
8282

8383
To achieve cluster-specific security context, you can override security contexts for specific clusters using the [`loft.sh/agent-values` annotation](overview#loftsh-annotations):
8484

platform/configure/installation-options/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Installation options are the content in the [`values.yaml`](../introduction.mdx)
99
It contains fields like `resources`, `replicas`, `ingress` and also custom fields like `admin`, `product`, `agentOnly`.
1010

1111
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.
1313

1414
## Installation modes
1515

platform/configure/platform-configs/audit.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Audit logging in the platform provides a security-relevant, chronological set of
1919

2020
The platform can log activities related to:
2121

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
2424
- Changes within a connected cluster
2525

2626
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
6262
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:
6363

6464
- **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.
6666
- **Level 3**: Like Level 2 but instead of only logging the request metadata also logs the complete request payload sent to the platform
6767
- **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
6868

platform/configure/platform-configs/cost-control.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ description: Learn how to configure the Cost Control Dashboard and its supportin
77

88
import VersionBadge from '@site/src/components/VersionBadge';
99

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 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.
1111

1212
<VersionBadge platformVersion="v4.2.0" vclusterVersion="v0.22.0"/>
1313

1414
To track allocations and calculate savings for workloads running inside
15-
virtual clusters the platform deploys and manages [Prometheus](https://prometheus.io/) and
15+
tenant clusters the platform deploys and manages [Prometheus](https://prometheus.io/) and
1616
[OpenCost](https://www.opencost.io/) on each connected cluster. Prometheus uses a time series database that requires
1717
persistent volume storage to retain metrics over time. The platform-managed
1818
Prometheus is configured to collect the minimum metrics required for the cost

0 commit comments

Comments
 (0)