[Maintenance] Add & Enable YAML Linter (#1251)

Author: ajanikow

.golangci.yaml

@@ -1,5 +1,3 @@
----
-
 run:
   issues-exit-code: 3
   timeout: 30m
@@ -8,21 +6,19 @@ run:
     - .gobuild
     - deps
     - tools
-
 linters:
   disable-all: true
   enable:
-    - gosimple 
-    - govet 
-    - ineffassign 
+    - gosimple
+    - govet
+    - ineffassign
     - staticcheck
-    - typecheck 
-    - unconvert 
-    - unparam 
+    - typecheck
+    - unconvert
+    - unparam
     - unused
     - importas
     - gci
-
 linters-settings:
   importas:
     no-unaliased: true

CHANGELOG.md

@@ -11,6 +11,7 @@
 - (Improvement) Reduce CI on Commit Travis runs
 - (Maintenance) Add license range rewrite command
 - (Feature) Optional Action
+- (Maintenance) Add & Enable YAML Linter
 
 ## [1.2.24](https://github.com/arangodb/kube-arangodb/tree/1.2.24) (2023-01-25)
 - (Bugfix) Fix deployment creation on ARM64

Makefile

@@ -198,6 +198,12 @@ EXCLUDE_DIRS := vendor .gobuild deps tools pkg/generated/clientset pkg/generated
 EXCLUDE_FILES := *generated.deepcopy.go
 SOURCES_QUERY := find ./ -type f -name '*.go' ! -name '*.pb.go' $(foreach EXCLUDE_DIR,$(EXCLUDE_DIRS), ! -path "*/$(EXCLUDE_DIR)/*") $(foreach EXCLUDE_FILE,$(EXCLUDE_FILES), ! -path "*/$(EXCLUDE_FILE)")
 SOURCES := $(shell $(SOURCES_QUERY))
+
+YAML_EXCLUDE_DIRS := vendor .gobuild deps tools pkg/generated/clientset pkg/generated/informers pkg/generated/listers chart/kube-arangodb/templates chart/kube-arangodb-crd/templates chart/arangodb-ingress-proxy/templates
+YAML_EXCLUDE_FILES :=
+YAML_QUERY := find ./ -type f -name '*.yaml' $(foreach EXCLUDE_DIR,$(YAML_EXCLUDE_DIRS), ! -path "*/$(EXCLUDE_DIR)/*") $(foreach EXCLUDE_FILE,$(YAML_EXCLUDE_FILES), ! -path "*/$(EXCLUDE_FILE)")
+YAMLS := $(shell $(YAML_QUERY))
+
 DASHBOARDSOURCES := $(shell find $(DASHBOARDDIR)/src -name '*.js') $(DASHBOARDDIR)/package.json
 LINT_EXCLUDES:=
 ifeq ($(RELEASE_MODE),enterprise)
@@ -242,6 +248,12 @@ fmt:
 	@$(GOPATH)/bin/goimports -w $(SOURCES)
 	@$(GOPATH)/bin/gci write -s "standard" -s "default" -s "prefix(github.com/arangodb)" -s "prefix(github.com/arangodb/kube-arangodb)" $(SOURCES) 
 
+.PHONY: yamlfmt
+yamlfmt:
+	@echo ">> Ensuring style of yaml files"
+	@$(GOPATH)/bin/yamlfmt -w $(YAMLS)
+	@$(GOPATH)/bin/yamlfmt -w $(YAMLS)
+
 .PHONY: license
 license:
 	@echo ">> Ensuring license of files"
@@ -507,6 +519,8 @@ tools-min: update-vendor
 	@GOBIN=$(GOPATH)/bin go install golang.org/x/tools/cmd/goimports@0bb7e5c47b1a31f85d4f173edc878a8e049764a5
 	@echo ">> Fetching license check"
 	@GOBIN=$(GOPATH)/bin go install github.com/google/addlicense@6d92264d717064f28b32464f0f9693a5b4ef0239
+	@echo ">> Fetching yamlfmt"
+	@GOBIN=$(GOPATH)/bin go install github.com/UltiRequiem/[email protected]
 
 .PHONY: tools
 tools: tools-min
@@ -599,7 +613,7 @@ check-community:
 	@$(MAKE) _check RELEASE_MODE=community
 
 _check:
-	@$(MAKE) fmt license-verify linter run-unit-tests bin
+	@$(MAKE) fmt yamlfmt license-verify linter run-unit-tests bin
 
 generate: generate-internal generate-proto fmt
 
@@ -613,4 +627,4 @@ generate-proto:
 			$(PROTOSOURCES)
 
 .PHONY: fix
-fix: license-range fmt license
+fix: license-range fmt license yamlfmt

chart/arangodb-ingress-proxy/values.yaml

@@ -1,5 +1,3 @@
----
-
 replicas: 2
 imagePullPolicy: Always
-image: nginx:1.16.1-alpine
+image: nginx:1.16.1-alpine

chart/kube-arangodb-crd/Chart.yaml

@@ -1,9 +1,5 @@
----
-
 name: kube-arangodb-crd
 version: 1.2.24
-
 description: "ArangoDB Kubernetes Custom Resource Definitions"
 tillerVersion: ">2.7"
-
-appVersion: 3.5.0
+appVersion: 3.5.0

chart/kube-arangodb/Chart.yaml

@@ -1,9 +1,5 @@
----
-
 name: kube-arangodb
 version: 1.2.24
-
 description: "ArangoDB Kubernetes Operator"
 tillerVersion: ">2.7"
-
-appVersion: 3.5.0
+appVersion: 3.5.0

chart/kube-arangodb/crds/member.yaml

@@ -1,7 +1,7 @@
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-    name: arangomembers.database.arangodb.com
+  name: arangomembers.database.arangodb.com
 spec:
   group: database.arangodb.com
   names:
@@ -30,4 +30,4 @@ spec:
       served: true
       storage: false
       subresources:
-        status: {}
+        status: {}

chart/kube-arangodb/values.yaml

@@ -1,65 +1,46 @@
----
-
 operator:
   image: arangodb/kube-arangodb:1.2.24
   imagePullPolicy: IfNotPresent
   imagePullSecrets: []
-
   scope: legacy
-  
   architectures:
-  - amd64
-
+    - amd64
   debug: false
-
   args: []
-
   service:
     type: ClusterIP
-
   annotations: {}
-
   resources:
     limits:
       cpu: 1
       memory: 256Mi
     requests:
       cpu: 250m
       memory: 256Mi
-
   securityContext:
     runAsUser: 1000
-
   replicaCount: 2
-
   updateStrategy:
     type: Recreate
-
   allowChaos: false
-
   nodeSelector: {}
-  
   enableCRDManagement: true
-
   features:
     deployment: true
     deploymentReplications: true
     storage: false
     backup: false
     apps: false
     k8sToK8sClusterSync: false
-
   images:
     base: alpine:3.11
     metricsExporter: arangodb/arangodb-exporter:0.1.7
     arango: arangodb/arangodb:latest
-
   tolerations: []
-
 rbac:
   enabled: true
   extensions:
     monitoring: true
     acs: true
     at: true
-    debug: false
+    debug: false

examples/arango-local-storage.yaml

@@ -7,4 +7,4 @@ spec:
     name: my-local-ssd
     isDefault: true
   localPath:
-  - /var/lib/arango-storage
+    - /var/lib/arango-storage

examples/arangojob.yaml

@@ -10,6 +10,6 @@ spec:
         containers:
           - name: pi
             image: perl
-            command: ["perl",  "-Mbignum=bpi", "-wle", "print bpi(2000)"]
+            command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
         restartPolicy: Never
-    backoffLimit: 4
+    backoffLimit: 4

examples/cluster1-with-sync.yaml

@@ -14,4 +14,3 @@ spec:
     externalAccess:
       type: LoadBalancer
       loadBalancerIP: 192.168.140.210
-

examples/cluster2-with-sync.yaml

@@ -14,4 +14,3 @@ spec:
     externalAccess:
       type: LoadBalancer
       loadBalancerIP: 192.168.140.211
-

examples/metrics/deployment-operator-servicemonitor.yaml

@@ -14,9 +14,9 @@ spec:
       app.kubernetes.io/name: kube-arangodb
   namespaceSelector:
     matchNames:
-    - default
+      - default
   endpoints:
-  - port: server
-    scheme: https
-    tlsConfig:
-      insecureSkipVerify: true
+    - port: server
+      scheme: https
+      tlsConfig:
+        insecureSkipVerify: true

examples/nodeport-cluster.yaml

@@ -9,7 +9,7 @@ spec:
   type: NodePort
   publishNotReadyAddresses: true
   ports:
-  - protocol: TCP
-    port: 8529
-    targetPort: 8529
-    nodePort: 31529
+    - protocol: TCP
+      port: 8529
+      targetPort: 8529
+      nodePort: 31529

examples/nodeport-single-server.yaml

@@ -8,7 +8,7 @@ spec:
     role: single
   type: NodePort
   ports:
-  - protocol: TCP
-    port: 8529
-    targetPort: 8529
-    nodePort: 30529
+    - protocol: TCP
+      port: 8529
+      targetPort: 8529
+      nodePort: 30529

examples/reboot-pod.yaml

@@ -29,17 +29,13 @@ spec:
           valueFrom:
             fieldRef:
               fieldPath: metadata.name
-
 ---
-
 apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: arango-deployment-operator-reboot
   namespace: default
-
 ---
-
 apiVersion: rbac.authorization.k8s.io/v1
 kind: Role
 metadata:
@@ -52,10 +48,7 @@ rules:
   - apiGroups: ["database.arangodb.com"]
     resources: ["arangodeployments"]
     verbs: ["*"]
-
-
 ---
-
 apiVersion: rbac.authorization.k8s.io/v1
 kind: RoleBinding
 metadata:
@@ -69,9 +62,7 @@ subjects:
   - kind: ServiceAccount
     name: arango-deployment-operator-reboot
     namespace: default
-
 ---
-
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
@@ -81,9 +72,7 @@ rules:
   - apiGroups: [""]
     resources: ["persistentvolumes"]
     verbs: ["*"]
-
 ---
-
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRoleBinding
 metadata:

examples/single-server-no-auth.yaml

@@ -6,4 +6,3 @@ spec:
   mode: Single
   auth:
     jwtSecretName: None
-

internal/actions.yaml

@@ -1,7 +1,4 @@
----
-
 default_timeout: 10m
-
 actions:
   PlaceHolder:
     description: Empty placeholder action
@@ -232,4 +229,4 @@ actions:
     description: Runs the Resource sync
   TimezoneSecretSet:
     description: Set timezone details in cluster
-    timeout: 30m
+    timeout: 30m

internal/metrics.yaml

@@ -1,8 +1,5 @@
----
-  
 documentation: docs/generated/metrics
 destination: pkg/generated/metric_descriptions
-
 namespaces:
   arangodb_operator:
     agency_cache: