Skip to content

Commit

Permalink
Update upgrade notes in CONTRIBUTING.md, README.md, values.yaml
Browse files Browse the repository at this point in the history
Signed-off-by: Jesse Hitch <[email protected]>
Signed-off-by: jessebot <[email protected]>
  • Loading branch information
jessebot committed Jul 26, 2024
1 parent bf6cc4a commit b1aef0d
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 3 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ Then, please make sure you follow the [pull request template](.github/pull_reque

![screenshot of the allow edits by maintainers check box to the left of the Create pull request button on GitHub](https://github.com/nextcloud/helm/assets/2389292/3a8044a9-583d-496a-b3d2-4dd699c56ed4)

## Upgrades

If upgrading a subchart, such as PostgreSQL or MariaDB, or upgrading the `appVersion` in `./charts/nextcloud/Chart.yaml`, please never upgrade more than one major version at a time and please bump the helm chart `version` in `./charts/nextcloud/Chart.yaml` in line with semver. For example, if you bump the `appVersion` from `29.0.4` to `29.1.0`, you need to also bump the `version` from `5.3.0` to `5.4.0`.

Additionally, when upgrading Nextcloud versions, upgrade to the latest minor version of the major version first, before upgrading to the next major version. Learn more about upgrading Nexcloud via the [upgrade docs](https://docs.nextcloud.com/server/latest/admin_manual/maintenance/upgrade.html#approaching-upgrades).

If upgrading a subchart, please also provide documentation in the PR for how users can upgrade an external service locally.

# Issues

Expand Down
2 changes: 1 addition & 1 deletion charts/nextcloud/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: nextcloud
version: 5.3.2
version: 5.3.3
appVersion: 29.0.4
description: A file sharing server that puts the control and security of your own data back into your hands.
keywords:
Expand Down
2 changes: 1 addition & 1 deletion charts/nextcloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ kubectl exec $NEXTCLOUD_POD -- su -s /bin/sh www-data -c "php occ recognize:down
Check out the [official Nextcloud backup docs](https://docs.nextcloud.com/server/latest/admin_manual/maintenance/backup.html). For your files, if you're using persistent volumes, and you'd like to back up to s3 backed storage (such as minio), consider using [k8up](https://github.com/k8up-io/k8up) or [velero](https://github.com/vmware-tanzu/velero).
# Upgrades
Since this chart utilizes the [nextcloud/docker](https://github.com/nextcloud/docker) image, provided you are using persistent volumes, [upgrades of your Nextcloud server are handled automatically](https://github.com/nextcloud/docker#update-to-a-newer-version) from one version to the next, however, you can only upgrade one major version at a time. For example, if you want to upgrade from version `25` to `27`, you will have to upgrade from version `25` to `26`, then from `26` to `27`. Since our docker tag is set via the [`appVersion` in `Chart.yaml`](https://github.com/nextcloud/helm/blob/main/charts/nextcloud/Chart.yaml#L4), you'll need to make sure you gradually upgrade the helm chart if you have missed serveral app versions.
Since this chart utilizes the [nextcloud/docker](https://github.com/nextcloud/docker) image, provided you are using persistent volumes, [upgrades of your Nextcloud server are handled automatically](https://github.com/nextcloud/docker#update-to-a-newer-version) from one version to the next, however, you can only upgrade one major version at a time. For example, if you want to upgrade from version `25` to `27`, you will have to upgrade from version `25` to `26`, then from `26` to `27`. Since our docker tag is set via the [`appVersion` in `Chart.yaml`](https://github.com/nextcloud/helm/blob/main/charts/nextcloud/Chart.yaml#L4), you'll need to make sure you gradually upgrade the helm chart if you have missed serveral app versions. It's also good to first upgrade to the latest minor version of a major version before upgrading to the next major version. Learn more about upgrades in the [upgrade docs](https://docs.nextcloud.com/server/latest/admin_manual/maintenance/upgrade.html#approaching-upgrades).
⚠️ *Before Upgrading Nextcloud or the attached database, always make sure you take [backups](#backups)!*
Expand Down
6 changes: 5 additions & 1 deletion charts/nextcloud/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@ image:
repository: nextcloud
flavor: apache
# default is generated by flavor and appVersion
tag:
# NOTE: Remember if manually setting this values, when upgrading Nextcloud
# versions, upgrade to the latest minor version of for your current major version
# before upgrading to the next major version and NEVER upgrade more than *one*
# major version at a time.
tag: ""
pullPolicy: IfNotPresent
# pullSecrets:
# - myRegistrKeySecretName
Expand Down

0 comments on commit b1aef0d

Please sign in to comment.