Skip to content

Commit 67725a5

Browse files
authored
fix: reorder sidebar for platform (#644)
1 parent 48c4c26 commit 67725a5

26 files changed

Lines changed: 281 additions & 279 deletions

File tree

configsrc/vcluster/main/vcluster.schema.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@
209209
},
210210
"coredns": {
211211
"$ref": "#/$defs/CoreDNS",
212-
"description": "CoreDNS defines everything related to the coredns that is deployed and used within the vCluster."
212+
"description": "CoreDNS defines everything related to the coreDNS that is deployed and used within the vCluster."
213213
},
214214
"proxy": {
215215
"$ref": "#/$defs/ControlPlaneProxy",
@@ -703,7 +703,7 @@
703703
},
704704
"embedded": {
705705
"type": "boolean",
706-
"description": "Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is a PRO feature."
706+
"description": "Embedded defines if vCluster will start the embedded coredns service within the control-plane and not as a separate deployment. This is an Enterprise feature."
707707
},
708708
"service": {
709709
"$ref": "#/$defs/CoreDNSService",
@@ -2595,7 +2595,7 @@
25952595
"secret": {
25962596
"type": "boolean"
25972597
},
2598-
"configmap": {
2598+
"configMap": {
25992599
"type": "boolean"
26002600
}
26012601
},

platform/_partials/install/upgrade.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Upgrade the platform via:
1414
defaultValue="cli"
1515
values={[
1616
{ label: 'CLI', value: 'cli', },
17-
{ label: 'helm', value: 'helm', },
17+
{ label: 'Helm', value: 'helm', },
1818
]
1919
}>
2020
<TabItem value="cli">

platform/administer/projects/quotas.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import Button from "@site/src/components/Button";
1010
import Label from "@site/src/components/Label";
1111
import Link from "@docusaurus/Link";
1212

13-
Quotas allow you to set resource usage and count limits for the project. This works similiarly to Kubernetes `ResourcesQuotas`, but applies across multiple clusters. Quotas can be
13+
Quotas allow you to set resource usage and count limits for the project. This works similarly to Kubernetes `ResourcesQuotas`, but applies across multiple clusters. Quotas can be
1414
defined across the whole project or on a per-user/per-team basis.
1515

1616
:::info Project quotas with multiple virtual clusters

platform/administer/upgrade-migrate/upgrade.mdx

Lines changed: 0 additions & 18 deletions
This file was deleted.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Upgrade and Migrate",
3-
"position": 10,
3+
"position": 5,
44
"collapsible": true,
5-
"collapsed": true
5+
"collapsed": false
66
}

platform/install/supported_versions.mdx renamed to platform/install/upgrade-migrate/lifecycle-policy.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
title: Lifecycle Policy
3-
sidebar_label: Releases and Maintenance
4-
sidebar_position: 5
2+
title: Lifecycle policy
3+
sidebar_label: Lifecycle Policy
4+
sidebar_position: 1
55
keywords: [support matrix, supported versions, lifecycle]
66
---
7+
78
import SupportTerminology from '@site/docs/_partials/support_terminology.mdx';
89

910

@@ -26,6 +27,6 @@ Any previous versions which are not on this list are no longer in any support wi
2627
| v4.0 | October 15, 2024 | January 15, 2025 | April 15, 2025 |
2728
| v3.4| February 29, 2024 | April 1, 2025* | July 1, 2025 |
2829

29-
\* Due to the number of breaking changes from vCluster v0.19 to v0.20 and Platform v3.4 to v4.0, v3.4 has an extended active support end date. Review the [migration guide](../reference/migrations/4-0-migration.mdx) to upgrade your v3.4 to v4.0 Platform.
30+
\* Due to the number of breaking changes from vCluster v0.19 to v0.20 and Platform v3.4 to v4.0, v3.4 has an extended active support end date. Review the [migration guide](../../reference/migrations/4-0-migration.mdx) to upgrade your v3.4 to v4.0 Platform.
3031

