Skip to content

Commit f74d26a

Browse files
djwfyiclaude
andauthored
fix(platform): terminology, branding, and typo cleanup pass (#2327)
* fix(platform): terminology, branding, and typo cleanup pass - Fix vCluter → vCluster Platform typo in gitlab-ci.mdx - Replace deprecated loft use management with vcluster platform connect management in use-api.mdx - Replace Loft API/Loft CLI prose with vCluster Platform API/vCluster CLI in API resource pages - Replace virtual cluster/host cluster/multi-tenancy with tenant cluster/control plane cluster/tenant isolation in prose - Fix e.g. → for example and etc. → and so on to satisfy vale no-latinisms rule Closes DOC-1503 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix(platform): prose polish from review feedback Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent e9f7c0f commit f74d26a

11 files changed

Lines changed: 16 additions & 17 deletions

File tree

platform/_partials/cluster/connect-cli.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import Expander from '@site/src/components/Expander'
1313
vcluster platform add cluster cluster-name --display-name [display-name]
1414
```
1515

16-
The above command automatically installs the [vCluster Platform Agent](../../administer/clusters/advanced/agent-config.mdx) in the cluster that corresponds to your current Kubernetes context. The host cluster where the vCluster Platform itself is deployed is automatically connected to the platform during installation. Therefore, this command should be executed in a different host cluster from the one where the vCluster Platform is running.
16+
The above command automatically installs the [vCluster Platform Agent](../../administer/clusters/advanced/agent-config.mdx) in the cluster that corresponds to your current Kubernetes context. The control plane cluster where vCluster Platform itself is deployed is automatically connected to the platform during installation. Therefore, this command should be executed in a different cluster from the one where vCluster Platform is running.
1717

1818
By default, the `vcluster-platform` namespace is created automatically if it does not already exist on the cluster. The vCluster Platform Agent resources are deployed into this namespace. You can override this behavior by explicitly specifying a different namespace using the `--namespace` flag. If you want to connect a cluster that is not associated with your current Kubernetes context, use the `--context` flag to specify the context of the target cluster.
1919
:::info

platform/_partials/cluster/upgrade-cli.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import Expander from '@site/src/components/Expander'
2222
cluster-name | 7s
2323
```
2424

25-
In this example, the host cluster where the platform agent is installed is named `cluster-name`.
25+
In this example, the cluster where the platform agent is installed is named `cluster-name`.
2626
</Step>
2727
<Step>
2828
By providing the Helm chart version and values configuration, you can install or upgrade the existing platform agent deployment for the `cluster-name` cluster using:

platform/_partials/cluster/upgrade-helm.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import Expander from '@site/src/components/Expander'
2222
14:43:35 info vCluster platform host: https://loftg2fei.loft.host
2323
14:43:35 info Access Key: xxxxxxxx
2424
```
25-
In this example, `cluster-name` refers to the host cluster containing the [vCluster Platform Agent](../../administer/clusters/advanced/agent-config.mdx) to be upgraded.
25+
In this example, `cluster-name` refers to the cluster containing the [vCluster Platform Agent](../../administer/clusters/advanced/agent-config.mdx) to be upgraded.
2626

2727
<!-- vale off -->
2828
Here, `https://loftg2fei.loft.host` represents the `url`, and `xxxxxxxx` is the `token`.
@@ -54,7 +54,7 @@ import Expander from '@site/src/components/Expander'
5454
Platform Helm values, merged with any cluster-specific overrides from the `loft.sh/agent-values` annotation (when present).
5555

5656
If the platform agent is not yet installed, you can include the `--install` and `--create-namespace` flags. The combination
57-
of `--create-namespace` and `--namespace vcluster-platform` will create the `vcluster-platform` namespace in the host cluster
57+
of `--create-namespace` and `--namespace vcluster-platform` will create the `vcluster-platform` namespace in the control plane cluster
5858
if it does not already exist. All platform agent resources will then be deployed and run within that namespace.
5959
</Step>
6060
</Flow>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,12 +105,12 @@ installation. See [Deploy (AWS/EKS)](./deploy.mdx) for step-by-step setup instru
105105

106106
Multi-region platforms run an embedded Kubernetes API server inside each
107107
region's vCluster Platform pod. The `v1.management.loft.sh` aggregated
108-
APIService isn't registered on the host EKS cluster. Each region registers it
108+
APIService isn't registered on the control plane EKS cluster. Each region registers it
109109
inside its own embedded API server instead. This changes how automation and
110110
integrations such as Argo CD or Terraform call the management API.
111111

112-
The aggregated APIService is cluster-scoped, so a single host EKS cluster can
113-
register only one. With multiple region pods sharing the same host cluster,
112+
The aggregated APIService is cluster-scoped, so a single control plane EKS cluster can
113+
register only one. With multiple region pods sharing the same control plane cluster,
114114
that one registration can't route correctly to all of them. Each region
115115
therefore registers the APIService locally, and the platform's own HTTPS
116116
endpoint is the integration surface.

platform/api/resources/directclusterendpointtoken.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: Direct Cluster Endpoint Token
55
import Reference from "../_partials/resources/directclusterendpointtokens/reference.mdx"
66
import Create from "../_partials/resources/directclusterendpointtokens/create.mdx"
77

8-
Direct Cluster Endpoints are a feature to avoid the central Loft instance and directly connect to a connected Loft cluster.
8+
Direct Cluster Endpoints allow you to avoid routing through the central vCluster Platform instance and directly connect to a connected cluster.
99

1010
## Direct Cluster Endpoint Token example
1111

platform/api/resources/ownedaccesskey.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import Create from "../_partials/resources/ownedaccesskeys/create.mdx"
77
import Update from "../_partials/resources/ownedaccesskeys/update.mdx"
88
import Delete from "../_partials/resources/ownedaccesskeys/delete.mdx"
99

10-
Access keys let you authenticate with Loft API endpoints and Loft CLI in non-interactive environments such as from within CI/CD pipelines.
10+
Access keys let you authenticate with vCluster Platform API endpoints and the vCluster CLI in non-interactive environments such as from within CI/CD pipelines.
1111

1212
## Owned Access Key example
1313

platform/api/resources/sharedsecret.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Create from "../_partials/resources/sharedsecrets/create.mdx"
88
import Update from "../_partials/resources/sharedsecrets/update.mdx"
99
import Delete from "../_partials/resources/sharedsecrets/delete.mdx"
1010

11-
Global Secrets can be used to share sensitive information across users, teams and connected clusters. You can either access shared secrets through the Loft CLI or sync them directly to a project secret.
11+
Global Secrets can be used to share sensitive information across users, teams, and connected clusters. You can access shared secrets through the vCluster CLI or sync them directly to a project secret.
1212

1313
## Global Secret example
1414

platform/api/resources/virtualclusterinstance/virtualclusterinstance.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Create from "../../_partials/resources/virtualclusterinstances/create.mdx
88
import Update from "../../_partials/resources/virtualclusterinstances/update.mdx"
99
import Delete from "../../_partials/resources/virtualclusterinstances/delete.mdx"
1010

11-
A virtual cluster is a fully functional Kubernetes cluster that runs inside the namespace of another Kubernetes cluster (host cluster). Virtual clusters are very useful if you are hitting the limits of namespaces and do not want to make special exceptions to the multi-tenancy configuration of the underlying cluster, e.g. a user needs their own CRD or user needs pods from 2 namespaces to communicate with each other but your standard NetworkPolicy does not allow this, then a virtual cluster may be perfect for this user.
11+
A tenant cluster is a fully functional Kubernetes cluster that runs inside the namespace of a control plane cluster. Tenant clusters are a good fit when you hit the limits of namespaces and want to avoid making special exceptions to the tenant isolation configuration of the underlying cluster. Common use cases include a user who needs their own CRDs or their own pods across different namespaces that need to communicate beyond what your standard NetworkPolicy allows.
1212

1313
## Virtual Cluster example
1414

platform/api/use-api.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_position: 2
77
The vCluster platform management API is a Kubernetes API server that only serves virtual resources (not persisted in etcd) that facilitate interaction with vCluster platform.
88
These resources are primarily used by the UI and CLI to change state in the Kubernetes cluster where vCluster platform is installed in, without the need to have cluster wide access.
99

10-
In order to access the vCluster platform management api, you'll need a vCluster platform access key. See [access keys](../administer/authentication/access-keys) for more information how to create a new access key.
10+
In order to access the vCluster Platform management API, you'll need a vCluster Platform access key. See [access keys](../administer/authentication/access-keys) for more information how to create a new access key.
1111

1212
After you have obtained an access key, login into vCluster platform and connect to the management API:
1313

@@ -26,7 +26,7 @@ To view what resources are available in the management API Kubernetes server, yo
2626

2727
## Optional: Connect to the Kubernetes Cluster vCluster platform is installed in
2828

29-
Since the vCluster platform API server doesn't contain resources such as `pods`, `services` etc., some tools get confused and won't work with the vCluster platform API server directly (such as ArgoCD). Instead of using `loft use management` to access the resources, you can run the following command instead:
29+
Since the vCluster Platform API server doesn't contain resources such as `pods`, `services`, and so on, some tools get confused and won't work with the vCluster Platform API server directly (such as ArgoCD). Instead of using `vcluster platform connect management` to access the resources, you can run the following command instead:
3030

3131
```
3232
# Get a context to the cluster where loft is installed in instead
@@ -39,4 +39,4 @@ kubectl get users.management.loft.sh
3939
kubectl get pods
4040
```
4141

42-
The main difference between this approach and `vcluster platform connect management` is that all requests are routed through an actual Kubernetes cluster, which can be wanted if other resources are needed, but also expose all APIs to the requester, which is why we recommend to use `loft use management` if possible.
42+
The main difference between this approach and `vcluster platform connect management` is that all requests are routed through an actual Kubernetes cluster, which can be wanted if other resources are needed, but also expose all APIs to the requester, which is why we recommend to use `vcluster platform connect management` if possible.

platform/integrations/argocd/deploy-applications.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ Setting `target: host` deploys the application onto the control plane cluster ra
285285

286286
- **Who controls the tenant cluster configuration?** If tenants can edit `vcluster.yaml` directly, they can deploy arbitrary workloads onto the control plane cluster. Restrict this to platform admins or use cluster templates to limit what values tenants can set.
287287
- **The control plane cluster must have a connector.** If the control plane cluster does not have an Argo CD connector configured, applications with `target: host` will fail to deploy.
288-
- **Applications are deployed into a specific namespace.** The `destination.namespace` in the argoCDApplication field determines where the application lands on the control plane cluster. Ensure that deploying in that namespace wouldn't cause any disruption on the host cluster.
288+
- **Applications deploy into a specific namespace.** The `destination.namespace` in the argoCDApplication field determines where the application lands on the control plane cluster. Ensure that deploying in that namespace wouldn't cause any disruption on the control plane cluster.
289289

290290
This is a platform-admin-level capability. Do not expose it to end users without proper guardrails.
291291
:::

0 commit comments

Comments
 (0)