Address review comments

Signed-off-by: Antonin Bas <abas@vmware.com>

.github/workflows/go.yml

@@ -224,6 +224,15 @@ jobs:
       run: |
         sudo npm install -g markdownlint-cli@0.31.1
         make markdownlint
+    - name: Checking whether autogenerated Helm chart documentation is up-to-date
+      working-directory: build/charts/
+      run: |
+        make helm-docs
+        DIFF=$(git diff .)
+        if [ -n "$DIFF" ]; then
+          echo "The Helm chart documentation is out-of-date; please run 'make helm-docs' in 'build/charts/' and commit the changes"
+          exit 1
+        fi
 
   benchmark:
     needs: check-changes

build/charts/antrea/README.md

@@ -60,7 +60,7 @@ Kubernetes: `>= 1.16.0-0`
 | controller.podAnnotations | object | `{}` | Annotations to be added to antrea-controller Pod. |
 | controller.podLabels | object | `{}` | Labels to be added to antrea-controller Pod. |
 | controller.priorityClassName | string | `"system-cluster-critical"` | Prority class to use for the antrea-controller Pod. |
-| controller.selfSigned | bool | `true` | Indicates whether to use auto-generated self-signed TLS certificates. If false, a Secret named "antrea-controller-tls" must be provided with the following keys: ca.crt, tls.crt, tls.key. |
+| controller.selfSignedCert | bool | `true` | Indicates whether to use auto-generated self-signed TLS certificates. If false, a Secret named "antrea-controller-tls" must be provided with the following keys: ca.crt, tls.crt, tls.key. |
 | controller.tolerations | list | `[{"key":"CriticalAddonsOnly","operator":"Exists"},{"effect":"NoSchedule","key":"node-role.kubernetes.io/master"}]` | Tolerations for the antrea-controller Pod. |
 | defaultMTU | int | `0` | Default MTU to use for the host gateway interface and the network interface of each Pod. By default, antrea-agent will discover the MTU of the Node's primary interface and adjust it to accommodate for tunnel encapsulation overhead if applicable. |
 | egress.exceptCIDRs | list | `[]` | CIDR ranges to which outbound Pod traffic will not be SNAT'd by Egresses. |

build/charts/antrea/conf/antrea-controller.conf

@@ -38,7 +38,7 @@ enablePrometheusMetrics: {{ .Values.controller.enablePrometheusMetrics }}
 #   ca.crt: <CA certificate>
 #   tls.crt: <TLS certificate>
 #   tls.key: <TLS private key>
-selfSignedCert: {{ .Values.controller.selfSigned }}
+selfSignedCert: {{ .Values.controller.selfSignedCert }}
 
 # Comma-separated list of Cipher Suites. If omitted, the default Go Cipher Suites will be used.
 # https://golang.org/pkg/crypto/tls/#pkg-constants

build/charts/antrea/templates/agent/daemonset.yaml

@@ -244,9 +244,6 @@ spec:
           args:
             - "--log_file_max_size={{ .Values.agent.antreaOVS.logFileMaxSize }}"
             - "--log_file_max_num={{ .Values.agent.antreaOVS.logFileMaxNum }}"
-            {{- if .Values.logVerbosity }}
-            - "--v={{ .Values.logVerbosity }}"
-            {{- end }}
             {{- if .Values.hwOffload }}
             - "--hw-offload"
             {{- end }}

build/charts/antrea/values.yaml

@@ -194,7 +194,7 @@ controller:
   # -- Indicates whether to use auto-generated self-signed TLS certificates. If
   # false, a Secret named "antrea-controller-tls" must be provided with the
   # following keys: ca.crt, tls.crt, tls.key.
-  selfSigned: true
+  selfSignedCert: true
   # -- Tolerations for the antrea-controller Pod.
   tolerations:
     # Mark it as a critical add-on.

hack/generate-manifest.sh

@@ -51,7 +51,7 @@ In 'release' mode, environment variables IMG_NAME and IMG_TAG must be set.
 
 In 'dev' mode, environment variable IMG_NAME can be set to use a custom image.
 
-This tool uses uses Helm 3 (https://helm.sh/) to generate manifests for Antrea. You can set the HELM
+This tool uses Helm 3 (https://helm.sh/) to generate manifests for Antrea. You can set the HELM
 environment variable to the path of the helm binary you want us to use. Otherwise we will download
 the appropriate version of the helm binary and use it (this is the recommended approach since
 different versions of helm may create different output YAMLs)."

hack/generate-standard-manifests.sh

@@ -30,10 +30,10 @@ In 'release' mode, environment variables IMG_NAME and IMG_TAG must be set.
 
 In 'dev' mode, environment variable IMG_NAME can be set to use a custom image.
 
-This tool uses uses Helm 3 (https://helm.sh/) to generate the \"standard\" manifests for
-Antrea. These are the manifests that are checked-in into the Antrea source tree, and that are
-uploaded as release assets for each new Antrea release. This script looks for all the Helm values
-YAML files under /build/yamls/chart-values/, and generates the corresponding manifest for each one.
+This tool uses Helm 3 (https://helm.sh/) to generate the \"standard\" manifests for Antrea. These
+are the manifests that are checked-in into the Antrea source tree, and that are uploaded as release
+assets for each new Antrea release. This script looks for all the Helm values YAML files under
+/build/yamls/chart-values/, and generates the corresponding manifest for each one.
 
 You can set the HELM environment variable to the path of the helm binary you wan t us to
 use. Otherwise we will download the appropriate version of the helm binary and use it (this is the
@@ -100,6 +100,10 @@ fi
 
 THIS_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 
+# Avoid potential Helm warnings about invalid permissions for Kubeconfig file.
+# The Kubeconfig does not matter for "helm template".
+unset KUBECONFIG
+
 source $THIS_DIR/verify-helm.sh
 
 if [ -z "$HELM" ]; then

hack/verify-helm.sh

@@ -20,7 +20,7 @@ _BINDIR="$THIS_DIR/.bin"
 # versions
 _HELM_VERSION="v3.8.1"
 
-# Ensure the helm tool exists and is the correct version, or installs it
+# Ensure the helm tool exists and is the correct version, or install it
 verify_helm() {
     # Check if there is already a helm binary in $_BINDIR and if yes, check if
     # the version matches the expected one.