Include dependency values in documentation (#275)

I have added a flag to the helm-docs script to include the documentation
for dependencies.

This will add more complete documentation to
https://artifacthub.io/packages/helm/spiffe/spire#values so it is easier
for our users to get started and having a complete overview.

---------

Signed-off-by: Marco Franssen <[email protected]>
Co-authored-by: Faisal Memon <[email protected]>
This commit is contained in:
Marco Franssen
2023-05-12 18:12:23 +00:00
committed by GitHub
co-authored by Faisal Memon
parent 5489212bb5
commit 65312f8525
12 changed files with 351 additions and 78 deletions
@@ -2,6 +2,7 @@
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.
# -- The name of the spire-agent unix socket
agentSocketName: spire-agent.sock
replicaCount: 1
@@ -9,11 +10,13 @@ replicaCount: 1
namespaceOverride: ""
image:
# registry: gcr.io
# repository: spiffe-io/oidc-discovery-provider
# -- The OCI registry to pull the image from
registry: ghcr.io
# -- The repository within the registry
repository: spiffe/oidc-discovery-provider
# -- The image pull policy
pullPolicy: IfNotPresent
# -- Overrides the image tag whose default is the chart appVersion
version: ""
resources: {}
@@ -56,8 +59,11 @@ insecureScheme:
nginx:
image:
# -- The OCI registry to pull the image from
registry: docker.io
# -- The repository within the registry
repository: nginxinc/nginx-unprivileged
# -- The image pull policy
pullPolicy: IfNotPresent
version: 1.23.2-alpine
# chainguard image does not support the templates feature
@@ -79,6 +85,7 @@ insecureScheme:
# memory: 64Mi
config:
# -- The log level, valid values are "debug", "info", "warn", and "error"
logLevel: info
domains:
- localhost
@@ -95,11 +102,11 @@ nameOverride: ""
fullnameOverride: ""
serviceAccount:
# Specifies whether a service account should be created
# -- Specifies whether a service account should be created
create: true
# Annotations to add to the service account
# -- Annotations to add to the service account
annotations: {}
# The name of the service account to use.
# -- The name of the service account to use.
# If not set and create is true, a name is generated using the fullname template
name: ""
@@ -116,8 +123,9 @@ tolerations: []
affinity: {}
# -- Set the trust domain to be used for the SPIFFE identifiers
trustDomain: example.org
# -- This is the value of your clusters `kubeadm init --service-dns-domain` flag
# -- The name of the Kubernetes cluster (`kubeadm init --service-dns-domain`)
clusterDomain: cluster.local
telemetry:
@@ -132,8 +140,11 @@ telemetry:
nginxExporter:
image:
# -- The OCI registry to pull the image from
registry: docker.io
# -- The repository within the registry
repository: nginx/nginx-prometheus-exporter
# -- The image pull policy
pullPolicy: IfNotPresent
version: "0.11.0"