Merge branch '1743-review-the-quickstart-demo-documentation' into 'main-1.15'

doc: using helm in quickstart guide

See merge request ongresinc/stackgres!1630

Author: teoincontatto

doc/build.sh

@@ -10,6 +10,7 @@ find "$(dirname "$0")/../stackgres-k8s/src/common/src/main/resources/crds" -name
       cp "$FILE" "$(dirname "$0")/data/crds"
     done
 cp "$(dirname "$0")/../stackgres-k8s/install/helm/stackgres-operator/Chart.yaml" "$(dirname "$0")/data/stackgres_operator_Chart.yaml"
+sed -n 's#^ *RUN wget "https://get.helm.sh/helm-v\([^-]\+\)-.*$#version: \1#p' "$(dirname "$0")/../stackgres-k8s/ci/build/Dockerfile-ci" > "$(dirname "$0")/data/helm_version.yaml"
 
 STACKGRES_VERSION="${STACKGRES_VERSION:-$(sh stackgres-k8s/ci/build/version.sh)}"
 echo "current_version: \"$STACKGRES_VERSION\"" > "$(dirname "$0")/data/versions.yml"

doc/content/en/03-demo-quickstart/_index.md

@@ -13,17 +13,22 @@ aliases: [ /demo/quickstart ]
 On this page, you will learn how to get started with StackGres.
 We will install StackGres on a Kubernetes cluster and create a Postgres instance.
 
-> **NOTE:** To run this demo you need a [K8s environment]({{% relref "04-administration-guide/01-stackgres-installation/01-pre-requisites/01-k8s-environments" %}}) that is already configured in `kubectl`.
+> **NOTE:** To run this demo you need a [K8s environment]({{% relref "04-administration-guide/01-stackgres-installation/01-pre-requisites" %}}) with `kubectl` command already configured to use it. You will also need [`helm`](https://helm.sh/) command version >= `{{% helm-min-version %}}`.
+
+## Set Up the Helm Repository
+
+Add the StackGres Helm repository:
+
+```
+helm repo add stackgres-charts https://stackgres.io/downloads/stackgres-k8s/stackgres/helm/
+```
 
 ## Installing the Operator
 
-We ship some Kubernetes resources files in order to allow installation of the StackGres operator
- for demonstration purpose. Assuming you have already installed the
- [kubectl CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/), you can install the
- operator with the following command:
+Install the operator using the following command: 
 
 ```
-kubectl create -f {{< download-url >}}/stackgres-operator-demo.yml
+helm install --create-namespace --namespace stackgres stackgres-operator stackgres-charts/stackgres-operator --version {{< version >}}
 ```
 
 This will install all required resources, and add the StackGres operator to a new namespace `stackgres`.
@@ -151,10 +156,9 @@ Then you can open the browser at the following address [`localhost:8443/admin/`]
 ## Cleaning up
 
 To uninstall all resources generated by this demo, you can run:
+
 ```
-kubectl delete --ignore-not-found -f {{< download-url >}}/stackgres-operator-demo.yml
+helm uninstall --namespace stackgres stackgres-operator
 ```
 
-Check the [uninstall]({{% relref "/04-administration-guide/999999-uninstall" %}}) section for more details.
-
-Also, see the [installation via helm]({{% relref "/04-administration-guide/01-stackgres-installation/02-installation-via-helm" %}}) section in order to change those.
+Check the [uninstall]({{% relref "/04-administration-guide/999999-uninstall" %}}#using-helm) section for more details.

doc/content/en/04-administration-guide/01-stackgres-installation/02-installation-via-helm/_index.md

@@ -7,7 +7,7 @@ description: Details about how to install the StackGres operator using Helm.
 showToc: true
 ---
 
-The StackGres operator can be installed using [Helm](https://helm.sh/) version >= `3.1.1`.
+The StackGres operator can be installed using [Helm](https://helm.sh/) version >= `{{% helm-min-version %}}`.
 As you may expect, a production environment will require you to install and set up additional components alongside your StackGres operator and cluster resources.
 
 On this page, we are going through all the necessary steps to set up a production-grade StackGres environment using Helm.
@@ -28,7 +28,7 @@ Install the operator:
 helm install --create-namespace --namespace stackgres stackgres-operator stackgres-charts/stackgres-operator
 ```
 
-> You can specify the version adding `--version <version, e.g. 1.0.0>` to the Helm command. 
+> You can specify the version adding `--version <version>` to the Helm command. 
 
 For more installation options have a look at the [Operator Parameters]({{% relref "04-administration-guide/01-stackgres-installation/02-installation-via-helm/01-operator-parameters" %}}) section for more information.
 

doc/content/en/04-administration-guide/999999-uninstall/_index.md

@@ -186,34 +186,6 @@ sgpoolingconfig.stackgres.io "generated-from-default-1609864616550" deleted
 
 ```
 
-#### Prometheus service monitors and pod monitors
-
-The missing part are the ServiceMonitors and PodMonitors that the operator created to integrate with
- the Prometheus Operator.
-
-List all StackGres ServiceMonitors and PodMonitors:
-
-```
-kubectl get servicemonitors,podmonitors -A -l app=StackGresCluster
-```
-
-```
-NAMESPACE   NAME                                                                     AGE
-stackgres   servicemonitor.monitoring.coreos.com/ui-ui-stackgres-envoy               120m
-stackgres   servicemonitor.monitoring.coreos.com/ui-ui-stackgres-postgres-exporter   120m
-```
-
-To delete all:
-
-```
-kubectl get configmap -l app=StackGresCluster -o name -A | xargs kubectl delete
-```
-
-```
-configmap "my-db-cluster-prometheus-postgres-exporter-config" deleted
-```
-
-
 ## Uninstall the Operator
 
 ### Using Helm
@@ -223,7 +195,7 @@ Execute the steps below to remove the helm chart release:
 ```
 ## locate the namespace that the operator was installed
 ## our doc always points to `stackgres`
-helm list --all-namespaces | grep '^\(stackgres-operator\|NAME\)\s'
+helm list --all-namespaces
 ```
 
 Will show the installed StackGres helm chart releases like in the following output:
@@ -253,6 +225,8 @@ kubectl get all -n stackgres
 No resources found in stackgres namespace.
 ```
 
+See also the section about [uninstalling unamespaced resources](#cleanup-unamespaced-resources)
+
 ## Manually
 
 This tutorial expects that the operator was installed on the `stackgres` namespace. Change it if you have this installed in a different namespace.
@@ -288,7 +262,7 @@ deployment.apps "stackgres-restapi" deleted
 
 ## Cleanup unamespaced resources
 
-To completely remove all the
+Follow this section in order to remove unamesapced resources.
 
 ### Webhooks
 

doc/themes/sg-doc/layouts/shortcodes/helm-min-version.html

@@ -0,0 +1 @@
+{{ $.Site.Data.helm_version.version | strings.ReplaceRE "^([^.]+\\.[^.]+).*$" "$1" }}