add kube-linter (#1190)

.kube-linter.yaml

@@ -0,0 +1,10 @@
+
+# Details on checks can be found on this page and the like: https://docs.kubelinter.io/#/generated/checks
+checks:
+  addAllBuiltIn: true
+  exclude:
+    - "unset-cpu-requirements" # Not every pod requires this, for example hooks, we can change opinion later
+    - "unset-memory-requirements" # Not every pod requires this, for example hooks, we can change opinion later
+    - "no-read-only-root-fs" # Some volume mounts require writes
+    - "required-annotation-email" # Not a requirement for out deployments
+    - "no-node-affinity" # Not every pod requires this

charts/redpanda/chart_test.go

@@ -1,7 +1,9 @@
 package redpanda_test
 
 import (
+	"bytes"
 	"os"
+	"os/exec"
 	"testing"
 
 	"github.com/redpanda-data/helm-charts/charts/redpanda"
@@ -123,6 +125,25 @@ func TestTemplate(t *testing.T) {
 			})
 			require.NoError(t, err)
 
+			// kube-lint template file
+			var stdout bytes.Buffer
+			var stderr bytes.Buffer
+			inputYaml := bytes.NewBuffer(out)
+
+			cmd := exec.CommandContext(ctx, "kube-linter", "lint", "-", "--format", "json")
+			cmd.Stdin = inputYaml
+			cmd.Stdout = &stdout
+			cmd.Stderr = &stderr
+
+			errKubeLinter := cmd.Run()
+			if errKubeLinter != nil && len(stderr.String()) > 0 {
+				t.Logf("kube-linter error(s) found for %q: \n%s\nstderr:\n%s", v.Name(), stdout.String(), stderr.String())
+			} else if errKubeLinter != nil {
+				t.Logf("kube-linter error(s) found for %q: \n%s", v.Name(), errKubeLinter)
+			}
+			// TODO: remove comment below and the logging above once we agree to linter
+			//require.NoError(t, errKubeLinter)
+
 			testutil.AssertGolden(t, testutil.YAML, "./testdata/"+v.Name()+".golden", out)
 		})
 	}

flake.nix

@@ -90,6 +90,7 @@
               pkgs.kubectl
               pkgs.kubernetes-helm
               pkgs.kustomize
+              pkgs.kube-linter
               pkgs.yq # jq but for YAML
             ];
           };