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
Copy file name to clipboardExpand all lines: configsrc/vcluster/main/vcluster.schema.json
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -209,7 +209,7 @@
209
209
},
210
210
"coredns": {
211
211
"$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."
213
213
},
214
214
"proxy": {
215
215
"$ref": "#/$defs/ControlPlaneProxy",
@@ -703,7 +703,7 @@
703
703
},
704
704
"embedded": {
705
705
"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."
Copy file name to clipboardExpand all lines: platform/administer/projects/quotas.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
@@ -10,7 +10,7 @@ import Button from "@site/src/components/Button";
10
10
importLabelfrom"@site/src/components/Label";
11
11
importLinkfrom"@docusaurus/Link";
12
12
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
14
14
defined across the whole project or on a per-user/per-team basis.
15
15
16
16
:::info Project quotas with multiple virtual clusters
@@ -26,6 +27,6 @@ Any previous versions which are not on this list are no longer in any support wi
26
27
| v4.0 | October 15, 2024 | January 15, 2025 | April 15, 2025 |
27
28
| v3.4| February 29, 2024 | April 1, 2025*| July 1, 2025 |
28
29
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.
This guide explains how to migrate the platform to a different Kubernetes cluster, which might be necessary during cluster decommissioning or cloud platform migration.
Copy file name to clipboardExpand all lines: platform/reference/migrations/4-0-migration.mdx
+28-27Lines changed: 28 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,21 @@
1
1
---
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+
3
4
description: How to upgrade from pre-v4.0 to v4.0 release
4
5
sidebar_position: 1
5
6
---
6
7
7
8
importTabsfrom"@theme/Tabs";
8
9
importTabItemfrom"@theme/TabItem";
9
10
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.
11
12
12
-
## Upgrade to the latest Loft v3.x version
13
+
## Upgrade to the latest Loft version
13
14
14
15
Before attempting to perform this major upgrade, upgrade to the latest v3.x version.
15
16
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.
16
17
17
-
## Pre-Upgrade Recommendations
18
+
## Pre-upgrade recommendations
18
19
19
20
### Read through the v4.0 Release Notes
20
21
@@ -26,15 +27,15 @@ One of the breaking changes in v4.0 is the requirement of a vCluster version def
26
27
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),
27
28
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.
28
29
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.
32
33
33
-
#### How to define the vCluster version on Existing Virtual Clusters
34
+
#### Define the vCluster version on Existing Virtual Clusters
34
35
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.
36
37
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.
38
39
39
40
`spec` Example:
40
41
@@ -46,23 +47,23 @@ spec:
46
47
version: 0.19.7
47
48
```
48
49
49
-
## Download the latest vCluster CLI (v0.20.0+)
50
+
## Download the latest vCluster CLI
50
51
51
52
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).
52
53
53
-
## Required Changes in your Platform Configuration before Upgrading
54
+
## Required changes in your platform configuration before upgrading
54
55
55
56
A new feature has been added to support the ability to change the prefix of the namespace created for projects. In previous versions, the
56
57
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
57
58
part of the upgrade command. Since future upgrades reuse the values of the configuration, you only need to apply it once.
58
59
59
-
### Appending the project prefix to upgrade commands
60
+
### Append the project prefix to upgrade commands
60
61
61
62
<Tabs
62
63
defaultValue="cli"
63
64
values={[
64
65
{ label: 'CLI', value: 'cli', },
65
-
{ label: 'helm', value: 'helm', },
66
+
{ label: 'Helm', value: 'helm', },
66
67
]
67
68
}>
68
69
<TabItemvalue="cli">
@@ -74,8 +75,8 @@ The following steps assume the existing installation is in the default namespace
74
75
:::
75
76
76
77
```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
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
124
125
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
125
126
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
126
127
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,
127
128
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.
129
130
130
-
#### Migrating OIDC Clients from Admin Config to New OIDC Clients
131
+
#### Migrate OIDC clients from admin config to new OIDC clients
131
132
132
133
1. Navigate to `Admin > OIDC Provider`.
133
134
2. Select `Add Client`.
@@ -137,14 +138,14 @@ is deprecated in vCluster Platform version 4.0 and will be removed in version 5.
137
138
6. Select "Save".
138
139
7. Repeat steps 1-6 for all clients.
139
140
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.
141
142
10. Validate OIDC clients function normally.
142
143
143
-
## Troubleshooting Tips
144
+
## Troubleshooting tips
144
145
145
-
### Forgot the Project Prefix
146
+
### Forgot the project prefix
146
147
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:
148
149
149
150
```bash
150
151
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"}
Copy file name to clipboardExpand all lines: platform_versioned_docs/version-4.2.0/administer/projects/quotas.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
@@ -10,7 +10,7 @@ import Button from "@site/src/components/Button";
10
10
importLabelfrom"@site/src/components/Label";
11
11
importLinkfrom"@docusaurus/Link";
12
12
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
14
14
defined across the whole project or on a per-user/per-team basis.
15
15
16
16
:::info Project quotas with multiple virtual clusters
0 commit comments