Skip to content

Commit

Permalink
helm: fix comment syntax on envoy values
Browse files Browse the repository at this point in the history
The helm value properties related to the Envoy DaemonSet doesn't use the
proper comment syntax which is the reason why the properties doesn't
show up in the documentation.

This commit fixes this by using the proper syntax starting with `# --`.

Signed-off-by: Marco Hofstetter <marco.hofstetter@isovalent.com>
  • Loading branch information
mhofstetter authored and joestringer committed Jun 14, 2023
1 parent 1ad8d98 commit 2d0e221
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 21 deletions.
44 changes: 40 additions & 4 deletions Documentation/helm-values.rst

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

4 changes: 4 additions & 0 deletions Documentation/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,7 @@ configSources
configmap
configs
conformant
connectTimeoutSeconds
connectionTimeout
conntrack
conntrackGCInterval
Expand Down Expand Up @@ -563,6 +564,7 @@ identityChangeGracePeriod
identityGCInterval
identityHeartbeatTimeout
idleConnectionGracePeriod
idleTimeoutDurationSeconds
ie
ifindex
imagePullSecrets
Expand Down Expand Up @@ -718,7 +720,9 @@ masqLinkLocal
masterDevice
matchLabels
matchPattern
maxConnectionDurationSeconds
maxDeferredConnectionDeletes
maxRequestsPerConnection
maxUnavailable
mc
mediabot
Expand Down
11 changes: 10 additions & 1 deletion install/kubernetes/cilium/README.md

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

20 changes: 12 additions & 8 deletions install/kubernetes/cilium/values.yaml

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

20 changes: 12 additions & 8 deletions install/kubernetes/cilium/values.yaml.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -1760,24 +1760,24 @@ proxy:
# container image names
sidecarImageRegex: "cilium/istio_proxy"

# -- Configure Cilium Envoy options.
# Configure Cilium Envoy options.
envoy:
# Enable Envoy Proxy in standalone DaemonSet.
# -- Enable Envoy Proxy in standalone DaemonSet.
enabled: false

log:
# The format string to use for laying out the log message metadata of Envoy.
# -- The format string to use for laying out the log message metadata of Envoy.
format: "[%Y-%m-%d %T.%e][%t][%l][%n] [%g:%#] %v"
# Path to a separate Envoy log file, if any. Defaults to /dev/stdout.
# -- Path to a separate Envoy log file, if any. Defaults to /dev/stdout.
path: ""

# Time in seconds after which a TCP connection attempt times out
# -- Time in seconds after which a TCP connection attempt times out
connectTimeoutSeconds: 2
# ProxyMaxRequestsPerConnection specifies the max_requests_per_connection setting for Envoy
# -- ProxyMaxRequestsPerConnection specifies the max_requests_per_connection setting for Envoy
maxRequestsPerConnection: 0
# Set Envoy HTTP option max_connection_duration seconds. Default 0 (disable)
# -- Set Envoy HTTP option max_connection_duration seconds. Default 0 (disable)
maxConnectionDurationSeconds: 0
# Set Envoy upstream HTTP idle connection timeout seconds.
# -- Set Envoy upstream HTTP idle connection timeout seconds.
# Does not apply to connections with pending requests. Default 60s
idleTimeoutDurationSeconds: 60

Expand Down Expand Up @@ -1820,6 +1820,8 @@ envoy:
# -- TCP port for the health API.
healthPort: 9878

# -- cilium-envoy update strategy
# ref: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/#updating-a-daemonset
updateStrategy:
type: RollingUpdate
rollingUpdate:
Expand Down Expand Up @@ -1920,6 +1922,7 @@ envoy:
dnsPolicy: ~

prometheus:
# -- Enable prometheus metrics for cilium-envoy
enabled: true
serviceMonitor:
# -- Enable service monitors.
Expand All @@ -1942,6 +1945,7 @@ envoy:
replacement: ${1}
# -- Metrics relabeling configs for the ServiceMonitor cilium-envoy
metricRelabelings: ~
# -- Serve prometheus metrics for cilium-envoy on the configured port
port: "9964"

# -- Enable use of the remote node identity.
Expand Down

0 comments on commit 2d0e221

Please sign in to comment.