From 19533c7814c0173bb61e54d5afef21767643c8e6 Mon Sep 17 00:00:00 2001 From: Starlight Romero <28881133+starlightromero@users.noreply.github.com> Date: Mon, 29 Dec 2025 12:34:27 -0800 Subject: [PATCH] docs(helm): create helm chart readme and doc generation commands --- Makefile | 14 +++++++++- deploy/cert-manager-sync/README.md | 45 ++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+), 1 deletion(-) create mode 100644 deploy/cert-manager-sync/README.md diff --git a/Makefile b/Makefile index 76c52a3..78bca32 100644 --- a/Makefile +++ b/Makefile @@ -3,4 +3,16 @@ test: @echo "Running tests..." @go test -v ./... - @govulncheck -show verbose ./... \ No newline at end of file + @govulncheck -show verbose ./... + +.PHONY: helm-docs +helm-docs: + @echo "Generating Helm chart documentation..." + @command -v helm-docs >/dev/null 2>&1 || { echo "helm-docs is required but not installed. Install it with: go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest"; exit 1; } + @helm-docs --chart-search-root=deploy + +.PHONY: helm-docs-check +helm-docs-check: + @echo "Checking if Helm chart documentation is up to date..." + @command -v helm-docs >/dev/null 2>&1 || { echo "helm-docs is required but not installed. Install it with: go install github.com/norwoodj/helm-docs/cmd/helm-docs@latest"; exit 1; } + @helm-docs --chart-search-root=deploy --dry-run \ No newline at end of file diff --git a/deploy/cert-manager-sync/README.md b/deploy/cert-manager-sync/README.md new file mode 100644 index 0000000..3afee7c --- /dev/null +++ b/deploy/cert-manager-sync/README.md @@ -0,0 +1,45 @@ +# cert-manager-sync + +![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) + +A Helm chart for cert-manager-sync + +## Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| affinity | object | `{}` | | +| autoscaling.enabled | bool | `false` | | +| autoscaling.maxReplicas | int | `100` | | +| autoscaling.minReplicas | int | `1` | | +| autoscaling.targetCPUUtilizationPercentage | int | `80` | | +| clusterRole.create | bool | `true` | | +| config.disableCache | string | `"false"` | | +| config.disabledNamespaces | string | `""` | | +| config.enabledNamespaces | string | `""` | | +| config.logFormat | string | `"json"` | | +| config.logLevel | string | `"info"` | | +| config.operatorName | string | `"cert-manager-sync.lestak.sh"` | | +| config.secretsNamespace | string | `""` | | +| env | list | `[]` | | +| fullnameOverride | string | `""` | | +| image.pullPolicy | string | `"IfNotPresent"` | | +| image.repository | string | `"robertlestak/cert-manager-sync"` | | +| image.tag | string | `"latest"` | | +| imagePullSecrets | list | `[]` | | +| metrics.enabled | bool | `false` | | +| metrics.port | int | `9090` | | +| nameOverride | string | `""` | | +| nodeSelector | object | `{}` | | +| podAnnotations | object | `{}` | | +| podSecurityContext | object | `{}` | | +| replicaCount | int | `1` | | +| resources | object | `{}` | | +| securityContext | object | `{}` | | +| serviceAccount.annotations | object | `{}` | | +| serviceAccount.create | bool | `true` | | +| serviceAccount.name | string | `""` | | +| tolerations | list | `[]` | | + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)