Merge pull request #36 from projectsyn/docs/v2-v3

Add v3 upgrade guidance
projectsyn · Sep 26, 2022 · ba4a3ea · ba4a3ea
2 parents b4f4e38 + 459aa42
commit ba4a3ea
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 0 deletions.
diff --git a/docs/modules/ROOT/pages/how-tos/upgrade-2.x-to-3.x.adoc b/docs/modules/ROOT/pages/how-tos/upgrade-2.x-to-3.x.adoc
@@ -0,0 +1,30 @@
+= Upgrade from 2.x to 3.x
+
+This guide describes the steps to perform an upgrade of the component from version 2.x to 3.x.
+
+== Introduction
+
+Beginning with version 3.0.0, this component is using the commodore best practices for Helm charts.
+
+This means that the value to manually override the Helm chart version has changed from `parameters.metallb.charts.metallb` to `parameters.metallb.charts.metallb.version`.
+
+Therefore, the following configuration
+
+```
+parameters:
+  metallb:
+    charts:
+      metallb: x.y.z
+```
+
+must be changed to
+
+```
+parameters:
+  metallb:
+    charts:
+      metallb:
+        version: x.y.z
+```
+
+in order to override the Helm chart version.
diff --git a/docs/modules/ROOT/partials/nav.adoc b/docs/modules/ROOT/partials/nav.adoc
@@ -1,2 +1,8 @@
 * xref:index.adoc[Home]
+
+.Technical reference
 * xref:references/parameters.adoc[Parameters]
+
+.How-to guides
+* xref:how-tos/upgrade-1.x-to-2.x.adoc[Upgrade from 1.x to 2.x]
+* xref:how-tos/upgrade-2.x-to-3.x.adoc[Upgrade from 2.x to 3.x]