Skip to content

Commit 5dcaaad

Browse files
djwfyiclaude
andcommitted
docs(doc-1410): terminology — platform/administer/ batch 1
Replace "virtual cluster(s)" → "tenant cluster(s)" and "host cluster" → "control plane cluster" across all 28 files in platform/administer/. Also fixes two broken anchors created by heading renames: - iam_database.mdx → database#use-tenant-cluster-with-shared-database - how-to/use-go-template.mdx → parameters#connected-control-plane-cluster-parameter-values Code blocks, inline code, Kubernetes API type names (VirtualCluster, VirtualClusterInstance, virtualclusterinstances), and import lines are unchanged. Closes DOC-1410 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 59d695d commit 5dcaaad

29 files changed

Lines changed: 155 additions & 155 deletions

File tree

platform/administer/authentication/access-keys.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The platform supports limiting access key permissions by scoping them to specifi
2525

2626
A single project within the platform, limiting actions to only that project's resources.
2727

28-
A particular virtual cluster, constraining operations to just that virtual cluster's components.
28+
A particular tenant cluster, constraining operations to just that tenant cluster's components.
2929

3030
A specific namespace, allowing actions only within that defined namespace boundary.
3131

@@ -35,13 +35,13 @@ Scoping provides an important security control by restricting what an access key
3535

3636
When implementing access keys in automated workflows, consider using scoped keys to improve security by limiting access to only the required resources.
3737

38-
For example, an automated deployment process typically needs access to just one project or virtual cluster. By scoping the access key appropriately, you protect other resources in case the key is compromised.
38+
For example, an automated deployment process typically needs access to just one project or tenant cluster. By scoping the access key appropriately, you protect other resources in case the key is compromised.
3939

4040
## Example use cases
4141

4242
CI/CD integration often requires access to platform resources. You can create project-scoped access keys for build pipelines to enable automated building and deployment while limiting potential security exposure.
4343

44-
Automated deployment tools can use virtual cluster-scoped keys to manage deployments without gaining unnecessary access to other parts of your infrastructure.
44+
Automated deployment tools can use tenant cluster-scoped keys to manage deployments without gaining unnecessary access to other parts of your infrastructure.
4545

4646
Monitoring applications need to gather metrics and status information. Configure namespace-scoped keys for these systems to allow monitoring without granting broader permissions.
4747

@@ -79,7 +79,7 @@ Apply the principle of least privilege by using the most restrictive scope possi
7979
<b>Optional</b> If you'd like to limit the scope of the Access Key, expand
8080
the
8181
<Label>Limit Access Key Scope</Label> configuration section. In this section
82-
you can select the clusters, namespaces, and virtual clusters of which to
82+
you can select the clusters, namespaces, and tenant clusters of which to
8383
limit the Access Key scope to.
8484
</Step>
8585
<Step>
@@ -135,7 +135,7 @@ Replace the following placeholders:
135135

136136
Save the modified template as `my-kube-config.yaml`.
137137

138-
You can access your virtual cluster using the newly created kube config file:
138+
You can access your tenant cluster using the newly created kube config file:
139139

