docs: More docs

stenic · Dec 31, 2022 · 3787580 · 3787580
1 parent 8bd5341
commit 3787580
Show file tree

Hide file tree

Showing 4 changed files with 174 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -20,3 +20,22 @@ drun:
 		-e OIDC_CLIENT_ID \
 		-v $(PWD)/data:/app/data \
 		-p 8080:8080 ledger
+
+HELM_DOCS = $(shell pwd)/bin/helm-docs
+helm-docs: ## Download helm-docs locally if necessary.
+	$(call go-get-tool,$(HELM_DOCS),github.com/norwoodj/helm-docs/cmd/[email protected])
+
+
+# go-get-tool will 'go get' any package $2 and install it to $1.
+PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
+define go-get-tool
+@[ -f $(1) ] || { \
+set -e ;\
+TMP_DIR=$$(mktemp -d) ;\
+cd $$TMP_DIR ;\
+go mod init tmp ;\
+echo "Downloading $(2)" ;\
+GOBIN=$(PROJECT_DIR)/bin go get $(2) ;\
+rm -rf $$TMP_DIR ;\
+}
+endef
diff --git a/README.md b/README.md
@@ -27,6 +27,8 @@ helm repo add ledger https://stenic.github.io/ledger/
 helm install ledger --namespace ledger ledger/ledger
 ```
 
+Check the [helm chart](./charts/ledger/) for more configuration options.
+
 ## Collecting versions
 
 Ledger lets you choose how you want to record versions.

diff --git a/charts/ledger/README.md b/charts/ledger/README.md
@@ -0,0 +1,96 @@
+# ledger
+
+## TL;DR;
+
+```console
+helm repo add ledger https://stenic.github.io/ledger/
+helm install ledger --namespace ledger ledger/ledger
+```
+
+## Introduction
+
+This chart installs `ledger` on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
+
+## Prerequisites
+
+- Kubernetes 1.12+
+- Helm 3.0+
+
+## Installing the Chart
+
+To install the chart with the release name `my-release`:
+
+```console
+helm repo add ledger https://stenic.github.io/ledger/
+helm install ledger --namespace ledger ledger/ledger
+```
+
+These commands deploy ledger on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
+
+> **Tip**: List all releases using `helm list`
+
+## Uninstalling the Chart
+
+To uninstall/delete the `my-release` deployment:
+
+```console
+helm delete my-release
+```
+
+The command removes all the Kubernetes components associated with the chart and deletes the release.
+
+## Configuration
+
+The following tables list the configurable parameters of the ledger chart and their default values.
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` | Affinity and anti-affinity |
+| autoscaling.enabled | bool | `false` | Enable autoscaling |
+| autoscaling.maxReplicas | int | `4` | Maximum number of replicas |
+| autoscaling.minReplicas | int | `2` | Minimum number of replicas |
+| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization percentage |
+| fullnameOverride | string | `""` | String to fully override fullname |
+| image.pullPolicy | string | `"Always"` | ledger image pullPolicy |
+| image.repository | string | `"ghcr.io/stenic/ledger"` | ledger image repository |
+| image.tag | string | `""` | ledger image tag (immutable tags are recommended) Overrides the image tag whose default is the chart appVersion. |
+| imagePullSecrets | list | `[]` | Docker registry secret names as an array |
+| ingress.annotations | object | `{}` | Additional ingress annotations |
+| ingress.className | string | `""` | Defines which ingress controller will implement the resource |
+| ingress.enabled | bool | `false` | Enable an ingress resource |
+| ingress.hosts | list | `[{"host":"chart-example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}]` | List of ingress hosts |
+| ingress.tls | list | `[]` | Ingress TLS configuration |
+| ledgerAgent.enabled | bool | `true` |  |
+| ledgerAgent.endpoint | string | `"http://ledger-server"` |  |
+| ledgerAgent.location | string | `""` |  |
+| ledgerAgent.log.level | string | `"info"` |  |
+| ledgerAgent.namespaced | bool | `false` |  |
+| ledgerAgent.token | string | `nil` |  |
+| ledgerServer.enabled | bool | `true` |  |
+| ledgerServer.jwt.secret | string | `""` |  |
+| ledgerServer.log.level | string | `"info"` |  |
+| ledgerServer.mysql.dsn | string | `""` |  |
+| ledgerServer.oidc.audience | string | `"account"` |  |
+| ledgerServer.oidc.clientID | string | `"ledger"` |  |
+| ledgerServer.oidc.issuerURL | string | `"https://[keycloak-url]/auth/realms/[realm-name]"` |  |
+| nameOverride | string | `""` | String to partially override fullname |
+| nodeSelector | object | `{}` | Node labels for controller pod assignment |
+| podAnnotations | object | `{}` | Additional annotations for the pods. |
+| podSecurityContext | object | `{}` | Enable Controller pods' Security Context |
+| replicaCount | int | `2` | Desired number of pods |
+| resources | object | `{"limits":{"cpu":"500m","memory":"64Mi"},"requests":{"cpu":"100m","memory":"64Mi"}}` | Resource requests and limits for the controller |
+| securityContext | object | `{"allowPrivilegeEscalation":false,"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsGroup":100012,"runAsNonRoot":true,"runAsUser":100012}` | Enable Controller containers' Security Context |
+| service.port | int | `80` | Service port |
+| service.type | string | `"ClusterIP"` | Kubernetes Service type |
+| serviceAccount.annotations | object | `{}` |  |
+| serviceAccount.create | bool | `true` | Specifies whether a ServiceAccount should be created |
+| serviceAccount.name | string | `""` | The name of the ServiceAccount to use. If not set and create is true, a name is generated using the fullname template |
+| tolerations | list | `[]` | Node tolerations for server scheduling to nodes with taints |
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
+
+Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
+
+```console
+helm install my-release -f values.yaml ledger/ledger
+```
diff --git a/charts/ledger/README.md.gotmpl b/charts/ledger/README.md.gotmpl
@@ -0,0 +1,57 @@
+{{ template "chart.header" . }}
+
+## TL;DR;
+
+```console
+helm repo add ledger https://stenic.github.io/ledger/
+helm install ledger --namespace ledger ledger/{{ template "chart.name" . }}
+```
+
+## Introduction
+
+This chart installs `{{ template "chart.name" . }}` on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
+
+## Prerequisites
+
+- Kubernetes 1.12+
+- Helm 3.0+
+
+
+## Installing the Chart
+
+To install the chart with the release name `my-release`:
+
+```console
+helm repo add ledger https://stenic.github.io/ledger/
+helm install ledger --namespace ledger ledger/{{ template "chart.name" . }}
+```
+
+These commands deploy {{ template "chart.name" . }} on the Kubernetes cluster in the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
+
+> **Tip**: List all releases using `helm list`
+
+
+## Uninstalling the Chart
+
+To uninstall/delete the `my-release` deployment:
+
+```console
+helm delete my-release
+```
+
+The command removes all the Kubernetes components associated with the chart and deletes the release.
+
+
+## Configuration
+
+The following tables list the configurable parameters of the {{ template "chart.name" . }} chart and their default values.
+
+{{ template "chart.valuesTable" . }}
+
+Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
+
+Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,
+
+```console
+helm install my-release -f values.yaml ledger/{{ template "chart.name" . }}
+```