Add yamllint workflow

Signed-off-by: smoshiur1237 <moshiur.rahman@est.tech>

Author: smoshiur1237

.github/workflows/yamllint.yaml

@@ -0,0 +1,15 @@
+name: yamllint
+
+permissions:
+  contents: read
+
+on:
+  pull_request:
+    types: [ opened, edited, reopened, synchronize, ready_for_review ]
+
+jobs:
+  yamllint-check:
+    name: yaml-lint
+    uses: metal3-io/project-infra/.github/workflows/yamllint.yaml@main
+    with:
+      ref: ${{ github.event.pull_request.head.sha }}

.yamllint.yaml

@@ -0,0 +1,14 @@
+yaml-files:
+- '*.yaml'
+- '*.yml'
+- '.yamllint'
+
+rules:
+  trailing-spaces: enable
+  key-duplicates: enable
+  indentation:
+    spaces: 2
+    indent-sequences: false # Enforce k8s-style indentation
+    check-multi-line-strings: false
+  truthy:
+    allowed-values: [ 'true', 'false', 'yes', 'no', 'on' ]

_config.yml

@@ -16,11 +16,11 @@
 title: Metal³ - Metal Kubed
 email: non@none.com
 description: >- # this means to ignore newlines until "baseurl:"
-   Metal3.io aims to build on baremetal host provisioning technologies to provide a Kubernetes native API for managing bare metal hosts via a provisioning stack that is also running on Kubernetes.
+  Metal3.io aims to build on baremetal host provisioning technologies to provide a Kubernetes native API for managing bare metal hosts via a provisioning stack that is also running on Kubernetes.
 baseurl: "" # the subpath of your site, e.g. /blog
 url: "https://metal3.io" # the base hostname & protocol for your site, e.g. http://example.com
 twitter_username: metal3_io
-github_username:  metal3-io
+github_username: metal3-io
 type: website
 image: /assets/images/metal3logo.png
 
@@ -39,11 +39,11 @@ kramdown:
       start_line: 1
 theme: minima
 plugins:
-  - premonition
-  - jekyll-feed
-  - jekyll-paginate
-  - jekyll-redirect-from
-  - jekyll-sitemap
+- premonition
+- jekyll-feed
+- jekyll-paginate
+- jekyll-redirect-from
+- jekyll-sitemap
 
 paginate: 5
 paginate_path: "/blog/page:num"
@@ -55,12 +55,10 @@ collections:
     output: true
     permalink: /:collection/:path
 
-
 sass:
   sass_dir: _sass
   style: compressed
 
-
 # Exclude from processing.
 # The following items will not be processed, by default. Create a custom list
 # to override the default setting.
@@ -74,8 +72,8 @@ sass:
 #   - vendor/ruby/
 
 exclude:
-  - GUIDELINES.md
-  - README.md
-  - node_modules
+- GUIDELINES.md
+- README.md
+- node_modules
 
 permalink: /blog/:year/:month/:day/:title:output_ext

_posts/2019-06-25-Metal3.md

@@ -33,11 +33,11 @@ spec:
   group: stable.example.com
   # list of versions supported by this CustomResourceDefinition
   versions:
-    - name: v1
-      # Each version can be enabled/disabled by Served flag.
-      served: true
-      # One and only one version must be marked as the storage version.
-      storage: true
+  - name: v1
+    # Each version can be enabled/disabled by Served flag.
+    served: true
+    # One and only one version must be marked as the storage version.
+    storage: true
   # either Namespaced or Cluster
   scope: Namespaced
   names:
@@ -49,7 +49,7 @@ spec:
     kind: CronTab
     # shortNames allow shorter string to match your resource on the CLI
     shortNames:
-      - ct
+    - ct
   preserveUnknownFields: false
   validation:
     openAPIV3Schema:
@@ -81,7 +81,7 @@ and if it is different from the desired status, it fixes it (reconciliation).
 This is why k8s is 'declarative', you specify the object desired status instead
 'how to do it' (imperative).
 
