From 122645e7129470789391d742ce49f545c40f521f Mon Sep 17 00:00:00 2001 From: Matthew Emes Date: Thu, 12 Sep 2024 13:04:07 -0700 Subject: [PATCH] chore: Add yamllint configuration Switch to .yamllint.yml configuration and remove individual rule overrides for line-length. Some 'truthy' rules are suppressed still but will be dealt with on a role by role basis. --- .github/workflows/pre-commit.yml | 1 - .yamllint.yml | 7 +++++++ ansible/calico.yml | 2 +- ansible/cilium.yml | 2 +- ansible/kubernetes.yml | 2 +- ansible/longhorn.yml | 2 +- inventory/group_vars/servers.yaml | 1 - kubernetes.yml | 1 - provision/boot.yaml | 1 - provision/repave.yaml | 1 - provision/shutdown.yaml | 1 - roles/cilium/tasks/main.yml | 1 - roles/crio/tasks/centos.yml | 1 - roles/crio/tasks/debian.yml | 1 - roles/crio/tasks/main.yml | 1 - roles/crio/vars/main.yml | 1 - roles/kubeadm/tasks/debian.yml | 1 - roles/kubeadm/tasks/init.yml | 1 - roles/kubeadm/tasks/rhel.yml | 1 - roles/kubeadm/vars/main.yml | 1 - roles/networking/tasks/main.yml | 1 - roles/shared/tasks/main.yml | 1 - roles/vault/tasks/main.yml | 1 - shared.yml | 2 +- 24 files changed, 12 insertions(+), 23 deletions(-) create mode 100644 .yamllint.yml diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml index c2d5d33..c255a13 100644 --- a/.github/workflows/pre-commit.yml +++ b/.github/workflows/pre-commit.yml @@ -1,5 +1,4 @@ # These github actions will perform linting using pre-commit. -# yamllint disable rule:line-length # spell-checker: disable --- name: pre-commit diff --git a/.yamllint.yml b/.yamllint.yml new file mode 100644 index 0000000..15a72c1 --- /dev/null +++ b/.yamllint.yml @@ -0,0 +1,7 @@ +--- +extends: default + +rules: + line-length: + max: 120 + level: warning diff --git a/ansible/calico.yml b/ansible/calico.yml index cfa4bff..114247b 100644 --- a/ansible/calico.yml +++ b/ansible/calico.yml @@ -1,5 +1,5 @@ # Install Calico as CNI -# yamllint disable rule:truthy rule:line-length +# yamllint disable rule:truthy --- - name: Prepare all hosts for kubernetes hosts: servers diff --git a/ansible/cilium.yml b/ansible/cilium.yml index f68d00a..b082eda 100644 --- a/ansible/cilium.yml +++ b/ansible/cilium.yml @@ -1,5 +1,5 @@ # Install Cilium as CNI -# yamllint disable rule:truthy rule:line-length +# yamllint disable rule:truthy --- - name: Gather facts hosts: servers diff --git a/ansible/kubernetes.yml b/ansible/kubernetes.yml index f8b1483..c12f176 100644 --- a/ansible/kubernetes.yml +++ b/ansible/kubernetes.yml @@ -1,5 +1,5 @@ # Install kubernetes on hosts -# yamllint disable rule:truthy rule:line-length +# yamllint disable rule:truthy --- - name: Prepare all hosts for kubernetes hosts: servers diff --git a/ansible/longhorn.yml b/ansible/longhorn.yml index ba7b765..0731a14 100644 --- a/ansible/longhorn.yml +++ b/ansible/longhorn.yml @@ -1,5 +1,5 @@ # Install kubernetes on hosts -# yamllint disable rule:truthy rule:line-length +# yamllint disable rule:truthy --- - name: Prepare all hosts for longhorn hosts: servers diff --git a/inventory/group_vars/servers.yaml b/inventory/group_vars/servers.yaml index 83d788a..25e1771 100644 --- a/inventory/group_vars/servers.yaml +++ b/inventory/group_vars/servers.yaml @@ -1,4 +1,3 @@ # Configure the hosts that are part of the servers group -# yamllint disable rule:line-length --- ansible_ssh_extra_args: '-o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no' diff --git a/kubernetes.yml b/kubernetes.yml index 6b44681..28532e1 100644 --- a/kubernetes.yml +++ b/kubernetes.yml @@ -1,5 +1,4 @@ # Provision kubernetes on bare metal hosts -# yamllint disable rule:line-length --- - name: Prepare requirements and install Kubernetes on bare-metal hosts hosts: servers diff --git a/provision/boot.yaml b/provision/boot.yaml index 5101eec..abebf27 100644 --- a/provision/boot.yaml +++ b/provision/boot.yaml @@ -1,5 +1,4 @@ # (Re-)boot the lab servers -# yamllint disable rule:line-length --- - name: (Re-)boot servers hosts: servers diff --git a/provision/repave.yaml b/provision/repave.yaml index 2c2cb5b..af98c1d 100644 --- a/provision/repave.yaml +++ b/provision/repave.yaml @@ -1,5 +1,4 @@ # Playbook to repave servers via PXE -# yamllint disable rule:line-length --- - name: Prepare for server repave from PXE hosts: shared diff --git a/provision/shutdown.yaml b/provision/shutdown.yaml index 819b64c..eb7d001 100644 --- a/provision/shutdown.yaml +++ b/provision/shutdown.yaml @@ -1,5 +1,4 @@ # Shutdown the lab servers -# yamllint disable rule:line-length --- - name: Power off servers hosts: servers diff --git a/roles/cilium/tasks/main.yml b/roles/cilium/tasks/main.yml index 75eff81..972d4d3 100644 --- a/roles/cilium/tasks/main.yml +++ b/roles/cilium/tasks/main.yml @@ -1,5 +1,4 @@ # Install Cilium as CNI -# yamllint disable rule:line-length --- - set_fact: lb_cidr_pool: "{{ lb_cidr_pool | default([]) + [{'cidr': item}] }}" diff --git a/roles/crio/tasks/centos.yml b/roles/crio/tasks/centos.yml index 63bf11f..3f4f790 100644 --- a/roles/crio/tasks/centos.yml +++ b/roles/crio/tasks/centos.yml @@ -1,5 +1,4 @@ # Perform CentOS specific tasks for CRI-O -# yamllint disable rule:line-length --- - name: Add CentOS CRI-O package repo ansible.builtin.get_url: diff --git a/roles/crio/tasks/debian.yml b/roles/crio/tasks/debian.yml index 6bdfe9f..a19b6b5 100644 --- a/roles/crio/tasks/debian.yml +++ b/roles/crio/tasks/debian.yml @@ -1,5 +1,4 @@ # Perform Debian specific tasks for CRI-O -# yamllint disable rule:line-length --- - name: Fetch repo key for CRI-O apt packages ansible.builtin.get_url: diff --git a/roles/crio/tasks/main.yml b/roles/crio/tasks/main.yml index e33ff65..1cc0b44 100644 --- a/roles/crio/tasks/main.yml +++ b/roles/crio/tasks/main.yml @@ -1,5 +1,4 @@ # Install CRI-O runtime -# yamllint disable rule:line-length --- - name: Configure persistent modules for CRI-O ansible.builtin.template: diff --git a/roles/crio/vars/main.yml b/roles/crio/vars/main.yml index a8ae72a..90335da 100644 --- a/roles/crio/vars/main.yml +++ b/roles/crio/vars/main.yml @@ -1,4 +1,3 @@ -# yamllint disable rule:line-length --- required_modules: - overlay diff --git a/roles/kubeadm/tasks/debian.yml b/roles/kubeadm/tasks/debian.yml index d9232e4..0f2a469 100644 --- a/roles/kubeadm/tasks/debian.yml +++ b/roles/kubeadm/tasks/debian.yml @@ -1,5 +1,4 @@ # Perform Debian/Ubuntu specific tasks common to all hosts -# yamllint disable rule:line-length --- - name: Fetch repo key for kubernetes apt packages ansible.builtin.get_url: diff --git a/roles/kubeadm/tasks/init.yml b/roles/kubeadm/tasks/init.yml index e4521c7..470ae92 100644 --- a/roles/kubeadm/tasks/init.yml +++ b/roles/kubeadm/tasks/init.yml @@ -1,4 +1,3 @@ -# yamllint disable rule:line-length --- - name: Generate kubeadm token ansible.builtin.command: kubeadm token generate diff --git a/roles/kubeadm/tasks/rhel.yml b/roles/kubeadm/tasks/rhel.yml index 7eb0dab..852fd23 100644 --- a/roles/kubeadm/tasks/rhel.yml +++ b/roles/kubeadm/tasks/rhel.yml @@ -1,5 +1,4 @@ # Perform CentOS/RHEL specific tasks common to all hosts -# yamllint disable rule:line-length --- - name: Add Kubernetes yum repo ansible.builtin.yum_repository: diff --git a/roles/kubeadm/vars/main.yml b/roles/kubeadm/vars/main.yml index 7bf815a..ad8aaa6 100644 --- a/roles/kubeadm/vars/main.yml +++ b/roles/kubeadm/vars/main.yml @@ -1,4 +1,3 @@ -# yamllint disable rule:line-length --- cgroup_driver: systemd ipv4_extra_args: "{{ {'node-cidr-mask-size-ipv4': ipv4_node_mask | string} if (pod_cidrs | ansible.utils.ipv4 | length > 0) else {} }}" diff --git a/roles/networking/tasks/main.yml b/roles/networking/tasks/main.yml index da2caac..3535f09 100644 --- a/roles/networking/tasks/main.yml +++ b/roles/networking/tasks/main.yml @@ -1,5 +1,4 @@ # Setup static vlan configurations post-deployment -# yamllint disable rule:line-length --- - name: Configure VLANs on Ubuntu ansible.builtin.template: diff --git a/roles/shared/tasks/main.yml b/roles/shared/tasks/main.yml index 73ac281..a4ce46f 100644 --- a/roles/shared/tasks/main.yml +++ b/roles/shared/tasks/main.yml @@ -1,5 +1,4 @@ # Update shared server -# yamllint disable rule:line-length --- - name: Install required packages ansible.builtin.package: diff --git a/roles/vault/tasks/main.yml b/roles/vault/tasks/main.yml index 257311c..6352f4d 100644 --- a/roles/vault/tasks/main.yml +++ b/roles/vault/tasks/main.yml @@ -1,5 +1,4 @@ # Manage Vault service -# yamllint disable rule:line-length --- - name: Copy static hashicorp key ansible.builtin.copy: diff --git a/shared.yml b/shared.yml index 57ff8e5..2c6ecf2 100644 --- a/shared.yml +++ b/shared.yml @@ -1,7 +1,7 @@ # Update shared server playbook # In my lab, the shared group hosts both shared file services and vault services # code: language=ansible -# yamllint disable rule:truthy rule:line-length +# yamllint disable rule:truthy --- - name: Update shared services and files hosts: shared