release: updates for 0.8.0

SwissDataScienceCenter · May 25, 2021 · 871ab17 · 871ab17
1 parent a9de86d
commit 871ab17
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 9 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,5 +1,51 @@
 .. _changelog:
 
+0.8.0
+------
+
+This release includes a new version for PostgreSQL and GitLab as well as various improvements and bug fixes to Renku CLI and Environments.
+If your PostgreSQL and/or GitLab were deployed as part of Renku, please make sure to backup your volumes before following the upgrade instructions.
+
+Improvements
+~~~~~~~~~~~~~
+
+* **PostgreSQL and GitLab upgrade**: We bump the PostgreSQL version from 9.6 to 11 and the GitLab major version from 11 to 13.
+* **Project templates**: Community contributed template ``AiiDA`` has been updated. See `a06ab24 <https://github.com/SwissDataScienceCenter/contributed-project-templates/commit/a06ab248e92203343e48854ddc118c4488dd3379>`__.
+* **Project templates**: Project templates come with Renku CLI ``v0.15.2`` by default.
+* **Renku CLI**: add support to dataset update for detecting changes to local files.
+* **Renku CLI**: add support to export `OLOS <https://olos.swiss/>`__ datasets.
+* **Renku CLI**: add JSON output format to ``renku dataset ls`` and ``renku dataset ls-files``.
+* **Renku CLI**: detect filename from `content-disposition header <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition>`__ when adding a dataset.
+
+Bug Fixes
+~~~~~~~~~~
+
+* **Environments**: remove storage options when launching environments if PVC feature is not enabled.
+* **Project templates**: fix project creation to use pinned Renku CLI version.
+
+Individual components
+~~~~~~~~~~~~~~~~~~~~~
+
+For changes to individual components, please check:
+
+* renku-notebooks:
+ `0.8.12 <https://github.com/SwissDataScienceCenter/renku-notebooks/releases/tag/0.8.12>`__
+
+* renku-python:
+ `v0.15.1 <https://github.com/SwissDataScienceCenter/renku-graph/releases/tag/v0.15.1>`__,
+ `v0.15.0 <https://github.com/SwissDataScienceCenter/renku-graph/releases/tag/v0.15.0>`__
+
+Upgrading from 0.7.13
+~~~~~~~~~~~~~~~~~~~~~
+
+**BREAKING CHANGES**
+
+Please follow [these instructions](https://github.com/SwissDataScienceCenter/renku/tree/master/helm-chart#upgrading-to-080) carefully.
+
+The resulting changes in the values file should be:
+* NEW/EDIT *postgresql.persistence.existingClaim* will most likely need to be modified in the course of upgrading your PostgreSQL version. See [these instructions](https://github.com/SwissDataScienceCenter/renku/tree/master/helm-chart/utils/postgres_migrations/version_upgrades/README.md)
+* NEW/EDIT/DELETE *gitlab.image.tag* might have to be adjusted as we do a GitLab major version bump in with this release.
+
 0.7.13
 ------
 
@@ -93,7 +139,7 @@ Features
 Improvements
 ~~~~~~~~~~~~~
 
-* **Projects**: improve UX when forking a project, and handle up to 1000 namespaces 
+* **Projects**: improve UX when forking a project, and handle up to 1000 namespaces
 * **Projects**: allow setting project avatar
 * **Environments**: simplify getting the registry image URL for running sessions
 
@@ -126,7 +172,7 @@ For changes to individual components, please check:
 
 Bug Fixes
 ~~~~~~~~~~
- 
+
 * **Core**: add error handling if push from temporary branch fails
 * **Core**: fix handling of '@' in filenames
 * **Core**: fix save and push to correctly handle merge conflicts
@@ -201,7 +247,7 @@ Upgrading from 0.7.7
 ~~~~~~~~~~~~~~~~~~~~~
 
 
-**Breaking change** Keycloak chart dependency has been upgraded from ``4.10.2`` to ``9.8.1`` which will trigger an irreversible database migration, check out `the upgrade instructions <https://github.com/SwissDataScienceCenter/renku/blob/master/helm-chart/README.rst#upgrading>`__ for more details. 
+**Breaking change** Keycloak chart dependency has been upgraded from ``4.10.2`` to ``9.8.1`` which will trigger an irreversible database migration, check out `the upgrade instructions <https://github.com/SwissDataScienceCenter/renku/blob/master/helm-chart/README.rst#upgrading>`__ for more details.
 
 Most notably, keycloak values are less nested, so at the level of the Renku chart values, keycloak.keycloak.X.Y becomes keycloak.X.Y. You can also check out `the instructions <https://github.com/codecentric/helm-charts/tree/master/charts/keycloak#upgrading>`__ on how to upgrade aspects not covered by default in the Renku chart.
 

diff --git a/helm-chart/README.rst b/helm-chart/README.rst
@@ -67,7 +67,7 @@ executed, we add some instructions here.
 Upgrading to 0.8.0
 ******************
 We bump the PostgreSQL version from 9.6 to 11 and the GitLab major version from 11 to 13.
-It is important to first perform the postgresql upgrade, then upgrade to the ``0.8.0`` chart version
+It is important to first perform the PostgreSQL upgrade, then upgrade to the ``0.8.0`` chart version
 while keeping the GitLab version fixed, and finally upgrade the GitLab version.
 
 1. Upgrading postgresql
@@ -86,7 +86,7 @@ new chart version through ``helm upgrade ... --version 0.8.0 ...``.
 3. Upgrade GitLab
 +++++++++++++++++
 Please read the `GitLab documentation on this topic <https://docs.gitlab.com/ce/update>`_ before proceeding.
-Following the `recommended upgrade paths<https://docs.gitlab.com/ce/update/#upgrade-paths>`_) and assuming
+Following the `recommended upgrade paths <https://docs.gitlab.com/ce/update/#upgrade-paths>`_) and assuming
 your GitLab instance is at version ``11.9.11``, this means that your upgrade path will be
 ``11.11.8 -> 12.0.12 -> 12.1.17 -> 12.10.14 -> 13.0.14 -> 13.1.11 -> 13.10.4``. The corresponding
 image tags are:

