Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to upgrade from v3 to v4 regarding project prefix #176

Merged
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
48 changes: 48 additions & 0 deletions platform/_partials/install/upgrade-v3-v4.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

Upgrade vCluster Platform from v3 to v4 via:

<Tabs
defaultValue="cli"
values={[
{ label: 'CLI', value: 'cli', },
{ label: 'helm', value: 'helm', },
]
}>
<TabItem value="cli">

To upgrade vCluster Platform from v3 to v4 via vCluster CLI, run:


```bash
# First set the project namespace prefix to use the v3 format
cat > /tmp/vcluster-platform.yaml <<EOF
config:
projectNamespacePrefix: loft-p-
EOF

vcluster platform start --upgrade --version=$VERSION --values=/tmp/vcluster-platform.yaml
```

</TabItem>
<TabItem value="helm">

To upgrade vCluster Platform from v3 to v4 via `helm`, run:

```bash
# First set the project namespace prefix to use the v3 format
cat > /tmp/vcluster-platform.yaml <<EOF
config:
projectNamespacePrefix: loft-p-
EOF

helm upgrade loft vcluster-platform -n vcluster-platform --repository-config '' --repo https://charts.loft.sh \
--version $VERSION \
--reuse-values \
-f /tmp/vcluster-platform.yaml
```

</TabItem>
</Tabs>

2 changes: 1 addition & 1 deletion platform/_partials/install/upgrade.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ vcluster platform start --upgrade --version=$VERSION --values=vcluster-platform.
To upgrade vCluster Platform via `helm`, run:

```bash
helm upgrade loft vcluster-control-plane -n vcluster-platform --repository-config '' --repo https://charts.loft.sh \
helm upgrade loft vcluster-platform -n vcluster-platform --repository-config '' --repo https://charts.loft.sh \
--version $VERSION \
--reuse-values \
-f vcluster-platform.yaml
Expand Down
14 changes: 13 additions & 1 deletion platform/manage/upgrade-platform.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Upgrade vCluster Platform
sidebar_label: Upgrade
sidebar_label: Upgrade
sidebar_position: 2
---

import PartialAdminUpgrade from "../_partials/install/upgrade.mdx";
import PartialAdminUpgradeV3V4 from "../_partials/install/upgrade-v3-v4.mdx";

Upgrading vCluster Platform is easy! vCluster Platform can be upgraded either via the vCluster CLI, or with Helm.

Expand All @@ -15,3 +16,14 @@ The `$VERSION` variable above is an environment variable set to your desired vCl
deploy. The `vcluster-platform.yaml` file is an optional YAML file that contains Helm values you would like
to use when upgrading your vCluster Platform deployment.
:::

## Upgrading from v3.x to v4.0

:::info Upgrade to latest v3 first
Before attempting to perform this major upgrade please ensure that you have upgraded to the latest v3 release first. E.g. by running the steps above.
:::

With v4.0 the project namespace prefix can now be configured and the default has been changed from `loft-p` (which is used by v3) to `p-`.
In order for the upgrade from v3 to v4 to succeed you must set this explicitly regardless of updating via the vCluster CLI or via Helm.

<PartialAdminUpgradeV3V4 />
Loading