Update helm chart documentation

This commit is contained in:
Sebastian Sdorra
2021-01-07 15:46:41 +01:00
parent 3118d843d3
commit badcf3ecb4
2 changed files with 7 additions and 2 deletions

View File

@@ -30,6 +30,10 @@ The following table list the configurable parameters of the SCM-Manager chart an
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| affinity | object | `{}` | Affinity settings |
| extraEnv | string | `""` | Additional environment variables, parsed through tpl function |
| extraEnvFrom | string | `""` | Additional environment variables mapped from Secret or ConfigMap, parsed through tpl function |
| extraVolumeMounts | string | `""` | Add additional volumes mounts, parsed through tpl function |
| extraVolumes | string | `""` | Add additional volumes, parsed through tpl function |
| fullnameOverride | string | `""` | Override the full resource names |
| image.pullPolicy | string | `"IfNotPresent"` | SCM-Manager image pull policy |
| image.repository | string | `"scmmanager/scm-manager"` | Name of SCM-Manager image |
@@ -39,6 +43,7 @@ The following table list the configurable parameters of the SCM-Manager chart an
| ingress.hosts | list | `["scm-manager.local"]` | Ingress hosts |
| ingress.path | string | `"/"` | Ingress path |
| ingress.tls | list | `[]` | Ingress TLS configuration |
| lifecycleHooks | string | `""` | |
| nameOverride | string | `""` | Override the resource name prefix |
| nodeSelector | object | `{}` | Node labels for pod assignment |
| persistence.accessMode | string | `"ReadWriteOnce"` | The PVC access mode |

View File

@@ -40,8 +40,8 @@ if helm-docs --version > /dev/null 2>&1; then
cd "${CHARTDIR}"
PAGE="docs/en/installation/k8s.md"
echo helm-docs --template-file="${MODULE_DIR}/src/main/docs/helm.md.gotmpl" --output-file="${MODULE_DIR}/../../${PAGE}"
helm-docs --template-file="../../src/main/docs/helm.md.gotmpl" --output-file="../../../../${PAGE}"
echo helm-docs --template-files="${MODULE_DIR}/src/main/docs/helm.md.gotmpl" --output-file="${MODULE_DIR}/../../${PAGE}"
helm-docs --template-files="../../src/main/docs/helm.md.gotmpl" --output-file="../../../../${PAGE}"
echo "The helm documentation was successfully generated"
echo "Please check the results at ${PAGE}"
echo "And don't forget to commit ;)"