(docs): fixing the list items rendering issue (#3127)

Signed-off-by: shubham chaudhary <shubham@chaosnative.com>

mkdocs/docs/experiments/categories/pods/container-kill.md

@@ -234,9 +234,10 @@ spec:
 
 ### Container Runtime Socket Path
 
-It defines the `CONTAINER_RUNTIME` and `SOCKET_PATH` ENV to set the container runtime and socket file path.
+It defines the `CONTAINER_RUNTIME` and `SOCKET_PATH` ENV to set the container runtime and socket file path:
+
 - `CONTAINER_RUNTIME`: It supports `docker`, `containerd`, and `crio` runtimes. The default value is `docker`.
-`SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
+- `SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
 
 [embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/categories/pods/container-kill/container-runtime-and-socket-path.yaml yaml)
 ```yaml

mkdocs/docs/experiments/categories/pods/pod-cpu-hog-exec.md

@@ -198,6 +198,7 @@ spec:
 
 It defines the `CHAOS_INJECT_COMMAND` and `CHAOS_KILL_COMMAND` ENV to set the chaos inject and chaos kill commands respectively.
 Default values of commands:
+
 - `CHAOS_INJECT_COMMAND`: "md5sum /dev/zero"
 - `CHAOS_KILL_COMMAND`: "kill $(find /proc -name exe -lname '*/md5sum' 2>&1 | grep -v 'Permission denied' | awk -F/ '{print $(NF-1)}')"
 

mkdocs/docs/experiments/categories/pods/pod-cpu-hog.md

@@ -208,8 +208,9 @@ spec:
 ### Container Runtime Socket Path
 
 It defines the `CONTAINER_RUNTIME` and `SOCKET_PATH` ENV to set the container runtime and socket file path.
+
 - `CONTAINER_RUNTIME`: It supports `docker`, `containerd`, and `crio` runtimes. The default value is `docker`.
-`SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
+- `SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
 
 Use the following example to tune this:
 

mkdocs/docs/experiments/categories/pods/pod-delete.md

@@ -224,6 +224,7 @@ spec:
 
 The randomness in the chaos interval can be enabled via setting `RANDOMNESS` ENV to `true`. It supports boolean values. The default value is `false`.
 The chaos interval can be tuned via `CHAOS_INTERVAL` ENV. 
+
 - If `CHAOS_INTERVAL` is set in the form of `l-r` i.e, `5-10` then it will select a random interval between l & r.
 - If `CHAOS_INTERVAL` is set in the form of `value` i.e, `10` then it will select a random interval between 0 & value.
 

mkdocs/docs/experiments/categories/pods/pod-dns-error.md

@@ -235,8 +235,9 @@ spec:
 ### Container Runtime Socket Path
 
 It defines the `CONTAINER_RUNTIME` and `SOCKET_PATH` ENV to set the container runtime and socket file path.
+
 - `CONTAINER_RUNTIME`: It supports `docker` runtime only.
-`SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`).
+- `SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`).
 
 Use the following example to tune this:
 

mkdocs/docs/experiments/categories/pods/pod-dns-spoof.md

@@ -195,8 +195,9 @@ spec:
 ### Container Runtime Socket Path
 
 It defines the `CONTAINER_RUNTIME` and `SOCKET_PATH` ENV to set the container runtime and socket file path.
+
 - `CONTAINER_RUNTIME`: It supports `docker` runtime only.
-`SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`).
+- `SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`).
 
 Use the following example to tune this:
 

mkdocs/docs/experiments/categories/pods/pod-io-stress.md

@@ -248,8 +248,9 @@ spec:
 ### Container Runtime Socket Path
 
 It defines the `CONTAINER_RUNTIME` and `SOCKET_PATH` ENV to set the container runtime and socket file path.
+
 - `CONTAINER_RUNTIME`: It supports `docker`, `containerd`, and `crio` runtimes. The default value is `docker`.
-`SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
+- `SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
 
 Use the following example to tune this:
 

mkdocs/docs/experiments/categories/pods/pod-memory-hog-exec.md

@@ -194,6 +194,7 @@ spec:
 
 It defines the `CHAOS_KILL_COMMAND` ENV to set the chaos kill command.
 Default values of `CHAOS_KILL_COMMAND` command:
+
 - `CHAOS_KILL_COMMAND`: "kill $(find /proc -name exe -lname '*/dd' 2>&1 | grep -v 'Permission denied' | awk -F/ '{print $(NF-1)}' | head -n 1)"
 
 Use the following example to tune this:

mkdocs/docs/experiments/categories/pods/pod-memory-hog.md

@@ -243,8 +243,9 @@ spec:
 ### Container Runtime Socket Path
 
 It defines the `CONTAINER_RUNTIME` and `SOCKET_PATH` ENV to set the container runtime and socket file path.
+
 - `CONTAINER_RUNTIME`: It supports `docker`, `containerd`, and `crio` runtimes. The default value is `docker`.
-`SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
+- `SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
 
 ### Pumba Chaos Library
 

mkdocs/docs/experiments/categories/pods/pod-network-corruption.md

@@ -219,8 +219,9 @@ spec:
 ### Destination IPs And Destination Hosts
 
 The network experiments interrupt traffic for all the IPs/hosts by default. The interruption of specific IPs/Hosts can be tuned via `DESTINATION_IPS` and `DESTINATION_HOSTS` ENV.
-`DESTINATION_IPS`: It contains the IP addresses of the services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted.
-`DESTINATION_HOSTS`: It contains the DNS Names/FQDN names of the services, the accessibility to which, is impacted.
+
+- `DESTINATION_IPS`: It contains the IP addresses of the services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted.
+- `DESTINATION_HOSTS`: It contains the DNS Names/FQDN names of the services, the accessibility to which, is impacted.
 
 Use the following example to tune this:
 
@@ -290,8 +291,9 @@ spec:
 ### Container Runtime Socket Path
 
 It defines the `CONTAINER_RUNTIME` and `SOCKET_PATH` ENV to set the container runtime and socket file path.
+
 - `CONTAINER_RUNTIME`: It supports `docker`, `containerd`, and `crio` runtimes. The default value is `docker`.
-`SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
+- `SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
 
 Use the following example to tune this:
 

mkdocs/docs/experiments/categories/pods/pod-network-duplication.md

@@ -220,8 +220,9 @@ spec:
 ### Destination IPs And Destination Hosts
 
 The network experiments interrupt traffic for all the IPs/hosts by default. The interruption of specific IPs/Hosts can be tuned via `DESTINATION_IPS` and `DESTINATION_HOSTS` ENV.
-`DESTINATION_IPS`: It contains the IP addresses of the services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted.
-`DESTINATION_HOSTS`: It contains the DNS Names/FQDN names of the services, the accessibility to which, is impacted.
+
+- `DESTINATION_IPS`: It contains the IP addresses of the services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted.
+- `DESTINATION_HOSTS`: It contains the DNS Names/FQDN names of the services, the accessibility to which, is impacted.
 
 Use the following example to tune this:
 
@@ -291,8 +292,9 @@ spec:
 ### Container Runtime Socket Path
 
 It defines the `CONTAINER_RUNTIME` and `SOCKET_PATH` ENV to set the container runtime and socket file path.
+
 - `CONTAINER_RUNTIME`: It supports `docker`, `containerd`, and `crio` runtimes. The default value is `docker`.
-`SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
+- `SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
 
 Use the following example to tune this:
 

mkdocs/docs/experiments/categories/pods/pod-network-latency.md

@@ -226,8 +226,9 @@ spec:
 ### Destination IPs And Destination Hosts
 
 The network experiments interrupt traffic for all the IPs/hosts by default. The interruption of specific IPs/Hosts can be tuned via `DESTINATION_IPS` and `DESTINATION_HOSTS` ENV.
-`DESTINATION_IPS`: It contains the IP addresses of the services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted.
-`DESTINATION_HOSTS`: It contains the DNS Names/FQDN names of the services, the accessibility to which, is impacted.
+
+- `DESTINATION_IPS`: It contains the IP addresses of the services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted.
+- `DESTINATION_HOSTS`: It contains the DNS Names/FQDN names of the services, the accessibility to which, is impacted.
 
 Use the following example to tune this:
 
@@ -297,8 +298,9 @@ spec:
 ### Container Runtime Socket Path
 
 It defines the `CONTAINER_RUNTIME` and `SOCKET_PATH` ENV to set the container runtime and socket file path.
+
 - `CONTAINER_RUNTIME`: It supports `docker`, `containerd`, and `crio` runtimes. The default value is `docker`.
-`SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
+- `SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
 
 Use the following example to tune this:
 

mkdocs/docs/experiments/categories/pods/pod-network-loss.md

@@ -219,8 +219,9 @@ spec:
 ### Destination IPs And Destination Hosts
 
 The network experiments interrupt traffic for all the IPs/hosts by default. The interruption of specific IPs/Hosts can be tuned via `DESTINATION_IPS` and `DESTINATION_HOSTS` ENV.
-`DESTINATION_IPS`: It contains the IP addresses of the services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted.
-`DESTINATION_HOSTS`: It contains the DNS Names/FQDN names of the services, the accessibility to which, is impacted.
+
+- `DESTINATION_IPS`: It contains the IP addresses of the services or pods or the CIDR blocks(range of IPs), the accessibility to which is impacted.
+- `DESTINATION_HOSTS`: It contains the DNS Names/FQDN names of the services, the accessibility to which, is impacted.
 
 Use the following example to tune this:
 
@@ -290,8 +291,9 @@ spec:
 ### Container Runtime Socket Path
 
 It defines the `CONTAINER_RUNTIME` and `SOCKET_PATH` ENV to set the container runtime and socket file path.
+
 - `CONTAINER_RUNTIME`: It supports `docker`, `containerd`, and `crio` runtimes. The default value is `docker`.
-`SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
+- `SOCKET_PATH`: It contains path of docker socket file by default(`/var/run/docker.sock`). For other runtimes provide the appropriate path.
 
 Use the following example to tune this:
 

mkdocs/docs/experiments/chaos-resources/chaos-engine/application-details.md

@@ -113,6 +113,7 @@ It contains AUT and auxiliary applications details provided at `spec.appinfo` an
 ## Application Under Test
 
 It defines the `appns`, `applabel`, and `appkind` to set the namespace, labels, and kind of the application under test.
+
 - `appkind`: It supports `deployment`, `statefulset`, `daemonset`, `deploymentconfig`, and `rollout`. 
 It is mandatory for the pod-level experiments and optional for the rest of the experiments.
 

mkdocs/docs/experiments/chaos-resources/chaos-engine/experiment-components.md

@@ -279,6 +279,7 @@ spec:
 ### Experiment Configmaps And Secrets
 
 It defines the `configMaps` and `secrets` to set the configmaps and secrets mounted to the experiment pod respectively.
+
 - `configMaps`: It provides for a means to insert config information into the experiment. The configmaps definition is validated for the correctness and those specified are checked for availability (in the cluster/namespace) before being mounted into the experiment pods.
 - `secrets`: It provides for a means to push secrets (typically project ids, access credentials, etc.,) into the experiment pods. These are especially useful in the case of platform-level/infra-level chaos experiments. The secrets definition is validated for the correctness and those specified are checked for availability (in the cluster/namespace) before being mounted into the experiment pods.
 

mkdocs/docs/experiments/chaos-resources/chaos-engine/runner-components.md

@@ -333,6 +333,7 @@ spec:
 ### ChaosRunner Args And Command
 
 It defines the `args` and `command` to set the args and command of the chaos-runner respectively.
+
 - `args`: It allows developers to specify their own debug runner args.
 - `command`: It allows developers to specify their own debug runner commands.
 
@@ -374,6 +375,7 @@ spec:
 ### ChaosRunner Configmaps And Secrets
 
 It defines the `configMaps` and `secrets` to set the configmaps and secrets mounted to the chaos-runner respectively.
+
 - `configMaps`: It provides for a means to insert config information into the runner pod.
 - `secrets`: It provides for a means to push secrets (typically project ids, access credentials, etc.,) into the chaos runner pod. These are especially useful in the case of platform-level/infra-level chaos experiments.
 
@@ -412,6 +414,7 @@ spec:
 ### ChaosRunner Image and ImagePullPoicy
 
 It defines the `image` and `imagePullPolicy` to set the image and imagePullPolicy for the chaos-runner respectively.
+
 - `image`: It allows developers to specify their own debug runner images. Defaults for the runner image can be enforced via the operator env `CHAOS_RUNNER_IMAGE`. 
 - `imagePullPolicy`: It allows developers to specify the pull policy for chaos-runner. Set to Always during debug/test.
 

mkdocs/docs/experiments/faq/portal.md

@@ -20,8 +20,6 @@ hide:
 
 1. [How is resilience score is Calculated?](#how-is-resilience-score-is-calculated)
 
-1. [Pre-defined workflow Bank Of Anthos showing bus error for accounts-db or ledger-db pod?](#pre-defined-workflow-bank-of-anthos-showing-bus-error-for-accounts-db-or-ledger-db-pod)
-
 ### Can we host MongoDB outside the cluster? What connection string is supported? Is SSL connection supported? 
 
 Yes we can host Mongodb outside the cluster, the mongo string can be updated accordingly DataBaseServer: "mongodb://mongo-service:27017"
@@ -52,13 +50,3 @@ For now you can create agents and projects, also you can get the agents and proj
 ### How is resilience score is Calculated?
 
 The Resilience score is calculated on the basis of the weightage and the Probe Success Percentage of the experiment. Resilience for one single experiment is the multiplication of the weight given to that experiment and the Probe Success Percentage. Then we get the total test result by adding the resilience score of all the experiments. The Final Resilience Score is calculated by dividing the total test result by the sum of the weights of all the experiments combined in the single workflow. For more detail refer to [this](https://dev.to/litmus-chaos/how-the-resilience-score-algorithm-works-in-litmus-1d22) blog.
-
-### Pre-defined workflow Bank Of Anthos showing bus error for accounts-db or ledger-db pod?
-
-Bank of anthos is using PostgreSQL and wouldn't fall back properly to not using huge pages. 
-With given possible solution if same scenario occur can be resolve.
- - Modify the docker image to be able to set huge_pages = off in /usr/share/postgresql/postgresql.conf.sample before initdb was ran (this is what I did).
- - Turn off huge page support on the system (vm.nr_hugepages = 0 in /etc/sysctl.conf).
- - Fix Postgres's fallback mechanism when huge_pages = try is set (the default).
- - Modify the k8s manifest to enable huge page support (https://kubernetes.io/docs/tasks/manage-hugepages/scheduling-hugepages/).
- - Modify k8s to show that huge pages are not supported on the system, when they are not enabled for a specific container.

mkdocs/docs/experiments/troubleshooting/portal.md

@@ -20,6 +20,8 @@ hide:
 
 1. [Unable to Install Litmus portal using helm. Server pod and mongo pod are in CrashLoopBackOff state. Got this error while checking the logs of mongo container chown: changing ownership of '/data/db/.snapshot': Read-only file system](#unable-to-install-litmus-portal-using-helm-server-pod-and-mongo-pod-are-in-crashloopbackoff-state-got-this-error-while-checking-the-logs-of-mongo-container-chown-changing-ownership-of-datadbsnapshot-read-only-file-system)
 
+1. [Pre-defined workflow Bank Of Anthos showing bus error for accounts-db or ledger-db pod?](#pre-defined-workflow-bank-of-anthos-showing-bus-error-for-accounts-db-or-ledger-db-pod)
+
 ### We were setting up a Litmus Portal, however, Self-Agent status is showing pending. Any idea why is happening?
 
 The litmusportal-server-service might not be reachable due to inbound rules. You can enable the traffic to it if on GKE/EKS/AKS (by adding the port to inbound rules for traffic). You have to check the logs of the subscriber pod and expose the port mentioned for communication with the server.
@@ -58,3 +60,14 @@ These are agent components, which are launched by the control plane server, so f
 ### Unable to Install Litmus portal using helm. Server pod and mongo pod are in CrashLoopBackOff state. Got this error while checking the logs of mongo container chown: changing ownership of '/data/db/.snapshot': Read-only file system
 
 It seems the directory somehow existed before litmus installation and might be used by some other application. You have to change the mount path from /consul/config to /consul/myconfig in mongo statefulset then you can successfully deploy the litmus.
+
+### Pre-defined workflow Bank Of Anthos showing bus error for accounts-db or ledger-db pod?
+
+Bank of anthos is using PostgreSQL and wouldn't fall back properly to not using huge pages. 
+With given possible solution if same scenario occur can be resolve.
+ - Modify the docker image to be able to set huge_pages = off in /usr/share/postgresql/postgresql.conf.sample before initdb was ran (this is what I did).
+ - Turn off huge page support on the system (vm.nr_hugepages = 0 in /etc/sysctl.conf).
+ - Fix Postgres's fallback mechanism when huge_pages = try is set (the default).
+ - Modify the k8s manifest to enable huge page support (https://kubernetes.io/docs/tasks/manage-hugepages/scheduling-hugepages/).
+ - Modify k8s to show that huge pages are not supported on the system, when they are not enabled for a specific container.
+