140140
```bash
141141
KUBECONFIG=my-kube-config.yaml kubectl get users

platform/administer/bare-metal/overview.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import FeatureTable from '@site/src/components/FeatureTable';
88

99
<FeatureTable names="metal3" />
1010

11-
vCluster Platform integrates [Metal3](https://metal3.io/) and [Ironic](https://ironicbaremetal.org/) for bare metal server lifecycle management. Physical servers are represented as `BareMetalHost` resources on a host cluster. The platform manages their detection, provisioning, configuration, and decommissioning for reuse.
11+
vCluster Platform integrates [Metal3](https://metal3.io/) and [Ironic](https://ironicbaremetal.org/) for bare metal server lifecycle management. Physical servers are represented as `BareMetalHost` resources on a control plane cluster. The platform manages their detection, provisioning, configuration, and decommissioning for reuse.
1212

1313
## When to use bare metal
1414

@@ -21,12 +21,12 @@ Bare metal servers are a good fit when workloads need direct hardware access or
2121

2222
## Prerequisites
2323

24-
Before managing bare metal servers, you need a [Metal3 node provider](../node-providers/metal3.mdx) configured on a host cluster.
24+
Before managing bare metal servers, you need a [Metal3 node provider](../node-providers/metal3.mdx) configured on a control plane cluster.
2525
The node provider can deploy Metal3, Ironic, and a DHCP server automatically, or you can install them yourself.
2626

2727
## Add servers
2828

29-
Bare metal servers are added by creating `BareMetalHost` resources on the host cluster, either through the platform UI or by applying them directly with kubectl. Each BareMetalHost represents a physical server and requires BMC (Baseboard Management Controller) configuration for out-of-band management.
29+
Bare metal servers are added by creating `BareMetalHost` resources on the control plane cluster, either through the platform UI or by applying them directly with kubectl. Each BareMetalHost represents a physical server and requires BMC (Baseboard Management Controller) configuration for out-of-band management.
3030

3131
### BMC configuration
3232

platform/administer/clusters/advanced/external-database/deploy.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ across failure domains.
6464
### Install the Amazon EBS CSI driver
6565

6666
The EBS CSI driver is required for dynamic provisioning of persistent volumes
67-
on EKS. Without it, virtual cluster StatefulSet pods remain in `Pending` state
67+
on EKS. Without it, tenant cluster StatefulSet pods remain in `Pending` state
6868
because the `gp2` storage class cannot provision volumes.
6969

7070
<InterpolatedCodeBlock
@@ -76,7 +76,7 @@ because the `gp2` storage class cannot provision volumes.
7676
language="bash"
7777
/>
7878

79-
For more details on EKS prerequisites for running virtual clusters, see the
79+
For more details on EKS prerequisites for running tenant clusters, see the
8080
[EKS environment setup guide](/docs/vcluster/deploy/control-plane/kubernetes-pod/environment/eks).
8181

8282
### Note the EKS VPC ID and CIDR
@@ -538,7 +538,7 @@ configuration. Unlike multi-region, no `multiRegion` block is needed — only
538538
Create a values file (`platform-ha-values.yaml`):
539539

540540
<InterpolatedCodeBlock
541-
code={"admin:\n email: [[VAR:ADMIN_EMAIL:admin@example.com]]\n\nreplicaCount: 3\n\nconfig:\n loftHost: [[GLOBAL:PLATFORM_DOMAIN]]\n database:\n enabled: true\n dataSource: \"mysql://kine@tcp([[VAR:DATABASE_URL:mariadb-ha-platform.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com]]:3306)/kine\"\n identityProvider: \"aws\"\n extraArgs:\n - --datastore-max-open-connections=20\n # Set to 0 because IAM auth tokens expire, making idle connections stale.\n - --datastore-max-idle-connections=0\n\n # Cost control requires the embedded single-region database and is not\n # compatible with the external Kine backend.\n costControl:\n enabled: false\n\n# Run multiple agent replicas for resilience on the connected host cluster.\nagentValues:\n replicaCount: 3"}
541+
code={"admin:\n email: [[VAR:ADMIN_EMAIL:admin@example.com]]\n\nreplicaCount: 3\n\nconfig:\n loftHost: [[GLOBAL:PLATFORM_DOMAIN]]\n database:\n enabled: true\n dataSource: \"mysql://kine@tcp([[VAR:DATABASE_URL:mariadb-ha-platform.xxxxxxxxxxxx.us-east-1.rds.amazonaws.com]]:3306)/kine\"\n identityProvider: \"aws\"\n extraArgs:\n - --datastore-max-open-connections=20\n # Set to 0 because IAM auth tokens expire, making idle connections stale.\n - --datastore-max-idle-connections=0\n\n # Cost control requires the embedded single-region database and is not\n # compatible with the external Kine backend.\n costControl:\n enabled: false\n\n# Run multiple agent replicas for resilience on the connected control plane cluster.\nagentValues:\n replicaCount: 3"}
542542
language="yaml"
543543
/>
544544

platform/administer/clusters/advanced/external-database/external-database.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Consider an external database deployment when you need one or more of the follow
2828
- **Control plane resilience**: If the platform pod or its node goes down,
2929
another replica takes over leadership automatically. Connected clusters
3030
continue operating through the surviving replicas.
31-
- **Strict RBAC environments**: Run the platform on a host cluster with
31+
- **Strict RBAC environments**: Run the platform on a control plane cluster with
3232
limited permissions, similar to
3333
[Least Privilege Mode](../../../../configure/agent-settings/least-privilege-mode.mdx)
3434
for agents. An external database lets the platform replicas use a shared

platform/administer/clusters/advanced/ingress-suffix.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ import Label from "@site/src/components/Label";
1111
import Input from "@site/src/components/Input";
1212
import Expander from "@site/src/components/Expander";
1313

14-
As outlined in the 'Virtual Clusters -> Advanced Topics -> Ingress Access' section, you can enable the 'AccessPoint' feature to access a virtual cluster API server directly by avoiding the vCluster Platform proxy. This requires a valid ingress controller to be present on the host cluster and a valid domain to be set in the `loft.sh/ingress-suffix` annotation on the Cluster Object.
14+
As outlined in the 'Tenant Clusters -> Advanced Topics -> Ingress Access' section, you can enable the 'AccessPoint' feature to access a tenant cluster API server directly by avoiding the vCluster Platform proxy. This requires a valid ingress controller to be present on the control plane cluster and a valid domain to be set in the `loft.sh/ingress-suffix` annotation on the Cluster Object.
1515

16-
Once this is done, vCluster Platform creates a connection to the virtual cluster through an ingress instead of the default vCluster Platform proxy. This can be useful, if you want to handout the virtual cluster kubeconfig to users that do not belong to vCluster Platform.
16+
Once this is done, vCluster Platform creates a connection to the tenant cluster through an ingress instead of the default vCluster Platform proxy. This can be useful, if you want to handout the tenant cluster kubeconfig to users that do not belong to vCluster Platform.
1717

1818
The ingress name URL is calculated in the following way:
1919

@@ -34,7 +34,7 @@ You can set the required ingress suffix in the vCluster Platform UI:
3434
<Step>
3535
In the drawer that appears from the right, click the{" "}
3636
<Label>Direct Access</Label> configuration pane. Provide the desired domain
37-
under the <Label>Virtual Cluster Ingress Suffix</Label> field.
37+
under the <Label>Tenant Cluster Ingress Suffix</Label> field.
3838
</Step>
3939
<Step>
4040
Click on the <Button>Save Changes</Button> button.

platform/administer/clusters/advanced/multi-region.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ eksctl create cluster \
148148
#### Install the Amazon EBS CSI driver
149149

150150
The EBS CSI driver is required for dynamic provisioning of persistent volumes
151-
on EKS. Without it, virtual cluster StatefulSet pods remain in `Pending` state
151+
on EKS. Without it, tenant cluster StatefulSet pods remain in `Pending` state
152152
because the `gp2` storage class cannot provision volumes.
153153

154154
Install the driver as an EKS managed add-on on **each** cluster:
@@ -163,7 +163,7 @@ eksctl create addon --name aws-ebs-csi-driver \
163163
--region eu-west-1
164164
```
165165

