Docs(examples): Add some example docs for jitter and default app check tunable (#3433)
Signed-off-by: uditgaurav <udit@chaosnative.com>
This commit is contained in:
parent
4937cedcce
commit
2b64cbf91c
|
@ -100,3 +100,33 @@ spec:
|
|||
- name: TOTAL_CHAOS_DURATION
|
||||
VALUE: '60'
|
||||
```
|
||||
|
||||
### Default Application Health Check
|
||||
|
||||
It defines the default application status checks as a tunable. It is helpful for the scenarios where you don’t want to validate the application status as a mandatory check during pre & post chaos. It can be tuned via `DEFAULT_APP_HEALTH_CHECK` ENV. If `DEFAULT_APP_HEALTH_CHECK` is not provided by default it is set to `true`.
|
||||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/categories/pods/common/default-app-health-check.yaml yaml)
|
||||
```yaml
|
||||
## application status check as tunable
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
kind: ChaosEngine
|
||||
metadata:
|
||||
name: engine-nginx
|
||||
spec:
|
||||
engineState: "active"
|
||||
annotationCheck: "false"
|
||||
appinfo:
|
||||
appns: "default"
|
||||
applabel: "app=nginx"
|
||||
appkind: "deployment"
|
||||
chaosServiceAccount: pod-delete-sa
|
||||
experiments:
|
||||
- name: pod-delete
|
||||
spec:
|
||||
components:
|
||||
env:
|
||||
- name: DEFAULT_APP_HEALTH_CHECK
|
||||
value: 'false'
|
||||
```
|
|
@ -0,0 +1,20 @@
|
|||
## application status check as tunable
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
kind: ChaosEngine
|
||||
metadata:
|
||||
name: engine-nginx
|
||||
spec:
|
||||
engineState: "active"
|
||||
annotationCheck: "false"
|
||||
appinfo:
|
||||
appns: "default"
|
||||
applabel: "app=nginx"
|
||||
appkind: "deployment"
|
||||
chaosServiceAccount: pod-delete-sa
|
||||
experiments:
|
||||
- name: pod-delete
|
||||
spec:
|
||||
components:
|
||||
env:
|
||||
- name: DEFAULT_APP_HEALTH_CHECK
|
||||
value: 'false'
|
|
@ -321,6 +321,37 @@ spec:
|
|||
value: '60'
|
||||
```
|
||||
|
||||
### Jitter
|
||||
|
||||
It defines the jitter (in ms), a parameter that allows introducing a network delay variation. It can be tuned via `JITTER` ENV. Its default value is `0`.
|
||||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/categories/pods/pod-network-latency/network-latency-jitter.yaml yaml)
|
||||
```yaml
|
||||
# provide the network latency jitter
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
kind: ChaosEngine
|
||||
metadata:
|
||||
name: engine-nginx
|
||||
spec:
|
||||
engineState: "active"
|
||||
annotationCheck: "false"
|
||||
appinfo:
|
||||
appns: "default"
|
||||
applabel: "app=nginx"
|
||||
appkind: "deployment"
|
||||
chaosServiceAccount: pod-network-latency-sa
|
||||
experiments:
|
||||
- name: pod-network-latency
|
||||
spec:
|
||||
components:
|
||||
env:
|
||||
# value of the network latency jitter (in ms)
|
||||
- name: JITTER
|
||||
value: '200'
|
||||
```
|
||||
|
||||
### Container Runtime Socket Path
|
||||
|
||||
It defines the `CONTAINER_RUNTIME` and `SOCKET_PATH` ENV to set the container runtime and socket file path.
|
||||
|
|
|
@ -0,0 +1,21 @@
|
|||
# provide the network latency jitter
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
kind: ChaosEngine
|
||||
metadata:
|
||||
name: engine-nginx
|
||||
spec:
|
||||
engineState: "active"
|
||||
annotationCheck: "false"
|
||||
appinfo:
|
||||
appns: "default"
|
||||
applabel: "app=nginx"
|
||||
appkind: "deployment"
|
||||
chaosServiceAccount: pod-network-latency-sa
|
||||
experiments:
|
||||
- name: pod-network-latency
|
||||
spec:
|
||||
components:
|
||||
env:
|
||||
# value of the network latency jitter (in ms)
|
||||
- name: JITTER
|
||||
value: '200'
|
Loading…
Reference in New Issue