Add linter for Markdown (#254)

Author: rdavid

.github/workflows/pre-main.yml

@@ -33,6 +33,9 @@ jobs:
         with:
           dockerfile: "Dockerfile*"
           recursive: true
+      - uses: nosborn/[email protected]
+        with:
+          files: .
       - uses: ludeeus/action-shellcheck@master
         env:
           SHELLCHECK_OPTS: --external-sources

README.md

@@ -1,6 +1,13 @@
-# CNF Certification Partner [![license](https://img.shields.io/github/license/test-network-function/cnf-certification-test-partner?color=blue&labelColor=gray&logo=apache&logoColor=lightgray&style=flat)](https://github.com/test-network-function/cnf-certification-test-partner/blob/master/LICENSE)
+<!-- markdownlint-disable line-length no-bare-urls -->
+# CNF Certification Partner
+
+[![tests](https://github.com/test-network-function/cnf-certification-test-partner/actions/workflows/pre-main.yml/badge.svg)](https://github.com/test-network-function/cnf-certification-test-partner/actions/workflows/pre-main.yml)
+[![red hat](https://img.shields.io/badge/red%20hat---?color=gray&logo=redhat&logoColor=red&style=flat)](https://www.redhat.com)
+[![openshift](https://img.shields.io/badge/openshift---?color=gray&logo=redhatopenshift&logoColor=red&style=flat)](https://www.redhat.com/en/technologies/cloud-computing/openshift)
+[![license](https://img.shields.io/github/license/test-network-function/cnf-certification-test-partner?color=blue&labelColor=gray&logo=apache&logoColor=lightgray&style=flat)](https://github.com/test-network-function/cnf-certification-test-partner/blob/master/LICENSE)
 
 This repository contains two main sections:
+
 * test-partner:  Partner debug pods definition for use on a k8s CNF Certification cluster. Used to run platform and networking tests.
 * test-target:  A trivial example CNF (including a replicaset/deployment, a CRD and an operator), primarily intended to be used to run [test-network-function](https://github.com/test-network-function/test-network-function) test suites on a development machine.
 
@@ -24,17 +31,21 @@ export TNF_EXAMPLE_CNF_NAMESPACE="tnf" #tnf for example
 ```
 
 ## On-demand vs always on debug pods
+
 By default debug pods are installed on demand when the tnf test suite is deployed. To deploy debug pods on all nodes in the cluster, configure the following environment variable:
+
 ```shell-script
 export ON_DEMAND_DEBUG_PODS=false
 ```
+
 ## Cloning the repository
 
 The repository can be cloned to local machine using:
 
 ```shell-script
 git clone [email protected]:test-network-function/cnf-certification-test-partner.git
 ```
+
 # Installing the partner pod
 
 In order to create and deploy the partner debug pods (daemonset), use the following:
@@ -43,21 +54,21 @@ In order to create and deploy the partner debug pods (daemonset), use the follow
 make install-partner-pods
 ```
 
-This will create a deployment named "partner" in the "default" namespace.  This Pod is the test partner for running CNF tests.
+This will create a deployment named "partner" in the "default" namespace. This Pod is the test partner for running CNF tests.
 For disconnected environments, override the default image repo `quay.io/testnetworkfunction` by setting the environment variable named `TNF_PARTNER_REPO` to the local repo.
 For environments with slow internet connection, override the default deployment timeout value (120s) by setting the environment variable named `TNF_DEPLOYMENT_TIMEOUT`.
 
 # Installing the Test-target
 
 Although any CNF Certification results should be generated using a proper CNF Certification cluster, there are times
-in which using a local emulator can greatly help with test development.  As such, [test-target](./test-target)
-provides a very simple PUT, OT, CRD, which satisfies the minimal requirements to perform test cases.
+in which using a local emulator can greatly help with test development. As such, [test-target](./test-target)
+provides a simple PUT, OT, CRD, which satisfies the minimal requirements to perform test cases.
 These can be used in conjunction with a local [kind](https://kind.sigs.k8s.io/) cluster to perform local test development.
 
-
 ## Dependencies
 
 In order to run the local test setup, the following dependencies are needed:
+
 * [vagrant](https://www.vagrantup.com/downloads)
 * [kind](https://kind.sigs.k8s.io/)
 * [Docker](https://docs.docker.com/get-docker/)
@@ -67,6 +78,7 @@ In order to run the local test setup, the following dependencies are needed:
 ## Setup with docker and kind
 
 Install the latest docker version ( https://docs.docker.com/engine/install/fedora ):
+
 ```shell-script
 sudo dnf config-manager \
     --add-repo \
@@ -88,7 +100,8 @@ sudo dnf -y install dnf-plugins-core
 sudo dnf install docker-ce docker-ce-cli containerd.io
 ```
 
-Perform the post install ( https://docs.docker.com/engine/install/linux-postinstall ) 
+Perform the post install ( https://docs.docker.com/engine/install/linux-postinstall ):
+
 ```shell-script
  sudo systemctl start docker.service
  sudo systemctl enable docker.service
@@ -97,7 +110,9 @@ Perform the post install ( https://docs.docker.com/engine/install/linux-postinst
  sudo usermod -aG docker $USER
  newgrp docker 
 ```
-Configure IPv6 in docker ( https://docs.docker.com/config/daemon/ipv6/ )
+
+Configure IPv6 in docker ( https://docs.docker.com/config/daemon/ipv6/ ):
+
 ```shell-script
 # update docker config
 sudo bash -c 'cat <<- EOF > /etc/docker/daemon.json
@@ -109,37 +124,43 @@ EOF'
 ```
 
 Enable IPv6 with:
+
 ```shell-script
 sudo sysctl -w net.ipv6.conf.all.disable_ipv6=0
 sudo sysctl -w net.ipv6.conf.default.disable_ipv6=0
 sudo sysctl -w net.ipv6.conf.lo.disable_ipv6=0
 ```
 
 to persist IPv6 support, edit or add the following lines in the /etc/sysctl.conf file
+
 ```shell-script
 net.ipv6.conf.all.disable_ipv6 = 0
 net.ipv6.conf.default.disable_ipv6 = 0
 net.ipv6.conf.lo.disable_ipv6 = 0
 ```
 
-disable firewall, if present, as multus interfaces will not be able to communicate. 
+disable firewall, if present, as multus interfaces will not be able to communicate.
+
+Note: if docker is already running after running the command below, also restart docker as taking the firewall down will remove the docker rules:
 
-Note: if docker is already running after running the command below, also restart docker as taking the firewall down will remove the docker rules
 ```shell-script
 sudo systemctl stop firewalld
 ```
 
-restart docker
+restart docker:
+
 ```shell-script
 sudo systemctl restart docker
 ```
 
 Download and install Kubernetes In Docker (Kind):
+
 ```shell-script
 curl -Lo kind https://github.com/kubernetes-sigs/kind/releases/download/v0.18.0/kind-linux-amd64
 ```
 
-Configure a cluster with 4 worker nodes and one master node ( dual stack ): 
+Configure a cluster with 4 worker nodes and one master node ( dual stack ):
+
 ```shell-script
 cat <<- EOF > config.yaml
 kind: Cluster
@@ -155,19 +176,22 @@ EOF
 kind create cluster --config=config.yaml
 ```
 
-Increase max files limit to prevent issue due to the large cluster size ( see https://kind.sigs.k8s.io/docs/user/known-issues/#pod-errors-due-to-too-many-open-files ) 
+Increase max files limit to prevent issue due to the large cluster size ( see https://kind.sigs.k8s.io/docs/user/known-issues/#pod-errors-due-to-too-many-open-files ):
+
 ```shell-script
 sudo sysctl fs.inotify.max_user_watches=524288
 sudo sysctl fs.inotify.max_user_instances=512
 ```
+
 To make the changes persistent, edit the file /etc/sysctl.conf and add these lines:
+
 ```shell-script
 fs.inotify.max_user_watches = 524288
 fs.inotify.max_user_instances = 512
-
 fs.inotify.max_user_watches = 524288
 fs.inotify.max_user_instances = 512
 ```
+
 ### Deploy both test target and test partner as a local-test-infra
 
 To create the resources, issue the following command:
@@ -182,13 +206,14 @@ will use this local infrastructure by default.
 
 Note that this command also creates OT and CRD resources.
 
-To verify `test` pods are running: 
+To verify `test` pods are running:
 
 ```shell-script
 oc get pods -n $TNF_EXAMPLE_CNF_NAMESPACE -o wide
 ```
 
 You should see something like this (note that the 2 test pods are running on different nodes due to a anti-affinity rule):
+
 ```shell-script
 $ oc get pods -ntnf -owide
 NAME                                                    READY   STATUS    RESTARTS   AGE
@@ -199,6 +224,7 @@ test-66f77bd94-2w4l8                                    1/1     Running   0
 test-66f77bd94-6kd6j                                    1/1     Running   0          85m
 
 ```
+
 ### Delete local-test-infra
 
 To tear down the local test infrastructure from the cluster, use the following command. It may take some time to completely stop the PUT, CRD, OT, and DP:
@@ -209,7 +235,8 @@ make clean
 
 ## Setup with Vagrant, docker and kind (Mac OS support)
 
-Install vagrant for your platform
+Install vagrant for your platform:
+
 ```shell-script
 https://www.vagrantup.com/downloads
 ```
@@ -222,6 +249,7 @@ make vagrant-build
 
 The kubeconfig for the new environment will override the file located at ~/.kube/config
 Just start running commands from the command line to test the new cluster:
+
 ```shell-script
 oc get pods -A
 ```
@@ -233,14 +261,17 @@ make vagrant-destroy
 ```
 
 To access the virtual machine supporting the cluster, do the following:
+
 ```shell-script
 cd config/vagrant
 user@fedora vagrant]$ vagrant ssh
 [vagrant@k8shost ~]$
 ```
+
 The partner repo scripts are located in ~/partner
 
 ## License
+
 CNF Certification Test Partner is copyright [Red Hat, Inc.](https://www.redhat.com) and available
 under an
 [Apache 2 license](https://github.com/test-network-function/cnf-certification-test-partner/blob/main/LICENSE).

examples/README.md

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable line-length no-bare-urls -->
 # YAML Examples
 
 This folder is going to house some example YAMLs that will make the test suite fail if applied to a cluster.  Not all test suites have an example to show but more examples can be added in the future.
@@ -7,6 +8,7 @@ Please refer to the [CATALOG](https://github.com/test-network-function/test-netw
 ## Examples by Test Suite
 
 Please find an example below that ties to a specific test case you are interested in.
+
 ### accesscontrol
 
 * [cluster-role-bindings](examples/accesscontrol/clusterRoleBinding.yaml) - [Catalog Link](https://github.com/test-network-function/test-network-function/blob/main/CATALOG.md#cluster-role-bindings)
@@ -21,24 +23,21 @@ Creates necessary cluster role, role binding, service account, and pod that caus
 
 * namespace (no example) - [Catalog Link](https://github.com/test-network-function/test-network-function/blob/main/CATALOG.md#namespace)
 
-* [pod-automount-service-account-token](examples/accesscontrol/serviceAccountTokenPod.yaml) - [Catalog Link](https://github.com/test-network-function/test-network-function/blob/main/CATALOG.md#pod-automount-service-account-token) 
+* [pod-automount-service-account-token](examples/accesscontrol/serviceAccountTokenPod.yaml) - [Catalog Link](https://github.com/test-network-function/test-network-function/blob/main/CATALOG.md#pod-automount-service-account-token)
 
 * [pod-role-bindings](examples/accesscontrol/podRoleBinding.yaml) - [Catalog Link](https://github.com/test-network-function/test-network-function/blob/main/CATALOG.md#pod-role-bindings)
 
 Creates necessary role, role binding, service account, and pod that causes a failure in the `accesscontrol` suite of tests because the rolebinding cannot cross namespaces.
 
 * [pod-service-account](examples/accesscontrol/serviceAccountPod.yaml) - [Catalog Link](https://github.com/test-network-function/test-network-function/blob/main/CATALOG.md#pod-service-account)
 
-
-
 ### affiliated-certification
 
-No examples to show (yet)....
+No examples to show (yet)…
 
 * container-is-certified (no example) - [Catalog Link](https://github.com/test-network-function/test-network-function/blob/main/CATALOG.md#container-is-certified)
 * operator-is-certified (no example) - [Catalog Link](https://github.com/test-network-function/test-network-function/blob/main/CATALOG.md#operator-is-certified)
 
-
 ### lifecycle
 
 Note: We might need the following flag set in the environment in which you are testing these YAMLs to avoid any draining, cluster-intrusive issues, etc.
@@ -72,7 +71,6 @@ Creates a pod with no "owner".  It does not belong to a replicaset or a deployme
 
 * stateful-scaling (no example) - [Catalog Link](https://github.com/test-network-function/test-network-function/blob/main/CATALOG.md#statefulset-scaling)
 
-
 ### networking
 
 * icmpv4-connectivity (no example) - [Catalog Link](https://github.com/test-network-function/test-network-function/blob/main/CATALOG.md#icmpv4-connectivity)
@@ -104,4 +102,3 @@ Creates an `echo-server` pod which does some logging to the stdout.  The test ch
 * isredhat-release (no example) - [Catalog Link](https://github.com/test-network-function/test-network-function/blob/main/CATALOG.md#isredhat-release)
 * sysctl-config (no example) - [Catalog Link](https://github.com/test-network-function/test-network-function/blob/main/CATALOG.md#sysctl-config)
 * tainted-node-kernel (no example) - [Catalog Link](https://github.com/test-network-function/test-network-function/blob/main/CATALOG.md#tainted-node-kernel)
-