166-
For more details on EKS prerequisites for running virtual clusters, see the
166+
For more details on EKS prerequisites for running tenant clusters, see the
167167
[EKS environment setup guide](/docs/vcluster/next/deploy/control-plane/kubernetes-pod/environment/eks).
168168

169169
### Step 2 - Install AWS load balancer controller

platform/administer/clusters/advanced/networking.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,24 +28,24 @@ In private GKE clusters, Kubernetes control plane and worker nodes might reside
2828

2929
### Connect vCluster to the platform
3030

31-
When vCluster and the platform are in the same host cluster, the platform exposes an in‑cluster Service that targets port `10443` on the platform pods, so vCluster in the same host cluster talk to the
31+
When vCluster and the platform are in the same control plane cluster, the platform exposes an in‑cluster Service that targets port `10443` on the platform pods, so vCluster in the same control plane cluster talk to the
3232
platform via that `ClusterIP` Service. You should allow egress from the vCluster namespace to platform pods on TCP port `10443`.
3333

34-
When vCluster and the platform are in different host clusters, vCluster uses the `loftHost` value (your platform's load balancer or Ingress DNS) to establish a Tailscale-backed tunnel for API traffic.
34+
When vCluster and the platform are in different control plane clusters, vCluster uses the `loftHost` value (your platform's load balancer or Ingress DNS) to establish a Tailscale-backed tunnel for API traffic.
3535
You shoud allow egress traffic from vCluster pods to the `lostHost` domain and the egress traffic from platform agent to `loftHost`, if it participates in the handshake in your setup.
3636

3737

38-
### Enable DNS resolution in virtual clusters
38+
### Enable DNS resolution in tenant clusters
3939

40-
vCluster runs a CoreDNS component inside each virtual cluster to handle internal DNS queries. To avoid conflicts with the host cluster's DNS, CoreDNS in vCluster listens on port `1053` instead of the default port `53`.
40+
vCluster runs a CoreDNS component inside each tenant cluster to handle internal DNS queries. To avoid conflicts with the control plane cluster's DNS, CoreDNS in vCluster listens on port `1053` instead of the default port `53`.
4141

42-
If this port is blocked, DNS queries from virtual cluster pods might not work, especially when the querying pod and the CoreDNS pod are on different nodes. This issue commonly affects EKS clusters created with Terraform, which set up separate security groups for the control plane and worker nodes. By default, the node security group does not allow inbound traffic on port `1053`.
42+
If this port is blocked, DNS queries from tenant cluster pods might not work, especially when the querying pod and the CoreDNS pod are on different nodes. This issue commonly affects EKS clusters created with Terraform, which set up separate security groups for the control plane and worker nodes. By default, the node security group does not allow inbound traffic on port `1053`.
4343

44-
To enable proper DNS resolution within virtual clusters, allow inbound traffic on port `1053` between nodes.
44+
To enable proper DNS resolution within tenant clusters, allow inbound traffic on port `1053` between nodes.
4545

4646
| Port | Description | Purpose |
4747
|--------|----------------------|-------------------------------------------------------------------------|
48-
| `1053` | CoreDNS for vCluster | Enables internal DNS resolution across nodes in virtual clusters |
48+
| `1053` | CoreDNS for vCluster | Enables internal DNS resolution across nodes in tenant clusters |
4949

5050
:::note
5151
If you're using EKS with Terraform, check the default node security group and manually allow inbound traffic on TCP and UDP port `1053`. This ensures DNS queries between pods and CoreDNS can succeed even when scheduled on different nodes.

platform/administer/clusters/advanced/terraform-registration.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ import PageVariables from "@site/src/components/PageVariables";
1313
import Tabs from '@theme/Tabs';
1414
import TabItem from '@theme/TabItem';
1515

16-
Automate host cluster registration to vCluster Platform using Terraform. This guide shows you how to programmatically register clusters during infrastructure provisioning, eliminating manual registration steps.
16+
Automate control plane cluster registration to vCluster Platform using Terraform. This guide shows you how to programmatically register clusters during infrastructure provisioning, eliminating manual registration steps.
1717

1818
## Overview
1919

20-
When provisioning infrastructure with Terraform, you can automate the complete cluster registration workflow. This approach registers the cluster in vCluster Platform and installs the agent, making the cluster immediately available for virtual cluster deployment.
20+
When provisioning infrastructure with Terraform, you can automate the complete cluster registration workflow. This approach registers the cluster in vCluster Platform and installs the agent, making the cluster immediately available for tenant cluster deployment.
2121

2222
:::info Terraform provider deprecation
2323
The vCluster Platform Terraform provider is deprecated. This guide provides an alternative approach using the Kubernetes provider and vCluster Platform API to achieve the same automation goals.
@@ -598,7 +598,7 @@ The configuration requires two kubernetes provider contexts: one for the platfor
598598

599599
After registering your cluster, you can:
600600

601-
- [Create virtual clusters](../../../use-platform/virtual-clusters/add-virtual-clusters.mdx) on the registered host cluster
601+
- [Create tenant clusters](../../../use-platform/virtual-clusters/add-virtual-clusters.mdx) on the registered control plane cluster
602602
- [Configure agent settings](./agent-config.mdx) for advanced networking or security requirements
603603
- [Set up monitoring](../../../maintenance/monitoring/overview.mdx) for the agent and connected resources
604604
- [Implement policies](./policies.mdx) to control resource usage across clusters

0 commit comments

Comments
 (0)