3132
<SupportTerminology />

platform/administer/upgrade-migrate/migrate-to-hostcluster.mdx renamed to platform/install/upgrade-migrate/migrate-to-hostcluster.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Migrate the platform to a different cluster
3-
sidebar_label: Migrate Clusters
4-
sidebar_position: 1
3+
sidebar_label: Migrate vCluster Platform
4+
sidebar_position: 3
55
description: Learn how to migrate vCluster platform from one Kubernetes cluster to another.
66
---
77

88
import Flow, { Step } from '@site/src/components/Flow'
9-
import BasePrerequisites from '../../_partials/install/base-prerequisites.mdx';
9+
import BasePrerequisites from '@site/platform/_partials/install/base-prerequisites.mdx';
1010

1111
This guide explains how to migrate the platform to a different Kubernetes cluster, which might be necessary during cluster decommissioning or cloud platform migration.
1212

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Upgrade vCluster Platform
3+
sidebar_label: Upgrade vCluster Platform
4+
sidebar_position: 2
5+
---
6+
7+
import PartialAdminUpgrade from "@site/platform/_partials/install/upgrade.mdx";
8+
9+
You can upgrade vCluster Platform using either the vCluster CLI or Helm.
10+
11+
<PartialAdminUpgrade />
12+
13+
:::info Versions and Values
14+
The `$PLATFORM_VERSION` environment variable specifies the vCluster Platform version to deploy.
15+
The `vcluster-platform.yaml` file is optional and defines Helm values to use when upgrading the vCluster Platform deployment.
16+
:::
17+

platform/reference/migrations/4-0-migration.mdx

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
---
2-
title: Upgrade Guide from pre-v4.0 to v4.0+
2+
title: Upgrade guide for pre-v4.0 to v4.0+
3+
sidebar_label: Upgrade Guide for pre-v4.0 to v4.0+
34
description: How to upgrade from pre-v4.0 to v4.0 release
45
sidebar_position: 1
56
---
67

78
import Tabs from "@theme/Tabs";
89
import TabItem from "@theme/TabItem";
910

10-
These docs cover upgrading from pre v4.0 to v4.0. Once you upgrade to v4.0+, you need to follow the regular [upgrade docs](../../administer/upgrade-migrate/upgrade).
11+
These docs cover upgrading from pre v4.0 to v4.0. After you upgrade to v4.0+, you must follow the upgrade docs.
1112

12-
## Upgrade to the latest Loft v3.x version
13+
## Upgrade to the latest Loft version
1314

