Use a fork of 'helm-docs'.

'helm-docs' has a bug which causes it to include comments belonging to previously-appearing but commented-out fields. A fix has been proposed in norwoodj/helm-docs#99, but hasn't been reviewed yet. While said PR doesn't get merged it's preferable to switch to a fork containing the fix so we can have a proper description for our Helm chart fields. [ upstream commit 8d4f1ea ] Signed-off-by: Bruno Miguel Custódio <[email protected]>
cilium · Jun 25, 2021 · adb46b0 · adb46b0
1 parent 8c3c43c
commit adb46b0
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 47 deletions.
diff --git a/Documentation/helm-values.rst b/Documentation/helm-values.rst
@@ -15,7 +15,7 @@
      - bool
      - ``true``
    * - autoDirectNodeRoutes
-     - 
+     - Enable installation of PodCIDR routes between worker nodes if worker nodes share a common L2 network segment.
      - bool
      - ``false``
    * - azure.enabled
@@ -31,11 +31,11 @@
      - bool
      - ``false``
    * - bpf.lbMapMax
-     - Configure the maximum number of entries in the TCP connection tracking table. ctTcpMax: '524288' -- Configure the maximum number of entries for the non-TCP connection tracking table. ctAnyMax: '262144' -- Configure the maximum number of service entries in the load balancer maps.
+     - Configure the maximum number of service entries in the load balancer maps.
      - int
      - ``65536``
    * - bpf.monitorAggregation
-     - Configure auto-sizing for all BPF maps based on available memory. ref: https://docs.cilium.io/en/v1.9/concepts/ebpf/maps/#ebpf-maps -- Configure the level of aggregation for monitor notifications. Valid options are none, low, medium, maximum
+     - Configure the level of aggregation for monitor notifications. Valid options are none, low, medium, maximum
      - string
      - ``"medium"``
    * - bpf.monitorFlags
@@ -47,7 +47,7 @@
      - string
      - ``"5s"``
    * - bpf.policyMapMax
-     - Configure the maximum number of entries for the NAT table. natMax: 524288 -- Configure the maximum number of entries for the neighbor table. neighMax: 524288 -- Configure the maximum number of entries in endpoint policy map. (per endpoint)
+     - Configure the maximum number of entries in endpoint policy map. (per endpoint)
      - int
      - ``16384``
    * - bpf.preallocateMaps
@@ -195,7 +195,7 @@
      - string
      - ``"/etc/cni/net.d"``
    * - cni.configMapKey
-     - Specify the path to a CNI config to read from on agent start. This can be useful if you want to manage your CNI configuration outside of a Kubernetes environment. This parameter is mutually exclusive with the 'cni.configMap' parameter. readCniConf: /host/etc/cni/net.d/05-cilium.conf -- When defined, configMap will mount the provided value as ConfigMap and interpret the cniConf variable as CNI configuration file and write it when the agent starts up configMap: cni-configuration -- Configure the key in the CNI ConfigMap to read the contents of the CNI configuration from.
+     - Configure the key in the CNI ConfigMap to read the contents of the CNI configuration from.
      - string
      - ``"cni-config"``
    * - cni.customConf
@@ -211,7 +211,7 @@
      - bool
      - ``true``
    * - containerRuntime
-     - Configure how frequently garbage collection should occur for the datapath connection tracking table. conntrackGCInterval: "0s" -- Configure container runtime specific integration.
+     - Configure container runtime specific integration.
      - object
      - ``{"integration":"none"}``
    * - containerRuntime.integration
@@ -223,7 +223,7 @@
      - string
      - ``"/var/run/cilium"``
    * - datapathMode
-     - 
+     - Configure which datapath mode should be used for configuring container connectivity. Valid options are "veth" or "ipvlan".
      - string
      - ``"veth"``
    * - debug.enabled
@@ -239,7 +239,7 @@
      - bool
      - ``true``
    * - enableXTSocketFallback
-     - 
+     - Enables the fallback compatibility solution for when the xt_socket kernel module is missing and it is needed for the datapath L7 redirection to work properly. See documentation for details on when this can be disabled: http://docs.cilium.io/en/stable/install/system_requirements/#admin-kernel-version.
      - bool
      - ``true``
    * - encryption.enabled
@@ -447,7 +447,7 @@
      - string
      - ``":4244"``
    * - hubble.metrics
-     - Buffer size of the channel Hubble uses to receive monitor events. If this value is not set, the queue size is set to the default monitor queue size. eventQueueSize: "" -- Number of recent flows for Hubble to cache. Defaults to 4095. Possible values are:   1, 3, 7, 15, 31, 63, 127, 255, 511, 1023,   2047, 4095, 8191, 16383, 32767, 65535 eventBufferCapacity: "4095" -- Hubble metrics configuration. See https://docs.cilium.io/en/stable/configuration/metrics/#hubble-metrics for more comprehensive documentation about Hubble metrics.
+     - Hubble metrics configuration. See https://docs.cilium.io/en/stable/configuration/metrics/#hubble-metrics for more comprehensive documentation about Hubble metrics.
      - object
      - ``{"enabled":null,"port":9091,"serviceMonitor":{"enabled":false}}``
    * - hubble.metrics.enabled
