Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions platform/use-platform/apps/updating.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ updated versions will show up with a warning indicating that a newer App version

### Updating An Installed App's Version

You can change the version of an installed App in a space, cluster, or virtual cluster to a
You can change the version of an installed App in a space, cluster, or tenant cluster to a
newer (or older!) version in the vCluster Platform UI.

<Tabs
defaultValue="cluster"
values={[
{ label: "(Physical) Cluster", value: "cluster" },
{ label: "Virtual Cluster", value: "vcluster" },
{ label: "Tenant Cluster", value: "vcluster" },
]}
>
<TabItem value="cluster">
Expand Down Expand Up @@ -68,18 +68,18 @@ newer (or older!) version in the vCluster Platform UI.
Select the <NavStep>Projects</NavStep> field on the left menu bar.
</Step>
<Step>
Select the project containing the virtual cluster that you'd like to
Select the project containing the tenant cluster that you'd like to
install the App in from the Project drop down menu.
</Step>
<Step>
From the Projects sub-menu, select the Virtual Clusters option.
From the Projects sub-menu, select the Tenant Clusters option.
</Step>
<Step>
Find the virtual cluster containing the App you would like to upgrade,
click on that virtual cluster.
Find the tenant cluster containing the App you would like to upgrade,
click on that tenant cluster.
</Step>
<Step>
In the Virtual Cluster Management view, click the <Button>Apps</Button>{" "}
In the Tenant Cluster Management view, click the <Button>Apps</Button>{" "}
button.
</Step>
<Step>
Expand Down
18 changes: 9 additions & 9 deletions platform/use-platform/apps/use-in-templates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ import Label from "@site/src/components/Label";


Apps are a way for admins to package applications and scripts in consumable packages.
These applications can then be deployed into namespaces or virtual clusters through their templates.
These applications can then be deployed into namespaces or tenant clusters through their templates.

Virtual clusters or namespaces combined with Apps are a great way to create repeatable, pre-packaged
Tenant clusters or namespaces combined with Apps are a great way to create repeatable, pre-packaged
development, testing, or even production environments. Once an App has been created in the vCluster Platform
instance, it can be installed into any virtual cluster or namespace -- either at time of creation, or into
instance, it can be installed into any tenant cluster or namespace -- either at time of creation, or into
existing resources. This gives administrators the capability to create fully populated
development, test, or even production, environments in a single easy to manage package.

Templates can take this combination of virtual clusters/namespaces and apps to the next
Templates can take this combination of tenant clusters/namespaces and apps to the next
level, by creating simple, reusable, version-able templates that define a reproducible environment.When an App is included in
a template, that app will be deployed in the given resource upon creation.

Expand All @@ -30,17 +30,17 @@ a template, that app will be deployed in the given resource upon creation.
Select the <NavStep>Templates</NavStep> field on the left menu bar.
</Step>
<Step>
From the Templates sub-menu, select the Virtual Clusters option.
From the Templates sub-menu, select the Tenant Clusters option.
</Step>
<Step>
Edit an existing template, or create a new virtual cluster template.
Edit an existing template, or create a new tenant cluster template.
</Step>
<Step>
Click the <Label>Apps</Label> configuration tab. <br></br>
<br></br>
<b>Note: </b>
the apps defined in this section of the template configuration are apps to
be deployed *in* the virtual cluster!
be deployed *in* the tenant cluster!
</Step>
<Step>
From the drop down menu <Label>Add a new App ...</Label> select an App
Expand All @@ -63,8 +63,8 @@ a template, that app will be deployed in the given resource upon creation.
<br></br>
<br></br>
<b>Note:</b> the apps defined in this section of the template configuration
are apps to be deployed in the *space* the virtual cluster will be deployed
in (not inside the virtual cluster itself).
are apps to be deployed in the *space* the tenant cluster will be deployed
in (not inside the tenant cluster itself).
</Step>
<Step>
From the drop down menu <Label>Add a new App ...</Label> select an App
Expand Down
28 changes: 14 additions & 14 deletions platform/use-platform/apps/use-on-demand.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,36 +14,36 @@ import PartialVirtualClusterInstallApp from "../../_partials/vcluster/add-app-ui


Apps are a way for admins to package applications and scripts in consumable packages.
These applications can then be deployed into clusters, namespaces, or virtual clusters managed by vCluster Platform.
These applications can then be deployed into clusters, namespaces, or tenant clusters managed by vCluster Platform.
This can be a useful tool for adding pre-defined applications to newly connected clusters, or to
newly created namespaces or virtual clusters that are not already using a template that includes Apps.
newly created namespaces or tenant clusters that are not already using a template that includes Apps.