1415
Before attempting to perform this major upgrade, upgrade to the latest v3.x version.
1516
Review the [older upgrade docs](https://loft.sh/docs/admin/upgrade-loft) on how to upgrade. It is recommended to upgrade using the CLI and not the UI as there are known issues to upgrade versions through the UI.
1617

17-
## Pre-Upgrade Recommendations
18+
## Pre-upgrade recommendations
1819

1920
### Read through the v4.0 Release Notes
2021

@@ -26,15 +27,15 @@ One of the breaking changes in v4.0 is the requirement of a vCluster version def
2627
the vCluster would automatically upgrade these virtual clusters to the latest default vCluster version. Due to the [breaking changes introduced in v0.20](https://roadmap.vcluster.com/changelog/vcluster-v020-ga),
2728
automatic upgrades of vCluster version are no longer supported and a vCluster version must be set in the spec of a virtual cluster or virtual cluster template.
2829

29-
We recommend confirming that the versions of your virtual clusters and virtual cluster templates are in the resource yaml before upgrading. Otherwise,
30-
your virtual clusters will have errors requiring you to define these versions post upgrade and since it will not know what version you upgraded from, it will not know what
31-
version to set and manual steps will need to happen to determine the correct version and set it.
30+
Confirm that the resource YAML includes the versions of your virtual clusters and virtual cluster templates before upgrading.
31+
Otherwise, your virtual clusters might encounter errors that require you to define these versions after the upgrade.
32+
Because it is not known which version you upgraded from, it cannot set the correct version automatically, and you must manually determine and set it.
3233

33-
#### How to define the vCluster version on Existing Virtual Clusters
34+
#### Define the vCluster version on Existing Virtual Clusters
3435

35-
In the UI, for each virtual cluster, edit the configuration and type the version of the virtual cluster or virtual cluster template in the textbox and the resource yaml will automatically update the spec to include the version.
36+
In the UI, for each virtual cluster, edit the configuration and type the version of the virtual cluster or virtual cluster template in the textbox and the resource YAML automatically updates the spec to include the version.
3637

37-
If the resource yaml of your virtual cluster or virtual cluster template has `spec.template.helmRelease.chart.version` set, then the virtual cluster version is defined.
38+
If the resource YAML of your virtual cluster or virtual cluster template has `spec.template.helmRelease.chart.version` set, then the virtual cluster version is defined.
3839

3940
`spec` Example:
4041

@@ -46,23 +47,23 @@ spec:
4647
version: 0.19.7
4748
```
4849

49-
## Download the latest vCluster CLI (v0.20.0+)
50+
## Download the latest vCluster CLI
5051

5152
With the deprecation of the Loft CLI, review the [Loft CLI to vCluster CLI Migration docs](https://vcluster.com/docs/vcluster/reference/migrations/loft-cli-vcluster-cli-migration).
5253

53-
## Required Changes in your Platform Configuration before Upgrading
54+
## Required changes in your platform configuration before upgrading
5455

5556
A new feature has been added to support the ability to change the prefix of the namespace created for projects. In previous versions, the
5657
prefix was `loft-p`, but in v4.0.0, the new default is `p-`. Due to the change in defaults, the previous prefix needs to be set in the Platform configuration as
5758
part of the upgrade command. Since future upgrades reuse the values of the configuration, you only need to apply it once.
5859

59-
### Appending the project prefix to upgrade commands
60+
### Append the project prefix to upgrade commands
6061

6162
<Tabs
6263
defaultValue="cli"
6364
values={[
6465
{ label: 'CLI', value: 'cli', },
65-
{ label: 'helm', value: 'helm', },
66+
{ label: 'Helm', value: 'helm', },
6667
]
6768
}>
6869
<TabItem value="cli">
@@ -74,8 +75,8 @@ The following steps assume the existing installation is in the default namespace
7475
:::
7576

7677
```bash
77-
PLATFORM_NAMESPACE="loft" # update if the platform is installed to a different namespace
78-
PLATFORM_VERSION="" # specify a version or it will upgrade to latest stable
78+
PLATFORM_NAMESPACE="loft" # Update if the platform is installed to a different namespace
79+
PLATFORM_VERSION="" # Specify a version or it upgrades to latest stable version
7980

8081
vcluster platform start --upgrade --namespace $PLATFORM_NAMESPACE --version=$PLATFORM_VERSION --values=<(cat <<EOF
8182
config:
@@ -90,9 +91,9 @@ EOF
9091
To upgrade vCluster Platform from v3 to v4 via `helm`, run. Update `$PLATFORM_VERSION` with a valid vCluster Platform version.
9192

9293
```bash
93-
PLATFORM_RELEASE_NAME="loft" # update if the Helm release has a different name
94-
PLATFORM_NAMESPACE="loft" # update if the platform is installed to a different namespace
95-
PLATFORM_VERSION="" # specify a version or it will upgrade to latest stable
94+
PLATFORM_RELEASE_NAME="loft" # Update if the Helm release has a different name
95+
PLATFORM_NAMESPACE="loft" # Update if the platform is installed to a different namespace
96+
PLATFORM_VERSION="" # Specify a version or it upgrades to latest stable version
9697

9798
helm upgrade $PLATFORM_RELEASE_NAME vcluster-platform -n $PLATFORM_NAMESPACE --repository-config '' --repo https://charts.loft.sh \
9899
--version $PLATFORM_VERSION \
@@ -116,18 +117,18 @@ config:
116117
projectNamespacePrefix: loft-p-
117118
```
118119

119-
## Post-Upgrade Recommendations
120+
## Post-upgrade recommendations
120121

121-
### Migrating vCluster Platform OIDC Provider Clients
122+
### Migrate vCluster Platform OIDC provider clients
122123

123124
vCluster Platform can be used as an OIDC provider. Formerly, to add clients to the vCluster Platform OIDC provider a user woulld add them to the `oidc.clients` array field
124125
in the vCluster Platform config. This could be done either through the `Admin > Config` UI or through editing the `loft-manager-config` secret found in the namespace vCluster Platform
125126
is installed in. Editing this config causes loft to restart which should be unnecessary for adding OIDC platform clients. Therefore, managing vCluster Platform OIDC clients has
126127
been moved to its own UI and the clients their own objects. These new OIDC clients can be managed either through the OIDC Provider tab of the admin page or through Kubernetes Secrets,
127128
see [Adding OIDC Clients to vCluster Platform OIDC Using Secrets](/platform/how-to/oidc-provider#adding-oidc-clients-to-vcluster-platform-oidc-using-secrets). The `oidc.clients` field
128-
is deprecated in vCluster Platform version 4.0 and will be removed in version 5.0.
129+
is deprecated in vCluster Platform version 4.0 and is removed in version 5.0.
129130

130-
#### Migrating OIDC Clients from Admin Config to New OIDC Clients
131+
#### Migrate OIDC clients from admin config to new OIDC clients
131132

132133
1. Navigate to `Admin > OIDC Provider`.
133134
2. Select `Add Client`.
@@ -137,14 +138,14 @@ is deprecated in vCluster Platform version 4.0 and will be removed in version 5.
137138
6. Select "Save".
138139
7. Repeat steps 1-6 for all clients.
139140
8. Copy the `oidc.clients` to a safe location. These can be discard once all steps have been succesful.
140-
9. Delete the `oidc.clients` field. This will cause vCluster Platform to restart.
141+
9. Delete the `oidc.clients` field. This causes vCluster Platform to restart.
141142
10. Validate OIDC clients function normally.
142143

143-
## Troubleshooting Tips
144+
## Troubleshooting tips
144145

145-
### Forgot the Project Prefix
146+
### Forgot the project prefix
146147

147-
If you accidentially performed the upgrade without setting the `projectNamespacePrefix`, then the pod of the platform will be in a `CrashLoopBackoff` with a log similiar to:
148+
If you accidentially performed the upgrade without setting the `projectNamespacePrefix`, then the pod of the platform is in a `CrashLoopBackoff` with a log similar to:
148149

149150
```bash
150151
cmd/main.go:107 error executing root command {"component": "loft", "error": "init (4): set default project namespace prefix: seems like you have upgraded the platform from an earlier version that uses 'loft-p-' as a project namespace prefix. This has been changed to be 'p-' in the current version. Please set 'projectNamespacePrefix: loft-p-' in the platform config to get rid of this error"}

platform_versioned_docs/version-4.2.0/administer/projects/quotas.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import Button from "@site/src/components/Button";
1010
import Label from "@site/src/components/Label";
1111
import Link from "@docusaurus/Link";
1212

13-
Quotas allow you to set resource usage and count limits for the project. This works similiarly to Kubernetes `ResourcesQuotas`, but applies across multiple clusters. Quotas can be
13+
Quotas allow you to set resource usage and count limits for the project. This works similarly to Kubernetes `ResourcesQuotas`, but applies across multiple clusters. Quotas can be
1414
defined across the whole project or on a per-user/per-team basis.
1515

1616
:::info Project quotas with multiple virtual clusters

0 commit comments

Comments
 (0)