-Again, there are tons of documentation (and [examples](https://github.com/kubernetes/sample-controller)) around the [controller](https://engineering.bitnami.com/articles/a-deep-dive-into-kubernetes-controllers.html) pattern which is
+Again, there are tons of documentation (and [examples](https://github.com/kubernetes/sample-controller)) around the controller pattern which is
 basically the k8s roots, so I'll let your google-foo take care of it :)
 
 ## Operator

_posts/2020-06-18-Metal3-dev-env-BareMetal-Cluster-Deployment.md

@@ -175,7 +175,7 @@ kubectl describe Cluster ${CLUSTER_NAME} -n metal3
 ```yaml
 apiVersion: cluster.x-k8s.io/v1alpha3
 kind: Cluster
-metadata: [......]
+metadata: #[....]
 spec:
   clusterNetwork:
     pods:
@@ -225,8 +225,7 @@ kubectl describe KubeadmControlPlane ${CLUSTER_NAME} -n metal3
 ```yaml
 apiVersion: controlplane.cluster.x-k8s.io/v1alpha3
 kind: KubeadmControlPlane
-metadata:
-  [....]
+metadata: #[....]
   ownerReferences:
   - apiVersion: cluster.x-k8s.io/v1alpha3
     blockOwnerDeletion: true
@@ -245,8 +244,7 @@ spec:
     namespace: metal3
   kubeadmConfigSpec:
     files:
-    - content: |
-        [....]
+    - content: #[....]
   replicas: 1
   version: v1.18.0
 status:
@@ -334,8 +332,7 @@ kubectl describe MachineDeployment ${CLUSTER_NAME} -n metal3
 ```yaml
 apiVersion: cluster.x-k8s.io/v1alpha3
 kind: MachineDeployment
-metadata:
-  [....]
+metadata: #[....]
   ownerReferences:
   - apiVersion: cluster.x-k8s.io/v1alpha3
     kind: Cluster

_posts/2020-07-06-IP_address_manager.md

@@ -70,12 +70,12 @@ metadata:
 spec:
   clusterName: cluster1
   pools:
-    - start: 192.168.0.10
-      end: 192.168.0.30
-      prefix: 25
-      gateway: 192.168.0.1
-    - subnet: 192.168.1.1/26
-    - subnet: 192.168.1.128/25
+  - start: 192.168.0.10
+    end: 192.168.0.30
+    prefix: 25
+    gateway: 192.168.0.1
+  - subnet: 192.168.1.1/26
+  - subnet: 192.168.1.128/25
   prefix: 24
   gateway: 192.168.1.1
   preAllocations:
@@ -92,11 +92,11 @@ metadata:
 spec:
   clusterName: cluster1
   pools:
-    - start: 2001:0db8:85a3:0000:0000:8a2e::10
-      end: 2001:0db8:85a3:0000:0000:8a2e:ffff:fff0
-      prefix: 96
-      gateway: 12001:0db8:85a3:0000:0000:8a2e::1
-    - subnet: 2001:0db8:85a3:0000:0000:8a2d::/96
+  - start: 2001:0db8:85a3:0000:0000:8a2e::10
+    end: 2001:0db8:85a3:0000:0000:8a2e:ffff:fff0
+    prefix: 96
+    gateway: 12001:0db8:85a3:0000:0000:8a2e::1
+  - subnet: 2001:0db8:85a3:0000:0000:8a2d::/96
   prefix: 96
   gateway: 2001:0db8:85a3:0000:0000:8a2d::1
 ```
@@ -152,12 +152,12 @@ metadata:
 spec:
   clusterName: cluster1
   pools:
-    - start: 192.168.0.10
-      end: 192.168.0.30
-      prefix: 25
-      gateway: 192.168.0.1
-    - subnet: 192.168.1.1/26
-    - subnet: 192.168.1.128/25
+  - start: 192.168.0.10
+    end: 192.168.0.30
+    prefix: 25
+    gateway: 192.168.0.1
+  - subnet: 192.168.1.1/26
+  - subnet: 192.168.1.128/25
   prefix: 24
   gateway: 192.168.1.1
   preAllocations: