chore: Enforce consistent yaml formatting (#1656)

Co-authored-by: Hisar Balik <[email protected]>
kyma-project · Dec 10, 2024 · 570d025 · 570d025
1 parent 502f50f
commit 570d025
Show file tree

Hide file tree

Showing 57 changed files with 1,764 additions and 2,574 deletions.
diff --git a/.yamlfmt b/.yamlfmt
@@ -0,0 +1,11 @@
+---
+include:
+- config
+exclude:
+- config/manager/kustomization.yaml
+formatter:
+  type: basic
+  indentless_arrays: true
+  include_document_start: true
+  retain_line_breaks: true
+  scan_folded_as_literal: true
diff --git a/Makefile b/Makefile
@@ -50,6 +50,7 @@ KUSTOMIZE        := $(TOOLS_BIN_DIR)/kustomize
 MOCKERY          := $(TOOLS_BIN_DIR)/mockery
 TABLE_GEN        := $(TOOLS_BIN_DIR)/table-gen
 YQ               := $(TOOLS_BIN_DIR)/yq
+YAMLFMT          := $(TOOLS_BIN_DIR)/yamlfmt
 STRINGER         := $(TOOLS_BIN_DIR)/stringer
 WSL				 := $(TOOLS_BIN_DIR)/wsl
 K3D              := $(TOOLS_BIN_DIR)/k3d
@@ -104,10 +105,12 @@ manifests: $(CONTROLLER_GEN) $(YQ) $(YAMLFMT) ## Generate WebhookConfiguration,
 	$(YQ) eval 'del(.. | select(has("x-kubernetes-validations"))."x-kubernetes-validations"[] | select(.rule|contains("otlp")) )' -i ./config/crd/bases/telemetry.kyma-project.io_logpipelines.yaml
 	## Remove empty x-kubernetes-validations arrays from logpipeline crd that can be caused by previous yq manipulations
 	$(YQ) eval 'del(.. | select(select(has("x-kubernetes-validations"))."x-kubernetes-validations" | length == 0)."x-kubernetes-validations")' -i ./config/crd/bases/telemetry.kyma-project.io_logpipelines.yaml
+	$(YAMLFMT)
 
 .PHONY: manifests-dev
-manifests-dev: $(CONTROLLER_GEN) ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition for v1alpha1 and v1beta1.
+manifests-dev: $(CONTROLLER_GEN) $(YAMLFMT) ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition for v1alpha1 and v1beta1.
 	$(CONTROLLER_GEN) rbac:roleName=manager-role webhook crd paths="./..." output:crd:artifacts:config=config/development/crd/bases
+	$(YAMLFMT)
 
 .PHONY: generate
 generate: $(CONTROLLER_GEN) $(MOCKERY) $(STRINGER) ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.

diff --git a/config/busola/kustomization.yaml b/config/busola/kustomization.yaml
@@ -1,3 +1,4 @@
+---
 resources:
 - logpipeline_busola_extension_cm.yaml
 - tracepipeline_busola_extension_cm.yaml

diff --git a/config/busola/logpipeline_busola_extension_cm.yaml b/config/busola/logpipeline_busola_extension_cm.yaml
@@ -1,3 +1,4 @@
+---
 apiVersion: v1
 kind: ConfigMap
 metadata:

diff --git a/config/busola/metricpipeline_busola_extension_cm.yaml b/config/busola/metricpipeline_busola_extension_cm.yaml
@@ -1,3 +1,4 @@
+---
 apiVersion: v1
 kind: ConfigMap
 metadata:

diff --git a/config/busola/telemetry_busola_extension_cm.yaml b/config/busola/telemetry_busola_extension_cm.yaml
@@ -1,3 +1,4 @@
+---
 apiVersion: v1
 kind: ConfigMap
 metadata:

diff --git a/config/busola/tracepipeline_busola_extension_cm.yaml b/config/busola/tracepipeline_busola_extension_cm.yaml
@@ -1,3 +1,4 @@
+---
 apiVersion: v1
 kind: ConfigMap
 metadata:

diff --git a/config/crd/bases/operator.kyma-project.io_telemetries.yaml b/config/crd/bases/operator.kyma-project.io_telemetries.yaml
@@ -55,25 +55,21 @@ spec:
                   gateway:
                     properties:
                       scaling:
-                        description: Scaling defines which strategy is used for scaling
-                          the gateway, with detailed configuration options for each
-                          strategy type.
+                        description: Scaling defines which strategy is used for scaling the gateway, with detailed configuration options for each strategy type.
                         properties:
                           static:
                             description: |-
                               Static is a scaling strategy enabling you to define a custom amount of replicas to be used for the gateway. Present only if Type =
                               StaticScalingStrategyType.
                             properties:
                               replicas:
-                                description: Replicas defines a static number of Pods
-                                  to run the gateway. Minimum is 1.
+                                description: Replicas defines a static number of Pods to run the gateway. Minimum is 1.
                                 format: int32
                                 minimum: 1
                                 type: integer
                             type: object
                           type:
-                            description: Type of scaling strategy. Default is none,
-                              using a fixed amount of replicas.
+                            description: Type of scaling strategy. Default is none, using a fixed amount of replicas.
                             enum:
                             - Static
                             type: string
@@ -86,25 +82,21 @@ spec:
                   gateway:
                     properties:
                       scaling:
-                        description: Scaling defines which strategy is used for scaling
-                          the gateway, with detailed configuration options for each
-                          strategy type.
+                        description: Scaling defines which strategy is used for scaling the gateway, with detailed configuration options for each strategy type.
                         properties:
                           static:
                             description: |-
                               Static is a scaling strategy enabling you to define a custom amount of replicas to be used for the gateway. Present only if Type =
                               StaticScalingStrategyType.
                             properties:
                               replicas:
-                                description: Replicas defines a static number of Pods
-                                  to run the gateway. Minimum is 1.
+                                description: Replicas defines a static number of Pods to run the gateway. Minimum is 1.
                                 format: int32
                                 minimum: 1
                                 type: integer
                             type: object
                           type:
-                            description: Type of scaling strategy. Default is none,
-                              using a fixed amount of replicas.
+                            description: Type of scaling strategy. Default is none, using a fixed amount of replicas.
                             enum:
                             - Static
                             type: string
@@ -117,25 +109,21 @@ spec:
                   gateway:
                     properties:
                       scaling:
-                        description: Scaling defines which strategy is used for scaling
-                          the gateway, with detailed configuration options for each
-                          strategy type.
+                        description: Scaling defines which strategy is used for scaling the gateway, with detailed configuration options for each strategy type.
                         properties:
                           static:
                             description: |-
                               Static is a scaling strategy enabling you to define a custom amount of replicas to be used for the gateway. Present only if Type =
                               StaticScalingStrategyType.
                             properties:
                               replicas:
-                                description: Replicas defines a static number of Pods
-                                  to run the gateway. Minimum is 1.
+                                description: Replicas defines a static number of Pods to run the gateway. Minimum is 1.
                                 format: int32
                                 minimum: 1
                                 type: integer
                             type: object
                           type:
-                            description: Type of scaling strategy. Default is none,
-                              using a fixed amount of replicas.
+                            description: Type of scaling strategy. Default is none, using a fixed amount of replicas.
                             enum:
                             - Static
                             type: string
@@ -151,8 +139,7 @@ spec:
                   Conditions contain a set of conditionals to determine the State of Status.
                   If all Conditions are met, State is expected to be in StateReady.
                 items:
-                  description: Condition contains details for one aspect of the current
-                    state of this API Resource.
+                  description: Condition contains details for one aspect of the current state of this API Resource.
                   properties:
                     lastTransitionTime:
                       description: |-
@@ -210,8 +197,7 @@ spec:
                 nullable: true
                 properties:
                   metrics:
-                    description: metrics contains the endpoints for metric gateway
-                      supporting OTLP.
+                    description: metrics contains the endpoints for metric gateway supporting OTLP.
                     properties:
                       grpc:
                         description: GRPC endpoint for OTLP.
@@ -221,8 +207,7 @@ spec:
                         type: string
                     type: object
                   traces:
-                    description: traces contains the endpoints for trace gateway supporting
-                      OTLP.
+                    description: traces contains the endpoints for trace gateway supporting OTLP.
                     properties:
                       grpc:
                         description: GRPC endpoint for OTLP.

diff --git a/config/crd/bases/telemetry.kyma-project.io_logparsers.yaml b/config/crd/bases/telemetry.kyma-project.io_logparsers.yaml
@@ -22,8 +22,7 @@ spec:
       name: Age
       type: date
     deprecated: true
-    deprecationWarning: The LogParser API is deprecated. Instead, log in JSON format
-      and use the JSON parsing feature of the LogPipeline
+    deprecationWarning: The LogParser API is deprecated. Instead, log in JSON format and use the JSON parsing feature of the LogPipeline
     name: v1alpha1
     schema:
       openAPIV3Schema:
@@ -50,11 +49,7 @@ spec:
             description: Defines the desired state of LogParser.
             properties:
               parser:
-                description: '[Fluent Bit Parsers](https://docs.fluentbit.io/manual/pipeline/parsers).
-                  The parser specified here has no effect until it is referenced by
-                  a [Pod annotation](https://docs.fluentbit.io/manual/pipeline/filters/kubernetes#kubernetes-annotations)
-                  on your workload or by a [Parser Filter](https://docs.fluentbit.io/manual/pipeline/filters/parser)
-                  defined in a pipeline''s filters section.'
+                description: '[Fluent Bit Parsers](https://docs.fluentbit.io/manual/pipeline/parsers). The parser specified here has no effect until it is referenced by a [Pod annotation](https://docs.fluentbit.io/manual/pipeline/filters/kubernetes#kubernetes-annotations) on your workload or by a [Parser Filter](https://docs.fluentbit.io/manual/pipeline/filters/parser) defined in a pipeline''s filters section.'
                 type: string
             type: object
           status:
@@ -63,8 +58,7 @@ spec:
               conditions:
                 description: An array of conditions describing the status of the parser.
                 items:
-                  description: Condition contains details for one aspect of the current
-                    state of this API Resource.
+                  description: Condition contains details for one aspect of the current state of this API Resource.
                   properties:
                     lastTransitionTime:
                       description: |-