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.

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

Jump to bottom

Docs: Improving the 'Upgrading KubeEdge' docs #565

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Docs: Improving the 'Upgrading KubeEdge' docs #565

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cad271
docs: improving the upgrade kubeedge docs
1Shubham7 Jun 2, 2024
af97cad
added changes suggested by Shelley Bao
1Shubham7 Jun 17, 2024
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
30 changes: 16 additions & 14 deletions docs/setup/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,44 @@
title: Upgrading KubeEdge
sidebar_position: 8
---
Please refer to following guide to upgrade your KubeEdge cluster.

This guide provides instructions on how to upgrade your KubeEdge cluster.

## Backup

### Database

Backup edgecore database at each edge node:
Backup the EdgeCore database at each edge node:

```
$ mkdir -p /tmp/kubeedge_backup
$ cp /var/lib/kubeedge/edgecore.db /tmp/kubeedge_backup/
```

### Config(Optional)

You can keep old config to save some custom changes as you wish.
### Config (Optional)

*Note*:
You can keep the old config to preserve any custom changes you have made.

After upgrading, some options may be deleted and some may be added, please don't use old config directly.
:::note
After upgrading, some options may be removed, and new options may be added. It is not recommended to use the old config directly.
:::

### Device related(Optional)
### Device related (Optional)

If you upgrade from 1.3 to 1.4, please note that we upgrade device API from v1alpha1 to v1alpha2.
If you are upgrading from KubeEdge v1.14 to v1.15, please note that device API should be upgraded from v1alpha2 to v1beta1.

You need to install [Device v1alpha2](https://github.com/kubeedge/kubeedge/blob/release-1.4/build/crds/devices/devices_v1alpha2_device.yaml)
You will have to install [Device v1beta1](https://github.com/kubeedge/kubeedge/blob/release-1.15/build/crds/devices/devices_v1beta1_device.yaml)
and [DeviceModel v1alpha2](https://github.com/kubeedge/kubeedge/blob/release-1.4/build/crds/devices/devices_v1alpha2_devicemodel.yaml),
and manually convert their existing custom resources from v1alpha1 to v1alpha2.
and manually convert your existing custom resources from v1alpha2 to v1beta1.

It's recommended to keep v1alpha1 CRD and custom resources in the cluster or exported somewhere, in case any rollback is needed.
It is recommended to keep the v1alpha2 CRD and custom resources in the cluster or export them somewhere, in case a rollback is needed.

## Stop Processes

Stop edgecore processes one by one, after ensuring all edgecore processes are stopped, stop cloudcore.

The way to stop depends on how you deploy:
The way for stopping the processes depends on how you deploy:

- for binary or "keadm": use `kill`
- for "systemd": use `systemctl`

Expand All @@ -58,4 +60,4 @@ $ mv /tmp/kubeedge_backup/edgecore.db /var/lib/kubeedge/

## Deploy

Read the [setup](./install-with-keadm) for deployment.
Refer to the [setup guide](./install-with-keadm) for deployment instructions.