From 0447a65b01dc94f9eac97933fc551964e1e0d6db Mon Sep 17 00:00:00 2001
From: Bryan Brancotte <bryan.brancotte@pasteur.fr>
Date: Thu, 13 Jun 2024 17:40:09 +0200
Subject: [PATCH] document package renaming script usage
---
source/user_guide/FAQ_user.rst | 116 +++++++++++++++++++++++----------
1 file changed, 83 insertions(+), 33 deletions(-)
diff --git a/source/user_guide/FAQ_user.rst b/source/user_guide/FAQ_user.rst
index c2114cd..4b7777c 100644
--- a/source/user_guide/FAQ_user.rst
+++ b/source/user_guide/FAQ_user.rst
@@ -143,41 +143,91 @@ How to upgrade my helm dependency / I can't enable a feature
Basic use case is that the doc mention a feature, you enable it in values.yaml, but don't see the effect.
The cause can be that you don't use latest version of the helm package, the part of the toolkit which provide feature such as storage, nodowntime, ...
-Until June 2024, version was pinned to a specific version, only allowing minor release (see `Use 0.6.*`)
-We now recommend that you always use the latest version.
-To do so update the file my-project/chart/Chart.yaml, set the version of the shiny-server dependency to ``*``.
-.. tabs::
+Until June 2024, the helm package was named ``shiny-server`` and version was pinned to a specific version, only allowing to get updates from minor release.
+To prevent misunderstanding about the purpose of the helm package, we renamed it ``shiny-k8s-toolkit-helm``.
+We also now recommend that you always use the latest version.
- .. code-tab:: yaml
- :caption: Use latest version (recommended)
- :emphasize-lines: 9
- :selected:
+To do we provide a script that will update three files of the toolkit to use the latest version witht the new name of the helm package.
- apiVersion: v2
- name: shiny-example
- description: An example
-
- ...
-
- dependencies:
- - name: shiny-server
- version: "*"
- repository: "https://gitlab.pasteur.fr/api/v4/projects/5334/packages/helm/stable"
-
- .. code-tab:: yaml
- :caption: Use 0.6.* (Until June 2024)
- :emphasize-lines: 9
-
-
- apiVersion: v2
- name: shiny-example
- description: An example
-
- ...
+.. code-block:: bash
- dependencies:
- - name: shiny-server
- version: "~0.6.0"
- repository: "https://gitlab.pasteur.fr/api/v4/projects/5334/packages/helm/stable"
\ No newline at end of file
+ # go into your project, where .gitlab-ci.yml is.
+
+ wget https://gitlab.pasteur.fr/hub/shiny-k8s-example/-/raw/advanced-scripts/apply-package-renaming.sh
+
+ chmod a+x apply-package-renaming.sh
+
+ ./apply-package-renaming.sh
+ # three file should have been renamed
+ git diff
+
+Here after is what your git diff should look like : changes in values.yaml, Chart.yaml and gitlab-ci.yaml
+
+.. code-block:: diff
+
+ $ git diff
+ diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
+ index xxxxxxx..yyyyyyy 100644
+ --- a/.gitlab-ci.yml
+ +++ b/.gitlab-ci.yml
+ @@ -43,23 +43,23 @@ build:
+ - >
+ echo "helm upgrade --install --namespace=${NAMESPACE}
+ --render-subchart-notes
+ - --set shiny-server.ingress.className=${INGRESS_CLASS}
+ - --set shiny-server.ingress.hostname=${PUBLIC_URL}
+ - --set shiny-server.imageFullNameAndTag=${IMAGE}
+ - --set shiny-server.registry.username=${DEPLOY_USER}
+ - --set shiny-server.registry.password=xxxx
+ - --set shiny-server.registry.host=${CI_REGISTRY}
+ + --set shiny-k8s-toolkit-helm.ingress.className=${INGRESS_CLASS}
+ + --set shiny-k8s-toolkit-helm.ingress.hostname=${PUBLIC_URL}
+ + --set shiny-k8s-toolkit-helm.imageFullNameAndTag=${IMAGE}
+ + --set shiny-k8s-toolkit-helm.registry.username=${DEPLOY_USER}
+ + --set shiny-k8s-toolkit-helm.registry.password=xxxx
+ + --set shiny-k8s-toolkit-helm.registry.host=${CI_REGISTRY}
+ --values ./${CHART_LOCATION}/${VALUES_OVERRIDE_FILENAME:-values.yaml}
+ ${CI_COMMIT_REF_SLUG}-${CHART_LOCATION} ./${CHART_LOCATION}/"
+ - >
+ helm upgrade --install --namespace=${NAMESPACE}
+ --render-subchart-notes
+ - --set shiny-server.ingress.className=${INGRESS_CLASS}
+ - --set shiny-server.ingress.hostname=${PUBLIC_URL}
+ - --set shiny-server.imageFullNameAndTag=${IMAGE}
+ - --set shiny-server.registry.username=${DEPLOY_USER}
+ - --set shiny-server.registry.password=${DEPLOY_TOKEN}
+ - --set shiny-server.registry.host=${CI_REGISTRY}
+ + --set shiny-k8s-toolkit-helm.ingress.className=${INGRESS_CLASS}
+ + --set shiny-k8s-toolkit-helm.ingress.hostname=${PUBLIC_URL}
+ + --set shiny-k8s-toolkit-helm.imageFullNameAndTag=${IMAGE}
+ + --set shiny-k8s-toolkit-helm.registry.username=${DEPLOY_USER}
+ + --set shiny-k8s-toolkit-helm.registry.password=${DEPLOY_TOKEN}
+ + --set shiny-k8s-toolkit-helm.registry.host=${CI_REGISTRY}
+ --values ./${CHART_LOCATION}/${VALUES_OVERRIDE_FILENAME:-values.yaml}
+ ${CI_COMMIT_REF_SLUG}-${CHART_LOCATION} ./${CHART_LOCATION}/
+
+ diff --git a/chart/Chart.yaml b/chart/Chart.yaml
+ index xxxxxxx..yyyyyyy 100644
+ --- a/chart/Chart.yaml
+ +++ b/chart/Chart.yaml
+ @@ -24,6 +24,6 @@ version: 1.0.0
+ appVersion: "1.0.0"
+
+ dependencies:
+ -- name: shiny-server
+ - version: "~0.6.0"
+ +- name: shiny-k8s-toolkit-helm
+ + version: "*"
+ repository: "https://gitlab.pasteur.fr/api/v4/projects/5334/packages/helm/stable"
+ diff --git a/chart/values.yaml b/chart/values.yaml
+ index xxxxxxx..yyyyyyy 100644
+ --- a/chart/values.yaml
+ +++ b/chart/values.yaml
+ @@ -1,4 +1,4 @@
+ -shiny-server:
+ +shiny-k8s-toolkit-helm:
+ autoscaling:
+ enabled: false
+ nodowntime:
--
GitLab