## Installing Apps on a Virtual Cluster
## Install apps on a tenant cluster

Virtual clusters combined with Apps are a great way to create repeatable, pre-packaged
Tenant clusters combined with Apps are a great way to create repeatable, pre-packaged
development, testing, or even production environments. Once an App has been created in the vCluster Platform
instance, it can be installed into any virtual cluster -- either at time of creation, or into
existing virtual clusters. This gives administrators the capability to create fully populated
instance, it can be installed into any tenant cluster -- either at time of creation, or into
existing tenant clusters. This gives administrators the capability to create fully populated
development, test, or even production, environments in a single easy to manage package.

<Tabs
defaultValue="creation"
values={[
{ label: "During Virtual Cluster Creation", value: "creation" },
{ label: "On Existing Virtual Cluster", value: "existing" },
{ label: "During Tenant Cluster Creation", value: "creation" },
{ label: "On Existing Tenant Cluster", value: "existing" },
]}
>
<TabItem value="creation">
<Flow id="install-app-virtualcluster-creation">
<Step>
From the project drop-down menu (top left corner), select the project you'd like to create the
virtual cluster in.
tenant cluster in.
</Step>
<Step>
Click on <NavStep>Virtual Clusters</NavStep>.
Click on <NavStep>Tenant Clusters</NavStep>.
</Step>
<Step>
Click the <Button>New Virtual Cluster</Button> button. Do not select a template.
Click the <Button>New Tenant Cluster</Button> button. Do not select a template.
</Step>
<Step>
<b>[Optional]</b> Select the cluster in which to create the virtual
Expand All @@ -57,7 +57,7 @@ development, test, or even production, environments in a single easy to manage p
<br></br>
<b>Note:</b>
The apps defined in this section of the configuration are apps to
be deployed *in* the virtual cluster.
be deployed *in* the tenant cluster.
</Step>
<Step>
From the drop down menu <Label>Please select an App...</Label>, select an
Expand All @@ -73,9 +73,9 @@ development, test, or even production, environments in a single easy to manage p
can also configure the Helm release-name.
</Step>
<Step>
Finish configuring anything else you'd like on your virtual cluster,
Finish configuring anything else you'd like on your tenant cluster,
then click the
<Button>Create Virtual Cluster</Button> button.
<Button>Create Tenant Cluster</Button> button.
</Step>
</Flow>
</TabItem>
Expand Down
6 changes: 3 additions & 3 deletions platform/use-platform/machines/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ import FeatureTable from '@site/src/components/FeatureTable';

<FeatureTable names="machine-management" />

A Machine is a provisioned server — physical or virtual — managed by vCluster Platform through a node provider. Machines abstract the provisioning details so that platform administrators can offer self-service access to compute resources. Users request Machines either indirectly through virtual cluster auto-nodes, or directly when they need standalone servers outside the virtual cluster lifecycle.
A Machine is a provisioned server — physical or virtual — managed by vCluster Platform through a node provider. Machines abstract the provisioning details so that platform administrators can offer self-service access to compute resources. Users request Machines either indirectly through tenant cluster auto-nodes, or directly when they need standalone servers outside the tenant cluster lifecycle.

Each Machine is backed by a [node provider](../../administer/node-providers/overview.mdx) that handles the actual provisioning — creating VMs, provisioning bare metal servers, or running Terraform scripts.

## How machines are created

Machines are created in two ways:

- **Auto nodes**: When a virtual cluster is configured with [private nodes and auto nodes](/docs/vcluster/deploy/worker-nodes/private-nodes/auto-nodes/), the platform automatically creates scalable pools of Machines. [Karpenter](/docs/vcluster/configure/vcluster-yaml/private-nodes/auto-nodes) decides when nodes are needed, and the platform provisions them through the configured node provider. The Machine joins the virtual cluster as a worker node.
- **Manual**: Machines can also be created independently, without being connected to a virtual cluster. This is useful for provisioning servers that are managed outside of the virtual cluster lifecycle.
- **Auto nodes**: When a tenant cluster is configured with [private nodes and auto nodes](/docs/vcluster/deploy/worker-nodes/private-nodes/auto-nodes/), the platform automatically creates scalable pools of Machines. [Karpenter](/docs/vcluster/configure/vcluster-yaml/private-nodes/auto-nodes) decides when nodes are needed, and the platform provisions them through the configured node provider. The Machine joins the tenant cluster as a worker node.
- **Manual**: Machines can also be created independently, without being connected to a tenant cluster. This is useful for provisioning servers that are managed outside of the tenant cluster lifecycle.

