From 40e2ff379049f1c001fbc88e36fbd0c8b1fafcf0 Mon Sep 17 00:00:00 2001 From: Thibault Camalon <135698225+thbcmlowk@users.noreply.github.com> Date: Fri, 6 Oct 2023 10:17:13 +0200 Subject: [PATCH 1/3] chore: release 0.33.0 Signed-off-by: Thibault Camalon <135698225+thbcmlowk@users.noreply.github.com> --- CHANGELOG.md | 2 ++ docs/source/additional/release.rst | 15 +++++++++++ docs/source/additional/releases.yaml | 38 ++++++++++++++++++++++++++++ 3 files changed, 55 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index cd4057a0a..19a0554b9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [0.33.0] + ### Changed - Update `k3s_create.sh` file, needed for a local deployment ([#365](https://github.com/Substra/substra-documentation/pull/365)) diff --git a/docs/source/additional/release.rst b/docs/source/additional/release.rst index 272b63849..e7de8f4c3 100644 --- a/docs/source/additional/release.rst +++ b/docs/source/additional/release.rst @@ -31,6 +31,21 @@ This is an overview of the main changes, please have a look at the changelog of - `backend changelog `__ - `orchestrator changelog `__ +Substra 0.33.0 --- 2023-10-06 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Substra:** + +- **BREAKING**: Substra tools now only provides a unique base docker image for each supported Python version. The ``minimal`` and the ``workflow`` versions have been removed. + +**Orchestrator and Backend:** + +- A new Skaffold profile ``three-orgs`` have been added in the Orchestrator and the Substra-backend. It allows local deployment of a third organization and must be activated on the two repositories. To use it: + + .. code-block:: bash + + skaffold run -p three-orgs + Substra 0.32.0 --- 2023-09-08 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/source/additional/releases.yaml b/docs/source/additional/releases.yaml index 62d64a504..7ea06d290 100644 --- a/docs/source/additional/releases.yaml +++ b/docs/source/additional/releases.yaml @@ -9,6 +9,44 @@ components: # for table headers - substra-tests releases: + - version: 0.33.0 + components: + substrafl: + version: 0.41.1 + link: https://github.com/Substra/substrafl/releases/tag/0.41.1 + substra: + version: 0.48.1 + link: https://github.com/Substra/substra/releases/tag/0.48.1 + substra-tools: + version: 0.21.0 + link: https://github.com/Substra/substra-tools/releases/tag/0.21.0 + substra-backend: + version: 0.42.1 + link: https://github.com/Substra/substra-backend/releases/tag/0.42.1 + helm: + version: 22.8.3 + link: https://artifacthub.io/packages/helm/substra/substra-backend/22.8.3 + orchestrator: + version: 0.36.1 + link: https://github.com/Substra/orchestrator/releases/tag/0.36.1 + helm: + version: 7.5.5 + link: https://artifacthub.io/packages/helm/substra/orchestrator/7.5.5 + substra-frontend: + version: 0.45.1 + link: https://github.com/Substra/substra-frontend/releases/tag/0.45.1 + helm: + version: 1.0.24 + link: https://artifacthub.io/packages/helm/substra/substra-frontend/1.0.24 + hlf-k8s: + version: 0.2.4 + link: https://github.com/Substra/hlf-k8s/releases/tag/0.2.4 + helm: + version: 10.2.4 + link: https://artifacthub.io/packages/helm/substra/hlf-k8s/10.2.4 + substra-tests: + version: 0.46.0 + link: https://github.com/Substra/substra-tests/releases/tag/0.46.0 - version: 0.32.0 components: substrafl: From f0d4d7840b87b9e741cb36e7e4a64cd67b1e778f Mon Sep 17 00:00:00 2001 From: Thibault Camalon <135698225+thbcmlowk@users.noreply.github.com> Date: Fri, 6 Oct 2023 18:07:54 +0200 Subject: [PATCH 2/3] chore(docs/source/how-to/developing-substra/local-deployment): add details on 'three-orgs' profile Signed-off-by: Thibault Camalon <135698225+thbcmlowk@users.noreply.github.com> --- CHANGELOG.md | 1 + docs/source/additional/release.rst | 8 ++------ .../how-to/developing-substra/local-deployment.rst | 9 ++++++++- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 19a0554b9..d1b0cd969 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +- Update local deployment with the ``three-orgs`` profile - Update `k3s_create.sh` file, needed for a local deployment ([#365](https://github.com/Substra/substra-documentation/pull/365)) - Add files to run documentation examples in nightly CI ([#357](https://github.com/Substra/substra-documentation/pull/357)) - Update example to be runnable in remote mode ([#357](https://github.com/Substra/substra-documentation/pull/357)) diff --git a/docs/source/additional/release.rst b/docs/source/additional/release.rst index e7de8f4c3..fe706b3b1 100644 --- a/docs/source/additional/release.rst +++ b/docs/source/additional/release.rst @@ -38,13 +38,9 @@ Substra 0.33.0 --- 2023-10-06 - **BREAKING**: Substra tools now only provides a unique base docker image for each supported Python version. The ``minimal`` and the ``workflow`` versions have been removed. -**Orchestrator and Backend:** +**Documentation:** -- A new Skaffold profile ``three-orgs`` have been added in the Orchestrator and the Substra-backend. It allows local deployment of a third organization and must be activated on the two repositories. To use it: - - .. code-block:: bash - - skaffold run -p three-orgs +- A new development profile is available to deploy a third organization. See `Local deployment `__ for more details. Substra 0.32.0 --- 2023-09-08 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/source/how-to/developing-substra/local-deployment.rst b/docs/source/how-to/developing-substra/local-deployment.rst index c550e14a6..ff6c715b9 100644 --- a/docs/source/how-to/developing-substra/local-deployment.rst +++ b/docs/source/how-to/developing-substra/local-deployment.rst @@ -6,7 +6,7 @@ Local deployment This page gives the directions to locally run the Substra stack. This deployment is made of: * 1 orchestrator (running in standalone mode, i.e. storing data in its own local database) -* 2 backends (running in two organisations, ``org-1`` and ``org-2``) +* 2 or 3 backends (running in two or three organisations, ``org-1`` - ``org-2`` - ``org-3``) * 1 frontend It allows you to run the examples and start using Substra SDK (also known as substra). @@ -163,6 +163,13 @@ Launching skaffold run -p dev,arm64 +.. tip:: + If you need a third organization, you must use the ``three-orgs`` profile on both the orchestrator and the backend: + + .. code-block:: bash + + skaffold run -p three-orgs + .. tip:: If you need to re-run `skaffold run` for whatever reason, don't forget to use `skaffold delete` to reset the state beforehand (or reset your environment by running the `k3-create.sh` script again). From 2e4eabdf9e8a602f061fdee6dffc8ba1657c26a2 Mon Sep 17 00:00:00 2001 From: Thibault Camalon <135698225+thbcmlowk@users.noreply.github.com> Date: Fri, 6 Oct 2023 18:26:19 +0200 Subject: [PATCH 3/3] chore: update substra tools base docker image version Signed-off-by: Thibault Camalon <135698225+thbcmlowk@users.noreply.github.com> --- .../diabetes_example/assets/functions/aggregation/Dockerfile | 2 +- .../assets/functions/local_first_order_computation/Dockerfile | 2 +- .../assets/functions/local_second_order_computation/Dockerfile | 2 +- .../assets/function_random_forest/predict/Dockerfile | 2 +- .../assets/function_random_forest/train/Dockerfile | 2 +- .../substra_core/titanic_example/assets/metric/Dockerfile | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/examples/substra_core/diabetes_example/assets/functions/aggregation/Dockerfile b/docs/source/examples/substra_core/diabetes_example/assets/functions/aggregation/Dockerfile index 3beefc19e..0b217cddb 100644 --- a/docs/source/examples/substra_core/diabetes_example/assets/functions/aggregation/Dockerfile +++ b/docs/source/examples/substra_core/diabetes_example/assets/functions/aggregation/Dockerfile @@ -1,5 +1,5 @@ # this base image works in both CPU and GPU enabled environments -FROM ghcr.io/substra/substra-tools:0.20.0-nvidiacuda11.8.0-base-ubuntu22.04-python3.9 +FROM ghcr.io/substra/substra-tools:0.21.0-nvidiacuda11.8.0-base-ubuntu22.04-python3.9 # install dependencies RUN pip3 install pandas numpy diff --git a/docs/source/examples/substra_core/diabetes_example/assets/functions/local_first_order_computation/Dockerfile b/docs/source/examples/substra_core/diabetes_example/assets/functions/local_first_order_computation/Dockerfile index 614999b1c..3b9775a64 100644 --- a/docs/source/examples/substra_core/diabetes_example/assets/functions/local_first_order_computation/Dockerfile +++ b/docs/source/examples/substra_core/diabetes_example/assets/functions/local_first_order_computation/Dockerfile @@ -1,5 +1,5 @@ # this base image works in both CPU and GPU enabled environments -FROM ghcr.io/substra/substra-tools:0.20.0-nvidiacuda11.8.0-base-ubuntu22.04-python3.9 +FROM ghcr.io/substra/substra-tools:0.21.0-nvidiacuda11.8.0-base-ubuntu22.04-python3.9 # install dependencies RUN pip3 install pandas numpy diff --git a/docs/source/examples/substra_core/diabetes_example/assets/functions/local_second_order_computation/Dockerfile b/docs/source/examples/substra_core/diabetes_example/assets/functions/local_second_order_computation/Dockerfile index 4686d4355..979037710 100644 --- a/docs/source/examples/substra_core/diabetes_example/assets/functions/local_second_order_computation/Dockerfile +++ b/docs/source/examples/substra_core/diabetes_example/assets/functions/local_second_order_computation/Dockerfile @@ -1,5 +1,5 @@ # this base image works in both CPU and GPU enabled environments -FROM ghcr.io/substra/substra-tools:0.20.0-nvidiacuda11.8.0-base-ubuntu22.04-python3.9 +FROM ghcr.io/substra/substra-tools:0.21.0-nvidiacuda11.8.0-base-ubuntu22.04-python3.9 # install dependencies RUN pip3 install pandas numpy diff --git a/docs/source/examples/substra_core/titanic_example/assets/function_random_forest/predict/Dockerfile b/docs/source/examples/substra_core/titanic_example/assets/function_random_forest/predict/Dockerfile index 653c0797a..157c97261 100644 --- a/docs/source/examples/substra_core/titanic_example/assets/function_random_forest/predict/Dockerfile +++ b/docs/source/examples/substra_core/titanic_example/assets/function_random_forest/predict/Dockerfile @@ -1,5 +1,5 @@ # this base image works in both CPU and GPU enabled environments -FROM ghcr.io/substra/substra-tools:0.20.0-nvidiacuda11.8.0-base-ubuntu22.04-python3.9 +FROM ghcr.io/substra/substra-tools:0.21.0-nvidiacuda11.8.0-base-ubuntu22.04-python3.9 # install dependencies RUN pip3 install pandas numpy 'scikit-learn==1.1.1' diff --git a/docs/source/examples/substra_core/titanic_example/assets/function_random_forest/train/Dockerfile b/docs/source/examples/substra_core/titanic_example/assets/function_random_forest/train/Dockerfile index c5c21a1c0..c80782fcb 100644 --- a/docs/source/examples/substra_core/titanic_example/assets/function_random_forest/train/Dockerfile +++ b/docs/source/examples/substra_core/titanic_example/assets/function_random_forest/train/Dockerfile @@ -1,5 +1,5 @@ # this base image works in both CPU and GPU enabled environments -FROM ghcr.io/substra/substra-tools:0.20.0-nvidiacuda11.8.0-base-ubuntu22.04-python3.9 +FROM ghcr.io/substra/substra-tools:0.21.0-nvidiacuda11.8.0-base-ubuntu22.04-python3.9 # install dependencies RUN pip3 install pandas numpy 'scikit-learn==1.1.1' diff --git a/docs/source/examples/substra_core/titanic_example/assets/metric/Dockerfile b/docs/source/examples/substra_core/titanic_example/assets/metric/Dockerfile index 7fa1d6439..b049b7894 100644 --- a/docs/source/examples/substra_core/titanic_example/assets/metric/Dockerfile +++ b/docs/source/examples/substra_core/titanic_example/assets/metric/Dockerfile @@ -1,5 +1,5 @@ # this base image works in both CPU and GPU enabled environments -FROM ghcr.io/substra/substra-tools:0.20.0-nvidiacuda11.8.0-base-ubuntu22.04-python3.9 +FROM ghcr.io/substra/substra-tools:0.21.0-nvidiacuda11.8.0-base-ubuntu22.04-python3.9 # install dependencies RUN pip3 install scikit-learn==1.0.2