Added: upgrade procedures (#61)

* Added: upgrade procedures * Changed: template * Changed: updated chart version
clearml · Apr 4, 2022 · d7c3b9d · d7c3b9d
1 parent e16060f
commit d7c3b9d
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 12 deletions.
diff --git a/charts/clearml/Chart.yaml b/charts/clearml/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: clearml
 description: MLOps platform
 type: application
-version: "3.8.1"
+version: "3.8.2"
 appVersion: "1.3.0"
 home: https://clear.ml
 icon: https://raw.githubusercontent.com/allegroai/clearml/master/docs/clearml-logo.svg

diff --git a/charts/clearml/README.md b/charts/clearml/README.md
@@ -1,6 +1,6 @@
 # ClearML Ecosystem for Kubernetes
 
-![Version: 3.8.1](https://img.shields.io/badge/Version-3.8.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.3.0](https://img.shields.io/badge/AppVersion-1.3.0-informational?style=flat-square)
+![Version: 3.8.2](https://img.shields.io/badge/Version-3.8.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.3.0](https://img.shields.io/badge/AppVersion-1.3.0-informational?style=flat-square)
 
 MLOps platform
 
@@ -31,9 +31,7 @@ For development/evaluation it's possible to use [kind](https://kind.sigs.k8s.io)
 After installation, following commands will create a complete ClearML insatllation:
 
 ```
-mkdir -pm 777 /tmp/clearml-kind
-
-cat <<EOF > /tmp/clearml-kind.yaml
+cat <<EOF | kind create cluster --config=-                                                                  ─╯
 kind: Cluster
 apiVersion: kind.x-k8s.io/v1alpha4
 nodes:
@@ -62,8 +60,6 @@ nodes:
     containerPath: /var/local-path-provisioner
 EOF
 
-kind create cluster --config /tmp/clearml-kind.yaml
-
 helm install clearml allegroai/clearml
 ```
 
@@ -89,6 +85,24 @@ This will create 3 ingress rules:
 
 Just pointing the domain records to the IP where ingress controller is responding will complete the deployment process.
 
+## Upgrades/ Values upgrades
+
+Updating to latest version of this chart can be done in two steps:
+
+```
+helm repo update
+helm upgrade clearml allegroai/clearml
+```
+
+Changing values on existing installation can be done with:
+
+```
+helm upgrade clearml allegroai/clearml --version <CURRENT CHART VERSION> -f custom_values.yaml
+```
+
+Please note: updating values only should always be done setting explicit chart version to avoid a possible chart update.
+Keeping separate updates procedures between version and values can be a good practice to seprate potential concerns.
+
 ## Additional Configuration for ClearML Server
 
 You can also configure the **clearml-server** for:

diff --git a/charts/clearml/README.md.gotmpl b/charts/clearml/README.md.gotmpl
@@ -28,9 +28,7 @@ For development/evaluation it's possible to use [kind](https://kind.sigs.k8s.io)
 After installation, following commands will create a complete ClearML insatllation:
 
 ```
-mkdir -pm 777 /tmp/clearml-kind
-
-cat <<EOF > /tmp/clearml-kind.yaml
+cat <<EOF | kind create cluster --config=-                                                                  ─╯
 kind: Cluster
 apiVersion: kind.x-k8s.io/v1alpha4
 nodes:
@@ -59,8 +57,6 @@ nodes:
     containerPath: /var/local-path-provisioner
 EOF
 
-kind create cluster --config /tmp/clearml-kind.yaml
-
 helm install clearml allegroai/clearml
 ```
 
@@ -86,6 +82,24 @@ This will create 3 ingress rules:
 
 Just pointing the domain records to the IP where ingress controller is responding will complete the deployment process.
 
+## Upgrades/ Values upgrades
+
+Updating to latest version of this chart can be done in two steps:
+
+```
+helm repo update
+helm upgrade clearml allegroai/clearml
+```
+
+Changing values on existing installation can be done with:
+
+```
+helm upgrade clearml allegroai/clearml --version <CURRENT CHART VERSION> -f custom_values.yaml
+```
+
+Please note: updating values only should always be done setting explicit chart version to avoid a possible chart update. 
+Keeping separate updates procedures between version and values can be a good practice to seprate potential concerns.
+
 ## Additional Configuration for ClearML Server
 
 You can also configure the **clearml-server** for: