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
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>
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.
17
17
18
18
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.
Copy file name to clipboardExpand all lines: platform/_partials/cluster/upgrade-cli.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
@@ -22,7 +22,7 @@ import Expander from '@site/src/components/Expander'
22
22
cluster-name | 7s
23
23
```
24
24
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`.
26
26
</Step>
27
27
<Step>
28
28
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:
Copy file name to clipboardExpand all lines: platform/_partials/cluster/upgrade-helm.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ import Expander from '@site/src/components/Expander'
22
22
14:43:35 info vCluster platform host: https://loftg2fei.loft.host
23
23
14:43:35 info Access Key: xxxxxxxx
24
24
```
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.
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.
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.
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.
Copy file name to clipboardExpand all lines: platform/api/use-api.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
@@ -7,7 +7,7 @@ sidebar_position: 2
7
7
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.
8
8
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.
9
9
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.
11
11
12
12
After you have obtained an access key, login into vCluster platform and connect to the management API:
13
13
@@ -26,7 +26,7 @@ To view what resources are available in the management API Kubernetes server, yo
26
26
27
27
## Optional: Connect to the Kubernetes Cluster vCluster platform is installed in
28
28
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:
30
30
31
31
```
32
32
# Get a context to the cluster where loft is installed in instead
@@ -39,4 +39,4 @@ kubectl get users.management.loft.sh
39
39
kubectl get pods
40
40
```
41
41
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.
Copy file name to clipboardExpand all lines: platform/integrations/argocd/deploy-applications.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
@@ -285,7 +285,7 @@ Setting `target: host` deploys the application onto the control plane cluster ra
285
285
286
286
-**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.
287
287
-**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.
289
289
290
290
This is a platform-admin-level capability. Do not expose it to end users without proper guardrails.
0 commit comments