@@ -663,7 +663,7 @@
      - string
      - ``nil``
    * - installIptablesRules
-     - 
+     - Configure whether to install iptables rules to allow for TPROXY (L7 proxy injection), iptables-based masquerading and compatibility with kube-proxy.
      - bool
      - ``true``
    * - ipMasqAgent
@@ -707,7 +707,7 @@
      - object
      - ``{}``
    * - keepDeprecatedLabels
-     - requireIPv6PodCIDR enables waiting for Kubernetes to provide the PodCIDR range via the Kubernetes node resource requireIPv6PodCIDR: false -- Keep the deprecated selector labels when deploying Cilium DaemonSet
+     - Keep the deprecated selector labels when deploying Cilium DaemonSet
      - bool
      - ``false``
    * - keepDeprecatedProbes
@@ -731,19 +731,19 @@
      - bool
      - ``false``
    * - logSystemLoad
-     - 
+     - Enables periodic logging of system load
      - bool
      - ``false``
    * - maglev
      - Configure maglev consistent hashing
      - object
      - ``{}``
    * - masquerade
-     - hashSeed is the cluster-wide base64 encoded seed for the hashing hashSeed: -- Enables masquerading of traffic leaving the node for destinations outside of the cluster.
+     - Enables masquerading of traffic leaving the node for destinations outside of the cluster.
      - bool
      - ``true``
    * - monitor
-     - Specify the CIDR for native routing (ie to avoid IP masquerade for). This value corresponds to the configured cluster-cidr. nativeRoutingCIDR: -- Configure cilium-monitor sidecar
+     - Configure cilium-monitor sidecar
      - object
      - ``{"enabled":false}``
    * - name
@@ -759,7 +759,7 @@
      - bool
      - ``true``
    * - nodePort.bindProtection
-     - Port range to use for NodePort services. range: "30000,32767" -- Set to true to prevent applications binding to service ports.
+     - Set to true to prevent applications binding to service ports.
      - bool
      - ``true``
    * - nodePort.enableHealthCheck
@@ -947,7 +947,7 @@
      - object
      - ``{}``
    * - policyEnforcementMode
-     - 
+     - The agent can be put into one of the three policy enforcement modes: default, always and never. ref: https://docs.cilium.io/en/stable/policy/intro/#policy-enforcement-modes
      - string
      - ``"default"``
    * - pprof.enabled
@@ -1079,21 +1079,17 @@
      - object
      - ``{"annotations":{},"create":true}``
    * - sleepAfterInit
-     - 
+     - Do not run Cilium agent when running with clean mode. Useful to completely uninstall Cilium as it will stop Cilium from starting and create artifacts in the node.
      - bool
      - ``false``
    * - sockops
      - Configure BPF socket operations configuration
      - object
      - ``{"enabled":false}``
-   * - tls.enabled
-     - 
-     - bool
-     - ``true``
-   * - tls.secretsBackend
-     - 
-     - string
-     - ``"local"``
+   * - tls
+     - Configure TLS configuration in the agent.
+     - object
+     - ``{"enabled":true,"secretsBackend":"local"}``
    * - tolerations
      - Node tolerations for agent scheduling to nodes with taints ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
      - list

diff --git a/Documentation/spelling_wordlist.txt b/Documentation/spelling_wordlist.txt
@@ -290,6 +290,7 @@ dev
 devel
 dialTimeout
 diff
+disableEndpointCRD
 disableEnvoyVersionCheck
 disableIptablesFeederRules
 disassembly
@@ -755,6 +756,7 @@ sha
 sidecarImageRegex
 sig
 skb
+skipCRDCreation
 skipteardown
 sleepAfterInit
 snat
@@ -898,6 +900,7 @@ xfrm
 xml
 xor
 xoring
+xt
 xwing
 xxxxx
 yaml

diff --git a/Makefile.defs b/Makefile.defs
@@ -162,6 +162,6 @@ ifeq ($(BASE_IMAGE),)
     BASE_IMAGE=scratch
 endif
 
-HELM_DOCS_VERSION ?= "v1.3.0"
-HELM_DOCS_SHA ?= "12f065115654c9a1d6819b938487d327f1fdb5c32bdc2a5c74afef22ed68f5ca"
-HELM_DOCS_IMAGE ?= "docker.io/jnorwood/helm-docs:$(HELM_DOCS_VERSION)@sha256:$(HELM_DOCS_SHA)"
+HELM_DOCS_VERSION ?= "5ddabba"
+HELM_DOCS_SHA ?= "c4a91daac6bf9c181fac79e09712fcf1f9102fcab1bbacbc733883965f5fd244"
+HELM_DOCS_IMAGE ?= "docker.io/bmcustodio/helm-docs:$(HELM_DOCS_VERSION)@sha256:$(HELM_DOCS_SHA)"