docs

Author: skudasov

book/src/SUMMARY.md

@@ -20,6 +20,7 @@
   - [Test Configuration](./framework/test_configuration_overrides.md)
   - [Exposing Components](framework/components/state.md)
   - [Debugging Tests](framework/components/debug.md)
+  - [Debugging K8s Chaos Tests](framework/chaos/debug-k8s.md)
   - [Components Cleanup](framework/components/cleanup.md)
   - [Components Caching](framework/components/caching.md)
   - [Components Resources](framework/components/resources.md)

book/src/framework/chaos/chaos.md

@@ -57,3 +57,9 @@ We also offer a set of blockchain-specific experiments, which typically involve
 - Utilizing developer APIs (e.g., Anvil)
 
 Check [gas](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/examples/myproject/chaos/chaos_blockchain_evm_gas_test.go) and [reorg](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/examples/myproject/chaos/chaos_blockchain_evm_reorg_test.go) examples.
+
+## Debugging
+
+To debug `Docker` applications you can just use `CTFv2` deployments.
+
+To debug `K8s` please use our [simulator](../chaos/debug-k8s.md).

book/src/framework/chaos/debug-k8s.md

@@ -0,0 +1,26 @@
+# Debugging K8s Chaos Tests
+
+This deployment is used to debug various [ChaosMesh](https://chaos-mesh.org/) with [Kind](https://kind.sigs.k8s.io/)
+
+Install [DevBox](https://www.jetify.com/devbox) and run your environment
+```
+devbox run up
+```
+
+Overview the services
+```
+devbox shell
+k9s
+```
+Apply experiments (inside devbox shell)
+
+If you running it from any other shell or using `Go` don't forget to apply `kubectl config set-context kind-cm-playground` before!
+```
+kubectl apply -f manifests/latency.yaml
+```
+Debug `ChaosMesh` using `k9s`, check daemon logs.
+
+Remove the environment
+```
+devbox run down
+```

infra/chaosmesh-playground/README.md

@@ -13,10 +13,12 @@ devbox shell
 k9s
 ```
 Apply experiments (inside devbox shell)
+
+If you running it from any other shell or using `Go` don't forget to apply `kubectl config set-context kind-cm-playground` before!
 ```
 kubectl apply -f manifests/latency.yaml
 ```
-Debug `ChaosMesh` using k9s, check daemon logs.
+Debug `ChaosMesh` using `k9s`, check daemon logs.
 
 Remove the environment
 ```

infra/chaosmesh-playground/devbox.json

@@ -14,12 +14,22 @@
       "up": [
         "kind create cluster --name cm-playground --config kind.yaml",
         "helm repo add chaos-mesh https://charts.chaos-mesh.org",
+        "kubectl create ns chaos-mesh",
         "helm install chaos-mesh chaos-mesh/chaos-mesh -n=chaos-mesh --set chaosDaemon.runtime=containerd --set chaosDaemon.socketPath=/run/containerd/containerd.sock --version 2.7.0",
-        "kubectl apply -f dummy.yaml"
+        "kubectl apply -f dummy-cluster.yaml"
       ],
       "down": [
         "kind delete cluster --name cm-playground"
       ],
+      "rm-chaos": [
+        "kubectl delete networkchaos --all -A",
+        "kubectl delete podchaos --all -A",
+        "kubectl delete iochaos --all -A",
+        "kubectl delete timechaos --all -A",
+        "kubectl delete stresschaos --all -A",
+        "kubectl delete dnschaos --all -A",
+        "kubectl delete kernelchaos --all -A"
+      ],
       "context": [
         "kubectl config set-context"
       ]

infra/chaosmesh-playground/dummy-cluster.yaml

@@ -0,0 +1,68 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: http-ping-deployment
+spec:
+  replicas: 4
+  selector:
+    matchLabels:
+      app: http-ping-app
+  template:
+    metadata:
+      labels:
+        app: http-ping-app
+    spec:
+      containers:
+        - name: http-ping-container
+          image: python:3.9-alpine
+          command:
+            - sh
+            - -c
+            - |
+              apk add --no-cache bind-tools
+              python -m http.server 8080 &
+              while true; do
+                POD_IPS=$(nslookup http-ping-service | awk '/Address/ {print $2}' | tail -n +2)
+                for IP in $POD_IPS; do
+                  if [ "$IP" != "$(hostname -i)" ]; then
+                    LATENCY=$(ping -c 1 $IP | grep 'time=' | awk -F'time=' '{print $2}' | awk '{print $1}')
+                    echo "$IP ->> $LATENCY ms"
+                  fi
+                done
+                sleep 1
+              done
+          ports:
+            - containerPort: 8080
+
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: http-ping-service
+spec:
+  selector:
+    app: http-ping-app
+  ports:
+    - protocol: TCP
+      port: 8080
+      targetPort: 8080
+  clusterIP: None
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: production-app-that-must-be-safe
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: production-app
+  template:
+    metadata:
+      labels:
+        app: production-app
+    spec:
+      containers:
+        - name: ping-container
+          image: alpine:latest
+          command: ["sh", "-c", "while true; do ping -c 1 google.com; sleep 1; done"]

infra/chaosmesh-playground/dummy.yaml

@@ -6,10 +6,11 @@ metadata:
 spec:
   action: delay
   mode: all
+  duration: "30s"
   selector:
     labelSelectors:
-      app: ping-app
+      app: http-ping-app
   delay:
-    latency: "100ms"
-    correlation: "100"
+    latency: "50ms"
+    correlation: "0"
     jitter: "0ms"