Skip to content

Commit

Permalink
docs: cleanup SPIRE related helm reference
Browse files Browse the repository at this point in the history
This commit cleans up the helm reference documentation of the SPIRE
related values, by removing the comments of "objects" from the
documentation and replacing them by commenting the properties of the
objects if not already present.

Signed-off-by: Marco Hofstetter <marco.hofstetter@isovalent.com>
  • Loading branch information
mhofstetter committed Jun 8, 2023
1 parent 38f430d commit 61fac2a
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 34 deletions.
46 changes: 27 additions & 19 deletions Documentation/helm-values.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Documentation/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ Zannoni
Zhou
Zookeeper
aarch
accessMode
admin
adminSocketPath
agentNotReadyTaintKey
Expand Down Expand Up @@ -1005,6 +1006,7 @@ statefulset
statelessNat
statsd
stdout
storageClass
structs
subclasses
subcommand
Expand Down
12 changes: 7 additions & 5 deletions install/kubernetes/cilium/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 12 additions & 5 deletions install/kubernetes/cilium/values.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 12 additions & 5 deletions install/kubernetes/cilium/values.yaml.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -2963,14 +2963,14 @@ authentication:
spire:
# -- Enable SPIRE integration
enabled: false
# -- Settings to control the SPIRE installation and configuration
# Settings to control the SPIRE installation and configuration
install:
# -- Enable SPIRE installation.
# This will only take effect only if authentication.mutual.spire.enabled is true
enabled: false
# -- SPIRE namespace to install into
namespace: cilium-spire
# -- SPIRE agent configuration
# SPIRE agent configuration
agent:
# -- SPIRE agent image
image: ghcr.io/spiffe/spire-agent:1.6.3@sha256:8eef9857bf223181ecef10d9bbcd2f7838f3689e9bd2445bede35066a732e823
Expand All @@ -2997,18 +2997,25 @@ authentication:
annotations: {}
# -- SPIRE server labels
labels: {}
# -- SPIRE server service configuration
# SPIRE server service configuration
service:
# -- Service type for the SPIRE server service
type: ClusterIP
# -- Annotations to be added to the SPIRE server service
annotations: {}
# -- Labels to be added to the SPIRE server service
labels: {}
# -- SPIRE server datastorage configuration
# SPIRE server datastorage configuration
dataStorage:
# -- Enable SPIRE server data storage
enabled: true
# -- Size of the SPIRE server data storage
size: 1Gi
# -- Access mode of the SPIRE server data storage
accessMode: ReadWriteOnce
# -- StorageClass of the SPIRE server data storage
storageClass: null
# -- SPIRE CA configuration
# SPIRE CA configuration
ca:
# -- SPIRE CA key type
# AWS requires the use of RSA. EC cryptography is not supported
Expand Down

0 comments on commit 61fac2a

Please sign in to comment.