diff --git a/helm-chart/renku/Chart.yaml b/helm-chart/renku/Chart.yaml
@@ -3,4 +3,4 @@ appVersion: '1.0'
 description: A Helm chart for the Renku platform
 name: renku
 icon: https://github.com/SwissDataScienceCenter/renku-sphinx-theme/raw/master/renku_sphinx_theme/static/favicon.png
-version: 0.7.13
+version: 0.8.0
diff --git a/helm-chart/renku/values.yaml b/helm-chart/renku/values.yaml
@@ -404,7 +404,7 @@ ui:
  custom: true
  repositories:
  - url: https://github.com/SwissDataScienceCenter/renku-project-template
- ref: 0.1.19
+ ref: 0.1.20
  name: Renku
  - url: https://github.com/SwissDataScienceCenter/contributed-project-templates
  ref: 0.2.0

diff --git a/helm-chart/utils/postgres_migrations/version_upgrades/README.md b/helm-chart/utils/postgres_migrations/version_upgrades/README.md
@@ -31,7 +31,7 @@ kubectl -n renku exec renku-postgresql-0 -- bash -c 'PGUSER=$POSTGRES_USER PGPAS
 
 ## Load the data
 
-- Execute `kubectl apply -f psql_load.yaml` and wait for the `postgresql-load-job` to complete. This might take a while - for example 20 minutes when testing with a PostgreSQL instance holding 1.5 GB of data.
+- Execute `kubectl apply -n <your-namespace> -f psql_load.yaml` and wait for the `postgresql-load-job` to complete. This might take a while - for example 20 minutes when testing with a PostgreSQL instance holding 1.5 GB of data.
 - Remove the temporary resources using `kubectl delete -n <your-namespace> -f psql_load.yaml`.
 
 ## Restart PostgreSQL

diff --git a/helm-chart/values.yaml.changelog.md b/helm-chart/values.yaml.changelog.md
@@ -6,7 +6,7 @@ Please follow this convention when adding a new row
 * `<type: NEW|EDIT|DELETE> - *<resource name>*: <details>`
 
 ----
-## Unreleased (breaking changes)
+## Upgrading to Renku 0.8.0 (breaking changes)
 * NEW/EDIT *postgresql.persistence.existingClaim* will most likely need to be modified in the course of upgrading your postgresql version. See [these instructions](https://github.com/SwissDataScienceCenter/renku/tree/master/helm-chart/utils/postgres_migrations/version_upgrades/README.md)
 * NEW/EDIT/DELETE *gitlab.image.tag* might have to be adjusted as we do a GitLab major version bump in with this release. See [these instructions](https://github.com/SwissDataScienceCenter/renku/tree/master/helm-chart#upgrading-to-080)