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" →
"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>
Copy file name to clipboardExpand all lines: platform/administer/authentication/access-keys.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ The platform supports limiting access key permissions by scoping them to specifi
25
25
26
26
A single project within the platform, limiting actions to only that project's resources.
27
27
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.
29
29
30
30
A specific namespace, allowing actions only within that defined namespace boundary.
31
31
@@ -35,13 +35,13 @@ Scoping provides an important security control by restricting what an access key
35
35
36
36
When implementing access keys in automated workflows, consider using scoped keys to improve security by limiting access to only the required resources.
37
37
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.
39
39
40
40
## Example use cases
41
41
42
42
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.
43
43
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.
45
45
46
46
Monitoring applications need to gather metrics and status information. Configure namespace-scoped keys for these systems to allow monitoring without granting broader permissions.
47
47
@@ -79,7 +79,7 @@ Apply the principle of least privilege by using the most restrictive scope possi
79
79
<b>Optional</b> If you'd like to limit the scope of the Access Key, expand
80
80
the
81
81
<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
83
83
limit the Access Key scope to.
84
84
</Step>
85
85
<Step>
@@ -135,7 +135,7 @@ Replace the following placeholders:
135
135
136
136
Save the modified template as `my-kube-config.yaml`.
137
137
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:
Copy file name to clipboardExpand all lines: platform/administer/bare-metal/overview.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
@@ -8,7 +8,7 @@ import FeatureTable from '@site/src/components/FeatureTable';
8
8
9
9
<FeatureTablenames="metal3" />
10
10
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.
12
12
13
13
## When to use bare metal
14
14
@@ -21,12 +21,12 @@ Bare metal servers are a good fit when workloads need direct hardware access or
21
21
22
22
## Prerequisites
23
23
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.
25
25
The node provider can deploy Metal3, Ironic, and a DHCP server automatically, or you can install them yourself.
26
26
27
27
## Add servers
28
28
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.
@@ -538,7 +538,7 @@ configuration. Unlike multi-region, no `multiRegion` block is needed — only
538
538
Create a values file (`platform-ha-values.yaml`):
539
539
540
540
<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"}
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.
15
15
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.
17
17
18
18
The ingress name URL is calculated in the following way:
19
19
@@ -34,7 +34,7 @@ You can set the required ingress suffix in the vCluster Platform UI:
34
34
<Step>
35
35
In the drawer that appears from the right, click the{""}
36
36
<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.
38
38
</Step>
39
39
<Step>
40
40
Click on the <Button>Save Changes</Button> button.
Copy file name to clipboardExpand all lines: platform/administer/clusters/advanced/networking.mdx
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,24 +28,24 @@ In private GKE clusters, Kubernetes control plane and worker nodes might reside
28
28
29
29
### Connect vCluster to the platform
30
30
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
32
32
platform via that `ClusterIP` Service. You should allow egress from the vCluster namespace to platform pods on TCP port `10443`.
33
33
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.
35
35
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.
36
36
37
37
38
-
### Enable DNS resolution in virtual clusters
38
+
### Enable DNS resolution in tenant clusters
39
39
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`.
41
41
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`.
43
43
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.
|`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 |
49
49
50
50
:::note
51
51
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.
Copy file name to clipboardExpand all lines: platform/administer/clusters/advanced/terraform-registration.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
@@ -13,11 +13,11 @@ import PageVariables from "@site/src/components/PageVariables";
13
13
importTabsfrom'@theme/Tabs';
14
14
importTabItemfrom'@theme/TabItem';
15
15
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.
17
17
18
18
## Overview
19
19
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.
21
21
22
22
:::info Terraform provider deprecation
23
23
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
598
598
599
599
After registering your cluster, you can:
600
600
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
602
602
-[Configure agent settings](./agent-config.mdx) for advanced networking or security requirements
603
603
-[Set up monitoring](../../../maintenance/monitoring/overview.mdx) for the agent and connected resources
604
604
-[Implement policies](./policies.mdx) to control resource usage across clusters
0 commit comments