In both cases, the node provider determines how the Machine is provisioned — what OS image is installed, what user data is applied, and how the server is configured.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import Expander from '@site/src/components/Expander'

<Flow id="sleep-automatic-ui">
<Step>
In the <NavStep>Projects > {props.name === "virtual cluster" ? "Virtual Clusters" : "Namespaces"}</NavStep> view, hover over the {props.name} that you want to configure auto-delete for
In the <NavStep>Projects > {props.name === "tenant cluster" ? "Tenant Clusters" : "Namespaces"}</NavStep> view, hover over the {props.name} that you want to configure auto-delete for
</Step>
<Step>
Click on the <Label>Edit</Label> button to <Label>Edit</Label> the {props.name}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import CreateSpaceStep2 from '@site/static/media/ui/screenshots/spaces/create-sp

<Flow id="sleep-automatic-ui">
<Step>
In the <NavStep>Projects > {props.name === "virtual cluster" ? "Virtual Clusters" : "Namespaces"}</NavStep> view, hover over the {props.name} that you want to configure auto sleep for
In the <NavStep>Projects > {props.name === "tenant cluster" ? "Tenant Clusters" : "Namespaces"}</NavStep> view, hover over the {props.name} that you want to configure auto sleep for
</Step>
<Step>
Click on the <Label>Edit</Label> button to <Label>Edit</Label> the {props.name}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import CodeBlock from '@theme/CodeBlock';

<p>To put a {props.name} to sleep using vCluster CLI, run:</p>
<CodeBlock>
vcluster platform sleep {props.name === "virtual cluster" ? "vcluster" : "namespace"} [name]
vcluster platform sleep {props.name === "tenant cluster" ? "vcluster" : "namespace"} [name]
</CodeBlock>

:::tip Automatic Wakeup
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import Expander from '@site/src/components/Expander'

<Flow id="sleep-automatic-constraint-schedule-ui">
<Step>
In the <NavStep>Projects > {props.name === "virtual cluster" ? "Virtual Clusters" : "Namespaces"}</NavStep> view, hover over {props.name} that you want to configure auto sleep for
In the <NavStep>Projects > {props.name === "tenant cluster" ? "Tenant Clusters" : "Namespaces"}</NavStep> view, hover over {props.name} that you want to configure auto sleep for
</Step>
<Step>
Click on the <Label>Edit</Label> button to <Label>Edit</Label> the {props.name}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ import CodeBlock from '@theme/CodeBlock';

<p>To wake up a sleeping {props.name} using vCluster CLI, run:</p>
<CodeBlock>
vcluster platform wakeup {props.name === "virtual cluster" ? "vcluster" : "namespace"} [name]
vcluster platform wakeup {props.name === "tenant cluster" ? "vcluster" : "namespace"} [name]
</CodeBlock>
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import Label from '@site/src/components/Label'

<Flow id="wakeup-manual-ui">
<Step>
In the <NavStep>Projects > {props.name === "virtual cluster" ? "Virtual Clusters" : "Namespaces"}</NavStep> view, hover over the <Label>Status</Label> column of the {props.name} that you want to wake up
In the <NavStep>Projects > {props.name === "tenant cluster" ? "Tenant Clusters" : "Namespaces"}</NavStep> view, hover over the <Label>Status</Label> column of the {props.name} that you want to wake up
</Step>
<Step>
While hovering over the row, you will see a tooltip appear that provide information about the sleep state of this {props.name}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import Label from '@site/src/components/Label'
You can add custom links to namespaces that point to external resources such as GitHub pull requests, Jira issues, or documentation.
This allows team members to access all relevant resources directly from the namespace view.

:::tip Virtual cluster custom links
For more information on configuring custom links for virtual clusters, see the [Custom Links](/docs/vcluster/next/key-features/custom-links) documentation.
:::tip Tenant cluster custom links
For more information on configuring custom links for tenant clusters, see the [Custom Links](/docs/vcluster/next/key-features/custom-links) documentation.
:::

<Tabs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ By default, Global Admins, Management Admins, and Project Admins can access Debu
:::

Administrators can grant additional access by allowing the `virtualclusterinstances/debug-shell` and `virtualclusterinstances/debug-shell-pods` subresources.
This role should be assigned to users who already have access to the virtual cluster.
This role should be assigned to users who already have access to the tenant cluster.
For example, the following project role grants access:

```yaml
Expand Down
Loading
Loading