Skip to content

add section about upgrading vCluster Standalone #1195

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

add section about upgrading vCluster Standalone #1195

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 32 additions & 1 deletion vcluster/deploy/control-plane/binary/manage.mdx
View file
Open in desktop
Copy link
Contributor

@github-actions github-actions bot Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Google.Headings] 'Update vCluster Standalone configuration' should use sentence-style capitalization.

Copy link
Contributor

@github-actions github-actions bot Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Loft.exclude-please] Avoid using 'please' in technical documentation.

Copy link
Contributor

@github-actions github-actions bot Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Loft.imperative-headings] Headings should start with an imperative verb. 'Reusing' appears to be a present participle (ends with 'ing').

Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,37 @@ import TenancySupport from '../../../_fragments/tenancy-support.mdx';

<DeployChangesStandalone />

## Upgrading vCluster Standalone version
Copy link
Contributor

@github-actions github-actions bot Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Google.Headings] 'Upgrading vCluster Standalone version' should use sentence-style capitalization.

Copy link
Contributor

@github-actions github-actions bot Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Loft.imperative-headings] Headings should start with an imperative verb. 'Upgrading' appears to be a present participle (ends with 'ing').


To upgrade a vCluster Standalone to the new version, download the binary from the releases page, and then restart the vCluster systemD service.
Copy link
Contributor

@deniseschannon deniseschannon Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When upgrading vCluster versions, how does this affect/change k8s versions?


<Flow>
<Step>
On the control-plane node, download the binary for the target version:
```shell title="Download vCluster standalone binary"
export VCLUSTER_VERSION="vX.Y.Z" # modify to the target version
export TARGETARCH="amd64" # amd64 / arm64
curl -fsSLk -o /tmp/vcluster-new "https://github.com/loft-sh/vcluster/releases/download/${VCLUSTER_VERSION}/vcluster-linux-${TARGETARCH}-standalone"
Copy link
Contributor

@github-actions github-actions bot Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'vCluster' instead of 'vcluster'.

Copy link
Contributor

@github-actions github-actions bot Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'vCluster' instead of 'vcluster'.

Copy link
Contributor

@github-actions github-actions bot Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'vCluster' instead of 'vcluster'.

```
then, copy it to the `/var/lib/vcluster/bin/vcluster`:
Copy link
Contributor

@github-actions github-actions bot Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'vCluster' instead of 'vcluster'.

Copy link
Contributor

@github-actions github-actions bot Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'vCluster' instead of 'vcluster'.


```shell title="Upgrade binary"
chmod +x /tmp/vcluster-new
# copy old version as a backup
cp /var/lib/vcluster/bin/vcluster /tmp/vcluster-old.bak
cp /tmp/vcluster-new /var/lib/vcluster/bin/vcluster
```
</Step>
<Step>
Restart vCluster systemD service to deploy your changes.

```bash title="Restart vCluster"
systemctl restart vcluster.service
```

</Step>
</Flow>

## Removing nodes
Copy link
Contributor

@github-actions github-actions bot Sep 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Loft.imperative-headings] Headings should start with an imperative verb. 'Removing' appears to be a present participle (ends with 'ing').


If you have not enabled joining the control plane nodes as worker nodes, then removing vCluster
Expand Down Expand Up @@ -230,4 +261,4 @@ Run 'kubectl get nodes' on the control-plane to see this node join the cluster.
</Step>
</Flow>
</TabItem>
</Tabs>
</Tabs>
Loading