Skip to content

Commit

Permalink
[Documentation] Add upgrade procedure from community to enterprise (#…
Browse files Browse the repository at this point in the history
…1596)

Co-authored-by: Adam Janikowski <12255597+ajanikow@users.noreply.github.com>
  • Loading branch information
kvahed and ajanikow authored Feb 22, 2024
1 parent 2ae4d8a commit 14a25e7
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions docs/upgrading.md
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
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.

0 comments on commit 14a25e7

Please sign in to comment.