Merge pull request #31 from lucernae/docs

Upgrade charts and docs

.envrc

@@ -1,8 +1,9 @@
 use_nix
 
-export KUBECONFIG=`pwd`/kubeconfig.yaml
-export PROJECT_ROOT=`pwd`
-export CT_CONFIG=`pwd`/ct.yaml
+export KUBECONFIG=$(pwd)/kubeconfig.yaml
+export PROJECT_ROOT=$(pwd)
+export CT_CONFIG=$(pwd)/ct.yaml
+export HELM_DOCS_ARGS="-t ./README.md.gotmpl"
 
 source_env_if_exists .local.envrc
 

.github/workflows/release.yaml

@@ -23,5 +23,6 @@ jobs:
         uses: lucernae/chart-releaser-action@rancher-1.0
         with:
           level: 3
+          force: true
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

Makefile

@@ -1,3 +1,18 @@
 
+build-deps:
+	nix-build
+
+shell:
+	nix-shell
+
 lint:
 	ct lint
+
+install:
+	ct install
+
+reload:
+	direnv reload
+
+direnv-allow:
+	direnv allow

README.md

@@ -1,2 +1,47 @@
 # Kartoza Helm charts
+
 Kartoza Helm/Rancher charts for Kubernetes
+
+# Add Helm Repo
+
+To add the Helm Repo using Helm CLI:
+
+```bash
+helm repo add kartoza https://kartoza.github.io/charts
+```
+
+To add the Helm Repo in Rancher (Because we are using Rancher format structure),
+use the github url: https://github.com/kartoza/charts.git.
+Stable version of the charts is in `main` branch.
+
+
+# Usage
+
+To install chart, execute helm command
+
+```bash
+helm install -n <namespace> <release-name> kartoza/<chart-name> --version <chart-version> -f <values.yaml>
+```
+
+# Development
+
+The chart structure is not yet stable, but we are welcoming any contributions.
+In the bare minimum we will try to keep the same version as stable as possible.
+
+If you are interested in contributing, you can check
+[DEVELOPMENT-README.md](DEVELOPMENT-README.md).
+
+List of stable charts (with somewhat good documentation):
+
+- [Postgis](charts/postgis)
+- [Django](charts/django)
+- [GeoNode](charts/geonode)
+- [GeoServer](charts/geoserver)
+
+List of working charts, but not thoroughly tested:
+
+- [QGIS Server](charts/qgis-server)
+- [Guacamole](charts/guacamole)
+- [NextCloud](charts/nextcloud)
+
+Our design patterns are somewhat inspired by the [BitNami]

charts/common/README.md

@@ -0,0 +1 @@
+v1.0.1/README.md

charts/common/v1.0.0/_templates.gotmpl

@@ -2,6 +2,14 @@
 Template collections for autodoc using helm-docs
 */}}
 
+{{/*
+Helm-chart docs template version
+*/}}
+{{- define "chart.templates.version" -}}
+# Helm-Docs Chart Template Version
+common-v1.0.0
+{{- end -}}
+
 {{/*
 Default Value Column Render
 Input: list
@@ -12,7 +20,7 @@ Input: list
 {{- define "chart.valueDefaultColumnRender.default" -}}
 {{- $defaultValue := index . 1 -}}
 {{- $notationType := index . 2 -}}
-<pre lang={{ $notationType }}">
+<pre lang="{{ $notationType }}">
 {{ $defaultValue }}
 </pre>
 {{- end -}}
@@ -78,7 +86,7 @@ Input: map
   .AutoDefault
 */}}
 {{- define  "chart.keyColumnRender" -}}
-<a id={{ .Key | replace "." "--" }}">{{ .Key }}</a>
+<a id="{{ .Key | replace "." "--" }}">{{ .Key }}</a>
 {{- end -}}
 
 {{/*

charts/common/v1.0.1/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

charts/common/v1.0.1/Chart.yaml

@@ -0,0 +1,27 @@
+apiVersion: v2
+name: common
+description: Common library for ops
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: library
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+version: 1.0.1
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application.
+appVersion: 1.0.1
+sources:
+  - https://github.com/kartoza/charts/tree/main/charts/common
+maintainers:
+  - name: lucernae
+    email: lana.pcfre@gmail.com
+engine: gotpl

charts/common/v1.0.1/README.md

@@ -0,0 +1,18 @@
+
+
+# common
+
+![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: 1.0.1](https://img.shields.io/badge/AppVersion-1.0.1-informational?style=flat-square)
+
+Common library for ops
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| lucernae | lana.pcfre@gmail.com |  |
+
+## Source Code
+
+* <https://github.com/kartoza/charts/tree/main/charts/common>
+

charts/common/v1.0.1/README.md.gotmpl

@@ -0,0 +1,19 @@
+{{ template "chart.header" . }}
+
+{{ template "chart.deprecationWarning" . }}
+
+{{ template "chart.badgesSection" . }}
+
+{{ template "chart.description" . }}
+
+{{ template "chart.homepageLine" . }}
+
+{{ template "chart.maintainersSection" . }}
+
+{{ template "chart.sourcesSection" . }}
+
+{{ template "chart.requirementsSection" . }}
+
+{{ template "chart.valuesSection" . }}
+
+{{ template "helm-docs.versionFooter" . }}