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

[Documentation] Add upgrade procedure from community to enterprise #1596

Merged
merged 3 commits into from
Feb 22, 2024
Merged

[Documentation] Add upgrade procedure from community to enterprise #1596

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b3c5c11
add upgrade procedure from community to enterprise
kvahed Feb 21, 2024
7fa7a24
typo
kvahed Feb 21, 2024
dd69ada
Merge branch 'master' into documentation/upgrade-to-enterprise
ajanikow Feb 22, 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
26 changes: 24 additions & 2 deletions docs/upgrading.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ one version to the next.
It is highly recommended to take a backup of your data before upgrading ArangoDB
using [arangodump](https://docs.arangodb.com/stable/components/tools/arangodump/) or [ArangoBackup CR](backup-resource.md).

## Upgrade an ArangoDB deployment
## Upgrade an ArangoDB deployment version

To upgrade a cluster, change the version by changing
the `spec.image` setting and the apply the updated
the `spec.image` setting and then apply the updated
custom resource using:

```bash
Expand All @@ -29,3 +29,25 @@ is stopped, then the new version is started with `--database.auto-upgrade`
and once that is finish the new version is started with the normal arguments.

The process for major level upgrades depends on the specific version.

## Upgrade an ArangoDB deployment to Enterprise edition

In order to upgrade a cluster from community to enterprise, we have to
go through to the following adjustements to an existing deployment:

* [Add a license key](https://arangodb.github.io/kube-arangodb/docs/how-to/set_license.html)
to the cluster
* Adjust `spec.image` to a valid enterprise image string
* Add `spec.license.secretName` to the introduced license key

```bash
kubectl apply -f yourCustomResourceFile.yaml
```

The actual upgrade procedure follows exactly the same steps as
described above for a simple version upgrade in a sequential manner.

Regardless of if you are not only changing the images of community and
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should mention that the operator image should be changed as well (community -> enterprise). So operator deployment needs to be updated too.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Not needed, Operator CE will handle ArangoDB EE

enterprise of the same major, minor and patch levels, or upgrade both
to enterprise and a different version, the procedure is only performed
once in a combined step of upgrading version and edition.