(docs): fixed the embedmd broken links (#3138)
Signed-off-by: shubham chaudhary <shubham@chaosnative.com>
This commit is contained in:
Shubham Chaudhary
GitHub
parent
ec1ee65dbf
commit
cc67faa3ec
|
|
@ -119,7 +119,7 @@ It is mandatory for the pod-level experiments and optional for the rest of the e
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/engine-spec/app-info.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/engine-spec/app-info.yaml yaml)
|
||||
```yaml
|
||||
# contains details of the AUT(application under test)
|
||||
# appns: name of the application
|
||||
|
|
@ -151,7 +151,7 @@ It can be tuned via `auxiliaryAppInfo` field. It supports input the below format
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/engine-spec/auxiliary-appinfo.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/engine-spec/auxiliary-appinfo.yaml yaml)
|
||||
```yaml
|
||||
# contains the comma seperated list of auxiliary applications details
|
||||
# it is provide in `<key1>=<value1>:<namespace1>,<key2>=<value2>:<namespace2>` format
|
||||
|
|
@ -172,4 +172,4 @@ spec:
|
|||
experiments:
|
||||
- name: pod-delete
|
||||
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ metadata:
|
|||
spec:
|
||||
engineState: "active"
|
||||
annotationCheck: "false"
|
||||
jobCleanupPolicy: "delete"
|
||||
jobCleanUpPolicy: "delete"
|
||||
appinfo:
|
||||
appns: "default"
|
||||
applabel: "app=nginx"
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ It can be tuned via `engineState` field. It supports `active` and `stop` values.
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/engine-spec/engine-state.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/engine-spec/engine-state.yaml yaml)
|
||||
```yaml
|
||||
# contains the chaosengine state
|
||||
# supports: active and stop states
|
||||
|
|
@ -52,4 +52,4 @@ spec:
|
|||
experiments:
|
||||
- name: pod-delete
|
||||
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -251,7 +251,7 @@ It allows developers to specify the custom annotations for the experiment pod. I
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/experiment-components/experiment-annotations.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/experiment-components/experiment-annotations.yaml yaml)
|
||||
```yaml
|
||||
# contains annotations for the chaos runner pod
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -285,7 +285,7 @@ It defines the `configMaps` and `secrets` to set the configmaps and secrets moun
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/experiment-components/experiment-configmaps-and-secrets.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/experiment-components/experiment-configmaps-and-secrets.yaml yaml)
|
||||
```yaml
|
||||
# contains configmaps and secrets for the experiment pod
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -321,7 +321,7 @@ It overrides the experiment image for the chaosexperiment. It allows developers
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/experiment-components/experiment-image.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/experiment-components/experiment-image.yaml yaml)
|
||||
```yaml
|
||||
# contains the custom image for the experiment pod
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -351,7 +351,7 @@ It allows developers to specify the imagePullSecret name for ChaosExperiment. It
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/experiment-components/experiment-imagePullSecrets.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/experiment-components/experiment-imagePullSecrets.yaml yaml)
|
||||
```yaml
|
||||
# contains the imagePullSecrets for the experiment pod
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -383,7 +383,7 @@ The nodeselector contains labels of the node on which experiment pod should be s
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/experiment-components/experiment-nodeSelectors.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/experiment-components/experiment-nodeSelectors.yaml yaml)
|
||||
```yaml
|
||||
# contains the node-selector for the experiment pod
|
||||
# it will schedule the experiment pod on the coresponding node with matching labels
|
||||
|
|
@ -415,7 +415,7 @@ It contains the resource requirements for the ChaosExperiment Pod, where we can
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/experiment-components/experiment-resources.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/experiment-components/experiment-resources.yaml yaml)
|
||||
```yaml
|
||||
# contains the resource requirements for the experiment pod
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -451,7 +451,7 @@ It provides tolerations for the experiment pod so that it can be scheduled on th
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/experiment-components/experiment-tolerations.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/experiment-components/experiment-tolerations.yaml yaml)
|
||||
```yaml
|
||||
# contains the tolerations for the experiment pod
|
||||
# it will schedule the experiment pod on the tainted node
|
||||
|
|
@ -486,7 +486,7 @@ It overrides the status timeouts inside chaosexperiments. It contains timeout &
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/experiment-components/experiment-statusCheckTimeout.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/experiment-components/experiment-statusCheckTimeout.yaml yaml)
|
||||
```yaml
|
||||
# contains status check timeout for the experiment pod
|
||||
# it will set this timeout as upper bound while checking application status, node status in experiments
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ It can be tuned via `chaosServiceAccount` field.
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/engine-spec/service-account.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/engine-spec/service-account.yaml yaml)
|
||||
```yaml
|
||||
# contains name of the serviceAccount which contains all the RBAC permissions required for the experiment
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -50,4 +50,4 @@ spec:
|
|||
experiments:
|
||||
- name: pod-delete
|
||||
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -305,7 +305,7 @@ It allows developers to specify the custom annotations for the runner pod. It ca
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/runner-components/runner-annotations.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/runner-components/runner-annotations.yaml yaml)
|
||||
```yaml
|
||||
# contains annotations for the chaos runner pod
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -339,7 +339,7 @@ It defines the `args` and `command` to set the args and command of the chaos-run
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/runner-components/runner-args-and-command.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/runner-components/runner-args-and-command.yaml yaml)
|
||||
```yaml
|
||||
# contains args and command for the chaos runner
|
||||
# it will be useful for the cases where custom image of the chaos-runner is used, which supports args and commands
|
||||
|
|
@ -381,7 +381,7 @@ It defines the `configMaps` and `secrets` to set the configmaps and secrets moun
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/runner-components/runner-configmaps-and-secrets.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/runner-components/runner-configmaps-and-secrets.yaml yaml)
|
||||
```yaml
|
||||
# contains configmaps and secrets for the chaos-runner
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -420,7 +420,7 @@ It defines the `image` and `imagePullPolicy` to set the image and imagePullPolic
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/runner-components/runner-image-and-pullPolicy.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/runner-components/runner-image-and-pullPolicy.yaml yaml)
|
||||
```yaml
|
||||
# contains the image and imagePullPolicy of the chaos-runner
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -454,7 +454,7 @@ It allows developers to specify the imagePullSecret name for the ChaosRunner. It
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/runner-components/runner-imagePullSecrets.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/runner-components/runner-imagePullSecrets.yaml yaml)
|
||||
```yaml
|
||||
# contains the imagePullSecrets for the chaos-runner
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -485,7 +485,7 @@ The nodeselector contains labels of the node on which runner pod should be sched
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/runner-components/runner-nodeSelectors.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/runner-components/runner-nodeSelectors.yaml yaml)
|
||||
```yaml
|
||||
# contains the node-selector for the chaos-runner
|
||||
# it will schedule the chaos-runner on the coresponding node with matching labels
|
||||
|
|
@ -517,7 +517,7 @@ It contains the resource requirements for the ChaosRunner Pod, where we can prov
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/runner-components/runner-resources.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/runner-components/runner-resources.yaml yaml)
|
||||
```yaml
|
||||
# contains the resource requirements for the runner pod
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -553,7 +553,7 @@ It provides tolerations for the runner pod so that it can be scheduled on the re
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/runner-components/runner-tolerations.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/runner-components/runner-tolerations.yaml yaml)
|
||||
```yaml
|
||||
# contains the tolerations for the chaos-runner
|
||||
# it will schedule the chaos-runner on the tainted node
|
||||
|
|
|
|||
|
|
@ -91,7 +91,7 @@ It can be tuned via `annotationCheck` field. It supports the boolean value and t
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/engine-spec/annotation-check.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/engine-spec/annotation-check.yaml yaml)
|
||||
```yaml
|
||||
# checks the AUT for the annoations. The AUT should be annotated with `litmuschaos.io/chaos: true` if provided as true
|
||||
# supports: true, false. default: false
|
||||
|
|
@ -116,11 +116,11 @@ spec:
|
|||
## Jobcleanup Policy
|
||||
|
||||
It controls whether or not the experiment pods are removed once execution completes. Set to `retain` for debug purposes (in the absence of standard logging mechanisms).
|
||||
It can be tuned via `jobCleanupPolicy` fields. It supports `retain` and `delete`. The default value is `retain`.
|
||||
It can be tuned via `jobCleanUpPolicy` fields. It supports `retain` and `delete`. The default value is `retain`.
|
||||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/engine-spec/jobcleanup-policy.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/engine-spec/jobcleanup-policy.yaml yaml)
|
||||
```yaml
|
||||
# flag to delete or retain the chaos resources after completions of chaosengine
|
||||
# supports: delete, retain. default: retain
|
||||
|
|
@ -149,7 +149,7 @@ It can be tuned via `terminationGracePeriodSeconds` field.
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/engine-spec/terminationGracePeriod.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-engine/engine-spec/terminationGracePeriod.yaml yaml)
|
||||
```yaml
|
||||
# contains flag to control the terminationGracePeriodSeconds for the chaos pod(abort case)
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -167,5 +167,6 @@ spec:
|
|||
appkind: "deployment"
|
||||
chaosServiceAccount: pod-delete-sa
|
||||
experiments:
|
||||
- name: pod-delete
|
||||
- name: pod-delete
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -423,4 +423,4 @@ This section describes the fields in the ChaosExperiment and the possible values
|
|||
<th>Notes</th>
|
||||
<td> The <code>.spec.definition.hostPID</code> allows the developer to specify the host PID for the ChaosPod. </td>
|
||||
</tr>
|
||||
</table>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -30,4 +30,4 @@ This section describes the fields in the ChaosScheduler and the possible values
|
|||
<td>Defines the chaosengine specifications</td>
|
||||
<td><a href="/litmus/experiments/concepts/chaos-resources/chaos-scheduler/engine-specification">Engine Specifications</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ It embeds the ChaosEngine as a template inside schedule CR. Which contains the c
|
|||
|
||||
Specify the chaosengine details at `spec.engineTemplateSpec` inside schedule CR
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/ispeakc0de/litmus/scheduler/mkdocs/docs/experiments/chaos-resources/chaos-scheduler/repeat/basic-schema.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-scheduler/repeat/basic-schema.yaml yaml)
|
||||
```yaml
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
kind: ChaosSchedule
|
||||
|
|
@ -72,4 +72,4 @@ spec:
|
|||
# pod failures without '--force' & default terminationGracePeriodSeconds
|
||||
- name: FORCE
|
||||
value: 'false'
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ It schedule the chaos once either on the specified time or immediately after cre
|
|||
|
||||
It schedule the chaos immediately after creation of the chaos-schedule CR. It can be tuned via setting `spec.schedule.now` to `true`.
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/ispeakc0de/litmus/scheduler/mkdocs/docs/experiments/chaos-resources/chaos-scheduler/once/immediate.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-scheduler/once/immediate.yaml yaml)
|
||||
```yaml
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
kind: ChaosSchedule
|
||||
|
|
@ -105,7 +105,7 @@ spec:
|
|||
|
||||
It schedule the chaos once at the specified time. It can be tuned via setting `spec.schedule.once.executionTime`. The execution time should be in `UTC Timezone`.
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/ispeakc0de/litmus/scheduler/mkdocs/docs/experiments/chaos-resources/chaos-scheduler/once/specific-time.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-scheduler/once/specific-time.yaml yaml)
|
||||
```yaml
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
kind: ChaosSchedule
|
||||
|
|
|
|||
|
|
@ -146,7 +146,7 @@ It schedule the chaos in the repeat mode. There are various ways we can set up t
|
|||
|
||||
This will keep on executing the schedule and creating engines for an indefinite amount of time.
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/ispeakc0de/litmus/scheduler/mkdocs/docs/experiments/chaos-resources/chaos-scheduler/repeat/basic-schema.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-scheduler/repeat/basic-schema.yaml yaml)
|
||||
```yaml
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
kind: ChaosSchedule
|
||||
|
|
@ -189,7 +189,7 @@ spec:
|
|||
|
||||
This will manipulate the schedule to be started and ended according to our definition.
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/ispeakc0de/litmus/scheduler/mkdocs/docs/experiments/chaos-resources/chaos-scheduler/repeat/time-range.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-scheduler/repeat/time-range.yaml yaml)
|
||||
```yaml
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
kind: ChaosSchedule
|
||||
|
|
@ -236,7 +236,7 @@ spec:
|
|||
|
||||
Assumes the custom resource creation timestamp as the StartTime
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/ispeakc0de/litmus/scheduler/mkdocs/docs/experiments/chaos-resources/chaos-scheduler/repeat/just-endtime.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-scheduler/repeat/just-endtime.yaml yaml)
|
||||
```yaml
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
kind: ChaosSchedule
|
||||
|
|
@ -282,7 +282,7 @@ spec:
|
|||
|
||||
Executes chaos indefinitely (until the ChaosSchedule CR is removed) starting from the specified timestamp
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/ispeakc0de/litmus/scheduler/mkdocs/docs/experiments/chaos-resources/chaos-scheduler/repeat/just-starttime.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-scheduler/repeat/just-starttime.yaml yaml)
|
||||
```yaml
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
kind: ChaosSchedule
|
||||
|
|
@ -328,7 +328,7 @@ spec:
|
|||
### Specifying Work Hours
|
||||
This ensures chaos execution within the specified hours of the day, everyday.
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/ispeakc0de/litmus/scheduler/mkdocs/docs/experiments/chaos-resources/chaos-scheduler/repeat/work-hours.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-scheduler/repeat/work-hours.yaml yaml)
|
||||
```yaml
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
kind: ChaosSchedule
|
||||
|
|
@ -377,7 +377,7 @@ spec:
|
|||
### Specifying work days
|
||||
This executes chaos on specified days of the week, with the specified minimum interval.
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/ispeakc0de/litmus/scheduler/mkdocs/docs/experiments/chaos-resources/chaos-scheduler/repeat/work-days.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/chaos-scheduler/repeat/work-days.yaml yaml)
|
||||
```yaml
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
kind: ChaosSchedule
|
||||
|
|
|
|||
|
|
@ -57,4 +57,4 @@ kubectl edit chaosschedule schedule-nginx
|
|||
```
|
||||
spec:
|
||||
scheduleState: active
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -33,4 +33,4 @@ At the heart of the Litmus Platform are the chaos custom resources. This section
|
|||
<td>Contains the Probes specifications user-guide</td>
|
||||
<td><a href="/litmus/experiments/concepts/chaos-resources/probes/contents/">Probes</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -337,7 +337,7 @@ It can be tuned by setting `source` as `inline`.
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/cmdProbe/inline-mode.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/cmdProbe/inline-mode.yaml yaml)
|
||||
```yaml
|
||||
# execute the command inside the experiment pod itself
|
||||
# cases where command doesn't need any extra binaries which is not available in litmsuchaos/go-runner image
|
||||
|
|
@ -389,7 +389,7 @@ It can be tuned by setting `source` as `<source-image>`.
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/cmdProbe/source-mode.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/cmdProbe/source-mode.yaml yaml)
|
||||
```yaml
|
||||
# it launches the external pod with the source image and run the command inside the same pod
|
||||
# cases where command needs an extra binaries which is not available in litmsuchaos/go-runner image
|
||||
|
|
|
|||
|
|
@ -451,7 +451,7 @@ It can be executed by setting `httpProbe/inputs.method.get` field.
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/httpProbe/http-get.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/httpProbe/http-get.yaml yaml)
|
||||
```yaml
|
||||
# contains the http probes with get method and verify the response code
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -496,7 +496,7 @@ It can be executed by setting `httpProbe/inputs.method.post.body` field.
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/httpProbe/http-post-with-body.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/httpProbe/http-post-with-body.yaml yaml)
|
||||
```yaml
|
||||
# contains the http probes with post method and verify the response code
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -547,7 +547,7 @@ It can be executed by setting `httpProbe/inputs.method.post.body` field.
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/httpProbe/http-post-with-bodyPath.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/httpProbe/http-post-with-bodyPath.yaml yaml)
|
||||
```yaml
|
||||
# contains the http probes with post method and verify the response code
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -597,7 +597,7 @@ It is an optional field and its unit is milliseconds.
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/httpProbe/http-responseTimeout.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/httpProbe/http-responseTimeout.yaml yaml)
|
||||
```yaml
|
||||
# defines the response timeout for the http probe
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -641,7 +641,7 @@ It supports boolean values. Provide it to `true` to skip the certificate checks.
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/httpProbe/http-insecureSkipVerify.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/httpProbe/http-insecureSkipVerify.yaml yaml)
|
||||
```yaml
|
||||
# skip the certificate checks for the httpProbe
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
|
|||
|
|
@ -381,7 +381,7 @@ It creates kubernetes resource based on the data provided inside `probe.data` fi
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/k8sProbe/create-operation.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/k8sProbe/create-operation.yaml yaml)
|
||||
```yaml
|
||||
# create the given resource provided inside data field
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -442,7 +442,7 @@ It deletes matching kubernetes resources via GVR and filters (field selectors/la
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/k8sProbe/delete-operation.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/k8sProbe/delete-operation.yaml yaml)
|
||||
```yaml
|
||||
# delete the resource matched with the given inputs
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -492,7 +492,7 @@ It checks for the presence of kubernetes resource based on GVR and filters (fiel
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/k8sProbe/present-operation.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/k8sProbe/present-operation.yaml yaml)
|
||||
```yaml
|
||||
# verify the existance of the resource matched with the given inputs inside cluster
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -542,7 +542,7 @@ It checks for the absence of kubernetes resource based on GVR and filters (field
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/k8sProbe/absent-operation.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/k8sProbe/absent-operation.yaml yaml)
|
||||
```yaml
|
||||
# verify that the no resource should be present in cluster with the given inputs
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ The probes can be set up to run in five different modes. Which can be tuned via
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/common/probe-modes.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/common/probe-modes.yaml yaml)
|
||||
```yaml
|
||||
# contains the common attributes or run properties
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -62,7 +62,7 @@ All probes share some common attributes. Which can be tuned via `runProperties`
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/common/runproperties.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/common/runproperties.yaml yaml)
|
||||
```yaml
|
||||
# contains the common attributes or run properties
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -112,7 +112,7 @@ It Represents the initial waiting time interval for the probes. It can be tuned
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/common/initial-delay-seconds.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/common/initial-delay-seconds.yaml yaml)
|
||||
```yaml
|
||||
# contains the initial delay seconds for the probes
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -159,7 +159,7 @@ It supports boolean values. The default value is `false`.
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/common/stop-on-failure.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/common/stop-on-failure.yaml yaml)
|
||||
```yaml
|
||||
# contains the flag to stop/continue experiment based on the specified flag
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -207,7 +207,7 @@ Probe chaining enables reuse of probe a result (represented by the template func
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/common/probe-chaining.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/common/probe-chaining.yaml yaml)
|
||||
```yaml
|
||||
# chaining enables reuse of probe's result (represented by the template function {{ <probeName>.probeArtifact.Register}})
|
||||
#-- in subsequent "downstream" probes defined in the ChaosEngine.
|
||||
|
|
|
|||
|
|
@ -337,7 +337,7 @@ It can be executed by setting `.promProbe/inputs.query` field.
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/promProbe/prom-probe-with-query.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/promProbe/prom-probe-with-query.yaml yaml)
|
||||
```yaml
|
||||
# contains the prom probe which execute the query and match for the expected criteria
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
@ -384,7 +384,7 @@ It can be executed by setting `promProbe/inputs.queryPath` field.
|
|||
|
||||
Use the following example to tune this:
|
||||
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/chaos-resources/probes/promProbe/prom-probe-with-queryPath.yaml yaml)
|
||||
[embedmd]:# (https://raw.githubusercontent.com/litmuschaos/litmus/master/mkdocs/docs/experiments/concepts/chaos-resources/probes/promProbe/prom-probe-with-queryPath.yaml yaml)
|
||||
```yaml
|
||||
# contains the prom probe which execute the query and match for the expected criteria
|
||||
apiVersion: litmuschaos.io/v1alpha1
|
||||
|
|
|
|||
Loading…
Reference in New Issue