Merge branch 'doc_update' into 'master'

Doc update

See merge request openappstack/openappstack!567

.gitlab/issue_templates/update_all_components.md

@@ -4,20 +4,24 @@ To update all applications, check the following files:
   * [ ] All apk app versions
   * [ ] All non-apk app versions in `Dockerfile`, especially:
     * [ ] flux (Make sure the version is the same as in `ansible/group_vars/all/oas.yml`, `flux.version`; `docs/installation/install_oas.rst` and `install/flux-version-check.sh`)
-* [ ] Mitogen version in `ansible/plugins`
+* [ ] Mitogen version in `ansible/plugins` (https://github.com/mitogen-hq/mitogen/releases)
 
 In `ansible/group_vars/all/oas.yml`:
 
 * [ ] k3s
-* [ ] helm
 * [ ] flux
-* [ ] krew
-* [ ] velero
 
-Installed by flux:
+Our custom charts:
 
-* Update our custom helm-charts and their dependencies, make sure they install
-  latest versions
-  * [ ] [nextcloud](https://open.greenhost.net/openappstack/nextcloud)
-  * [ ] [wordpress](https://open.greenhost.net/openappstack/wordpress-helm)
-  * [ ] [local-path-provisioner](https://open.greenhost.net/openappstack/local-path-provisioner)
+We get dependeny updates via renovate for our custom helm charts.
+However, we still don't get [automated version bumps](https://open.greenhost.net/openappstack/openappstack/-/issues/1001)
+with it, so make sure to bump the version if needed for:
+
+* [ ] [dashboard-frontend](https://open.greenhost.net/openappstack/admin-frontend)
+* [ ] [nextcloud](https://open.greenhost.net/openappstack/nextcloud)
+* [ ] [single-sign-on](https://open.greenhost.net/openappstack/single-sign-on)
+* [ ] [wordpress](https://open.greenhost.net/openappstack/wordpress-helm)
+
+Pull in upstream changes to:
+
+* [ ] [local-path-provisioner](https://open.greenhost.net/openappstack/local-path-provisioner)

ansible/group_vars/all/oas.yml

@@ -33,9 +33,5 @@ krew:
   version: 'v0.3.4'
   checksum: 'sha256:6629b1d7ad215322361f8dd270396fd1a23555fdbde8dcc1ba4ad860978b319a'
 
-velero:
-  version: "1.4.0"
-  checksum: "sha256:1e8afc6631d36e9fabf618777e00705b7044ade1cab9b02953f237b777f46b91"
-
 docker_mirror:
   enabled: false

docs/Makefile

@@ -8,10 +8,15 @@ SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
 
+docdir := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
+
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
+browser: html
+	xdg-open file://$(docdir)/_build/html/index.html
+
 .PHONY: help Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new

docs/README.md

@@ -9,4 +9,4 @@ documentation, using Sphinx:
 
 Then point your browser to the newly generated pages:
 
-    xdg-open file://$PWD/_build/html/index.html
+    make browser

docs/maintenance.rst

@@ -190,6 +190,19 @@ You can delete all evicted pods with this command:
 
    kubectl get pods --all-namespaces -ojson | jq -r '.items[] | select(.status.reason!=null) | select(.status.reason | contains("Evicted")) | .metadata.name + " " + .metadata.namespace' | xargs -n2 -l bash -c 'kubectl delete pods $0 --namespace=$1'
 
+Apply changes to flux variables
+-------------------------------
+
+Before installing, you configured cluster variables in your cluster directory
+in `.flux.env`. If you change any of these variables after installation you can
+apply the changes by following the :ref:`install_core_apps`
+instructions until the step ``kubectl apply -k $CLUSTER_DIR``. Then, use the
+following command that will apply the changes to all installed kustomizations:
+
+.. code:: bash
+
+    flux get -A kustomizations --no-header | awk -F' ' '{system("flux reconcile -n " $1 " kustomization " $2)}'
+
 
 .. _kubectl logs: https://kubernetes.io/docs/concepts/cluster-administration/logging
 .. _Promtail: https://grafana.com/docs/loki/latest/clients/promtail/