Skip to content

Commit 27d7282

Browse files
authored
[v4.9.0] docs(doc-1410): terminology — integrations/, maintenance/, how-to/ batch 4 (#2131) (#2162)
* Backport: Copy platform/how-to/exposing-vCluster-platform-with-Istio.mdx to platform_versioned_docs/version-4.9.0/how-to/exposing-vCluster-platform-with-Istio.mdx * Backport: Copy platform/how-to/gitops-end-to-end.mdx to platform_versioned_docs/version-4.9.0/how-to/gitops-end-to-end.mdx * Backport: Copy platform/how-to/use-go-template.mdx to platform_versioned_docs/version-4.9.0/how-to/use-go-template.mdx * Backport: Copy platform/integrations/argocd.mdx to platform_versioned_docs/version-4.9.0/integrations/argocd.mdx * Backport: Copy platform/integrations/gitlab-ci.mdx to platform_versioned_docs/version-4.9.0/integrations/gitlab-ci.mdx * Backport: Copy platform/integrations/karpenter.mdx to platform_versioned_docs/version-4.9.0/integrations/karpenter.mdx * Backport: Copy platform/maintenance/backup-restore/preserve-license.mdx to platform_versioned_docs/version-4.9.0/maintenance/backup-restore/preserve-license.mdx * Backport: Copy platform/maintenance/monitoring/central-hostpath-mapper.mdx to platform_versioned_docs/version-4.9.0/maintenance/monitoring/central-hostpath-mapper.mdx * Backport: Copy platform/maintenance/uninstall.mdx to platform_versioned_docs/version-4.9.0/maintenance/uninstall.mdx * Backport: Copy platform/maintenance/upgrade-migrate/migrate-to-hostcluster.mdx to platform_versioned_docs/version-4.9.0/maintenance/upgrade-migrate/migrate-to-hostcluster.mdx * Backport: Copy platform/maintenance/upgrade-migrate/upgrade.mdx to platform_versioned_docs/version-4.9.0/maintenance/upgrade-migrate/upgrade.mdx
1 parent 5fb1659 commit 27d7282

11 files changed

Lines changed: 90 additions & 90 deletions

File tree

platform_versioned_docs/version-4.9.0/how-to/exposing-vCluster-platform-with-Istio.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Before exposing the platform with Istio, ensure you have:
2222

2323
## Install Istio {#install-istio}
2424

25-
Install Istio on your platform host cluster:
25+
Install Istio on your platform control plane cluster:
2626

2727
```bash title="Install Istio on your cluster"
2828
istioctl install
@@ -86,7 +86,7 @@ For more information about setting up TLS certificates, see the [Istio Secure Ga
8686

8787
## Enable Tailscale connectivity {#enable-tailscale-connectivity}
8888

89-
For external virtual clusters or platform agents on connected clusters to communicate with the platform, apply this `EnvoyFilter`:
89+
For external tenant clusters or platform agents on connected clusters to communicate with the platform, apply this `EnvoyFilter`:
9090

9191
```yaml title="Apply EnvoyFilter for Tailscale connectivity"
9292
apiVersion: networking.istio.io/v1alpha3

platform_versioned_docs/version-4.9.0/how-to/gitops-end-to-end.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
title: End-to-end GitOps with ArgoCD
33
sidebar_label: GitOps End-to-End
44
sidebar_position: 1
5-
description: Complete guide to managing vCluster Platform and virtual clusters with ArgoCD, from platform installation to virtual cluster deployment.
5+
description: Complete guide to managing vCluster Platform and tenant clusters with ArgoCD, from platform installation to tenant cluster deployment.
66
---
77

88
import InterpolatedCodeBlock from "@site/src/components/InterpolatedCodeBlock";
99

10-
This guide walks through the full lifecycle of managing platform resources with ArgoCD, covering platform installation, cluster connections, project creation, and virtual cluster deployment. Each section references the detailed documentation for that step and provides the ArgoCD-specific configuration needed.
10+
This guide walks through the full lifecycle of managing platform resources with ArgoCD, covering platform installation, cluster connections, project creation, and tenant cluster deployment. Each section references the detailed documentation for that step and provides the ArgoCD-specific configuration needed.
1111

1212
:::info
1313
While this guide uses ArgoCD as the example, the same principles apply to other GitOps tools like Flux. Each section links to detailed documentation that includes tabs for alternative tooling.
@@ -79,9 +79,9 @@ ArgoCD does not deploy the Helm release secret. Platform configuration updates m
7979

8080
For the full set of Helm configuration options and alternative installation methods, see the [platform installation with ArgoCD guide](../install/gitops.mdx).
8181

82-
## 2. Connect a host cluster
82+
## 2. Connect a control plane cluster
8383

84-
After the platform is running, connect host clusters where virtual clusters will be deployed. In a GitOps workflow, you can manage connected clusters as Kubernetes resources alongside your platform installation.
84+
After the platform is running, connect control plane clusters where tenant clusters will be deployed. In a GitOps workflow, you can manage connected clusters as Kubernetes resources alongside your platform installation.
8585

8686
Each connected cluster requires two resources: a Cluster object and a Secret containing the cluster credentials.
8787

@@ -181,7 +181,7 @@ For interactive setup methods using the UI or CLI, see the [connect a cluster gu
181181

182182
## 3. Create a project
183183

184-
Projects organize virtual clusters and control access, templates, and quotas. In a GitOps workflow, define projects as Project custom resources.
184+
Projects organize tenant clusters and control access, templates, and quotas. In a GitOps workflow, define projects as Project custom resources.
185185

186186
<InterpolatedCodeBlock
187187
code={`apiVersion: management.loft.sh/v1
@@ -211,7 +211,7 @@ spec:
211211

212212
### Enable ArgoCD integration on the project
213213

214-
To sync virtual clusters into ArgoCD as deployment targets, enable the ArgoCD integration on the project. This is configured through the project spec and allows virtual clusters to appear as available clusters in the ArgoCD UI.
214+
To sync tenant clusters into ArgoCD as deployment targets, enable the ArgoCD integration on the project. This is configured through the project spec and allows tenant clusters to appear as available clusters in the ArgoCD UI.
215215

216216
See the [ArgoCD integration guide](../integrations/argocd.mdx) for UI-based setup and configuration of SSO integration and App Project mapping.
217217

@@ -221,9 +221,9 @@ Define resources using the `management.loft.sh` API group. The `storage.loft.sh`
221221

222222
For interactive project creation using the UI, see the [create a project guide](../administer/projects/create.mdx).
223223

224-
## 4. Deploy virtual clusters
224+
## 4. Deploy tenant clusters
225225

226-
With the platform, cluster, and project in place, deploy virtual clusters through ArgoCD. There are two approaches depending on how you want to manage the virtual cluster lifecycle.
226+
With the platform, cluster, and project in place, deploy tenant clusters through ArgoCD. There are two approaches depending on how you want to manage the tenant cluster lifecycle.
227227

228228
### Option A: Deploy with VirtualClusterInstance
229229

@@ -258,12 +258,12 @@ spec:
258258
/>
259259

260260
:::tip
261-
The namespace follows the pattern `loft-p-<project-name>`. The platform uses this convention to associate virtual clusters with projects.
261+
The namespace follows the pattern `loft-p-<project-name>`. The platform uses this convention to associate tenant clusters with projects.
262262
:::
263263

264264
### Option B: Deploy with Helm chart directly
265265

266-
Deploy the vCluster Helm chart through an ArgoCD Application. This approach gives you direct control over the Helm release but does not provide platform lifecycle features unless you [register the virtual cluster afterward](../use-platform/virtual-clusters/add-virtual-clusters.mdx).
266+
Deploy the vCluster Helm chart through an ArgoCD Application. This approach gives you direct control over the Helm release but does not provide platform lifecycle features unless you [register the tenant cluster afterward](../use-platform/virtual-clusters/add-virtual-clusters.mdx).
267267

268268
<InterpolatedCodeBlock
269269
code={`apiVersion: argoproj.io/v1alpha1
@@ -335,6 +335,6 @@ platform-gitops/
335335
## Next steps
336336

337337
- [Configure platform settings](../configure/introduction.mdx) for authentication, audit logging, and more
338-
- [Set up templates](../administer/templates/create-templates.mdx) to standardize virtual cluster configurations
338+
- [Set up templates](../administer/templates/create-templates.mdx) to standardize tenant cluster configurations
339339
- [Configure project quotas](../administer/projects/quotas.mdx) to control resource usage
340-
- [Enable sleep mode](/docs/vcluster/manage/sleep-wakeup) to reduce costs on idle virtual clusters
340+
- [Enable sleep mode](/docs/vcluster/manage/sleep-wakeup) to reduce costs on idle tenant clusters

platform_versioned_docs/version-4.9.0/how-to/use-go-template.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A Go template function is a built-in or user-defined helper function. It can be
1010
transform data when rendering text. For example, in a Helm
1111
chart (which uses Go templates), functions such as `default`, `upper`, and `quote` are commonly used to process values dynamically.
1212

13-
Templates in vCluster Platform standardize configurations for virtual clusters, namespaces, and applications.
13+
Templates in vCluster Platform standardize configurations for tenant clusters, namespaces, and applications.
1414
You can create templates through the vCluster Platform UI or by applying manifests directly to your cluster using vCluster CLI or Helm charts.
1515
The platform provides the VirtualClusterTemplate CRD for defining templates.
1616
For more information, see [Creating Templates](../administer/templates/create-templates).

platform_versioned_docs/version-4.9.0/integrations/argocd.mdx

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,22 @@ import FeatureTable from '@site/src/components/FeatureTable';
1717

1818
vCluster Platform provides several points of integration with [Argo CD](https://argo-cd.readthedocs.io/en/stable/),
1919
a popular GitOps tool for Kubernetes. The Argo CD integration is designed to help users take advantage
20-
of the speed and ease of creating virtual clusters, as well as the power of Argo CD for managing and
21-
deploying applications within those virtual clusters.
20+
of the speed and ease of creating tenant clusters, as well as the power of Argo CD for managing and
21+
deploying applications within those tenant clusters.
2222

2323
Argo CD Integration has three major components or levels, with each level adding additional
2424
integration touch points.
2525

26-
1. Sync virtual clusters to Argo CD
26+
1. Sync tenant clusters to Argo CD
2727
2. Enable SSO Integration (sign in to Argo CD via vCluster Platform)
2828
3. Create Argo CD [App Project](https://argo-cd.readthedocs.io/en/stable/user-guide/projects/)
2929
per vCluster Platform Project
3030

31-
The simplest level of integration is syncing virtual clusters into Argo CD as available clusters
32-
for deployments. In this deployment model, virtual clusters that are part of an Argo enabled
31+
The simplest level of integration is syncing tenant clusters into Argo CD as available clusters
32+
for deployments. In this deployment model, tenant clusters that are part of an Argo enabled
3333
project, and have the `loft.sh/import-argocd` label set to `true` will be automatically "synced"
34-
to Argo CD. These virtual clusters will show up as clusters that are available for deployments
35-
in the Argo CD UI. When the virtual clusters are deleted, vCluster Platform will automatically remove the
34+
to Argo CD. These tenant clusters will show up as clusters that are available for deployments
35+
in the Argo CD UI. When the tenant clusters are deleted, vCluster Platform will automatically remove the
3636
deleted cluster from Argo CD.
3737

3838
The second integration level is enabling SSO integration. This is a project level setting that
@@ -84,15 +84,15 @@ under the 'Project Settings' button.
8484
In the new configurations that appeared under the{" "}
8585
<Label>Enable Argo CD Integration</Label> slider, select either{" "}
8686
<Label>Clusters</Label> or
87-
<Label>Virtual Clusters</Label> from the dropdown box in the <Label>
87+
<Label>Tenant Clusters</Label> from the dropdown box in the <Label>
8888
Where is Argo CD running
8989
</Label> dropdown. This tells vCluster Platform if your Argo CD instance lives
9090
in a connected physical cluster, or if it is running inside of a virtual
9191
cluster.
9292
</Step>
9393
<Step>
9494
In the next drop down to the right, select the name of the cluster or
95-
virtual cluster that your Argo CD instance is deployed in.
95+
tenant cluster that your Argo CD instance is deployed in.
9696
</Step>
9797
<Step>
9898
If your Argo CD instance is deployed in a namespace other than `argocd`,
@@ -123,15 +123,15 @@ under the 'Project Settings' button.
123123
In the new configurations that appeared under the{" "}
124124
<Label>Enable Argo CD Integration</Label> slider, select either{" "}
125125
<Label>Clusters</Label> or
126-
<Label>Virtual Clusters</Label> from the dropdown box in the <Label>
126+
<Label>Tenant Clusters</Label> from the dropdown box in the <Label>
127127
Where is Argo CD running
128128
</Label> dropdown. This tells vCluster Platform if your Argo CD instance lives
129129
in a connected physical cluster, or if it is running inside of a virtual
130130
cluster.
131131
</Step>
132132
<Step>
133133
In the next drop down to the right, select the name of the cluster or
134-
virtual cluster that your Argo CD instance is deployed in.
134+
tenant cluster that your Argo CD instance is deployed in.
135135
</Step>
136136
<Step>
137137
If your Argo CD instance is deployed in a namespace other than `argocd`,
@@ -146,7 +146,7 @@ under the 'Project Settings' button.
146146
</Tabs>
147147

148148
:::warning Disabling Argo CD Integration
149-
Upon disabling of Argo integration at the project, all virtual clusters will be removed from Argo
149+
Upon disabling of Argo integration at the project, all tenant clusters will be removed from Argo
150150
CD, so be careful when disabling Argo CD at the project level.
151151
:::
152152

@@ -186,15 +186,15 @@ configured via with the Helm values, or in the `Admin` section of the UI on the
186186
In the new configurations that appeared under the{" "}
187187
<Label>Enable Argo CD Integration</Label> slider, select either{" "}
188188
<Label>Clusters</Label> or
189-
<Label>Virtual Clusters</Label> from the dropdown box in the <Label>
189+
<Label>Tenant Clusters</Label> from the dropdown box in the <Label>
190190
Where is Argo CD running
191191
</Label> dropdown. This tells vCluster Platform if your Argo CD instance lives
192192
in a connected physical cluster, or if it is running inside of a virtual
193193
cluster.
194194
</Step>
195195
<Step>
196196
In the next drop down to the right, select the name of the cluster or
197-
virtual cluster that your Argo CD instance is deployed in.
197+
tenant cluster that your Argo CD instance is deployed in.
198198
</Step>
199199
<Step>
200200
If your Argo CD instance is deployed in a namespace other than `argocd`,
@@ -259,25 +259,25 @@ App Project integration, can be enabled by editing a project manifest and settin
259259
provide metadata fields to apply the Argo CD App Project object, Argo CD RBAC roles to apply,
260260
and an array of permissible source repositories that may be accessed within the project.
261261

262-
## Virtual Cluster Integration
262+
## Tenant cluster integration
263263

264-
### Enable Virtual Cluster Import
264+
### Enable tenant cluster import
265265

266-
Once a project has Argo CD enabled, virtual clusters within that project are eligible to be
267-
synced to the Argo instance as available clusters. You can enable virtual cluster import into
268-
Argo CD during the virtual cluster creation step, or by enabling this feature on existing
269-
virtual clusters.
266+
Once a project has Argo CD enabled, tenant clusters within that project are eligible to be
267+
synced to the Argo instance as available clusters. You can enable tenant cluster import into
268+
Argo CD during the tenant cluster creation step, or by enabling this feature on existing
269+
tenant clusters.
270270

271271
:::info Make Sure Your Project Has Argo CD Enabled.
272-
If the project your virtual cluster resides in does _not_ have Argo CD integration enabled, you
272+
If the project your tenant cluster resides in does _not_ have Argo CD integration enabled, you
273273
will not see the Argo CD import option!
274274
:::
275275

276276
<Tabs
277277
defaultValue="creation"
278278
values={[
279-
{ label: "During Virtual Cluster Creation", value: "creation" },
280-
{ label: "On Existing Virtual Cluster", value: "existing" },
279+
{ label: "During Tenant Cluster Creation", value: "creation" },
280+
{ label: "On Existing Tenant Cluster", value: "existing" },
281281
]}
282282
>
283283
<TabItem value="creation">
@@ -286,16 +286,16 @@ will not see the Argo CD import option!
286286
Select the project you intend to enable Argo CD from from the projects dropdown at the top of the left navigation bar.
287287
</Step>
288288
<Step>
289-
Click on Virtual Clusters and the{" "}
290-
<Button>New Virtual Cluster</Button> button.
289+
Click on Tenant Clusters and the{" "}
290+
<Button>New Tenant Cluster</Button> button.
291291
</Step>
292292
<Step>
293-
In the popup, optionally select the virtual cluster template, then click
293+
In the popup, optionally select the tenant cluster template, then click
294294
the
295295
<Button>Create</Button> button.
296296
</Step>
297297
<Step>
298-
Find your desired virtual cluster in the virtual cluster list. Slide the
298+
Find your desired tenant cluster in the tenant cluster list. Slide the
299299
<Label>ArgoCD</Label> slider to enabled.
300300
</Step>
301301
</Flow>
@@ -306,21 +306,21 @@ will not see the Argo CD import option!
306306
Select the project you intend to enable Argo CD from from the projects dropdown at the top of the left navigation bar.
307307
</Step>
308308
<Step>
309-
Find your desired virtual cluster in the virtual cluster list. Slide the
309+
Find your desired tenant cluster in the tenant cluster list. Slide the
310310
<Label>ArgoCD</Label> slider to enabled.
311311
</Step>
312312
</Flow>
313313
</TabItem>
314314
</Tabs>
315315

316316
:::warning Integration Errors
317-
If there are any errors adding your virtual cluster to Argo CD, the virtual cluster status will
317+
If there are any errors adding your tenant cluster to Argo CD, the tenant cluster status will
318318
show a warning, clicking on the warning will give you a message indicating the cause of the issues.
319319
:::
320320

321321
## Disable the Argo CD Integration
322322

323-
The Argo CD integration can be disabled on a per virtual cluster or per project level by toggling the same sliders
324-
used to enable it. Disabling the integration at the virtual cluster level simply removes it as a registered cluster
325-
in Argo CD. Disabling the integration at the project level removes all virtual clusters from Argo CD, so be careful
323+
The Argo CD integration can be disabled on a per tenant cluster or per project level by toggling the same sliders
324+
used to enable it. Disabling the integration at the tenant cluster level simply removes it as a registered cluster
325+
in Argo CD. Disabling the integration at the project level removes all tenant clusters from Argo CD, so be careful
326326
when disabled Argo at this level.

platform_versioned_docs/version-4.9.0/integrations/gitlab-ci.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ When using vCluster Platform with GitLab you can use the
88
official image `ghcr.io/loft-sh/vcluster-cli` as either a base image or
99
directly. If additional tooling is needed for your CI/CD process, a custom image can be created.
1010

11-
## Virtual Clusters for Merge Requests
11+
## Tenant clusters for merge requests
1212

13-
This example shows how to create and delete a Virtual Cluster for running end-to-end tests for
13+
This example shows how to create and delete a Tenant Cluster for running end-to-end tests for
1414
the default branch and merge requests. It assumes you have configured CI/CD variables `VCLUSTER_PRO_URL`,
1515
`VCLUSTER_PRO_ACCESS_KEY`, and `VCLUSTER_PRO_PROJECT`.
1616

@@ -55,15 +55,15 @@ or add the `--namespace` flag to the `vcluster platform create` command.
5555
2. The `before_script` first logs in to vCluster Platform using the `$VCLUSTER_PRO_URL` and `$VCLUSTER_PRO_ACCESS_KEY`
5656
variables that you defined in GitLab.
5757
[See the GitLab docs for more information](https://docs.gitlab.com/ee/ci/variables/)
58-
3. The `before_script` then creates a virtual cluster using
58+
3. The `before_script` then creates a tenant cluster using
5959
[predefined GitLab variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)
60-
to create a unique name. Optionally, the `--upgrade` flag can be used to reuse an existing virtual cluster instead of creating a new one.
60+
to create a unique name. Optionally, the `--upgrade` flag can be used to reuse an existing tenant cluster instead of creating a new one.
6161
4. Next `before_script` installs some additional tooling needed to run the end-to-end tests. For
6262
more complex scenarios creating a custom image is recommended.
6363
5. Then the `script` section uses `kubectl` to deploy the application to the space and waits for
6464
the `my-app` deployment to become ready. `make` is then used to run an end-to-end test suite.
65-
6. Finally `after_script` deletes the virtual cluster, and passes `--delete-namespace` to ensure the
66-
corresponding namespace for the virtual cluster is deleted. By using `after_script` we can ensure the virtual cluster
67-
is deleted even if the tests fail. You may wish to skip this step if reusing the virtual cluster with the `--upgrade` flag when creating the virtual cluster.
65+
6. Finally `after_script` deletes the tenant cluster, and passes `--delete-namespace` to ensure the
66+
corresponding namespace for the tenant cluster is deleted. By using `after_script` we can ensure the tenant cluster
67+
is deleted even if the tests fail. You may wish to skip this step if reusing the tenant cluster with the `--upgrade` flag when creating the tenant cluster.
6868

6969

0 commit comments

Comments
 (0)