Skip to content

Commit 682c297

Browse files
authored
Update probes.md
Fix probe runProperties timing types.
1 parent 94e91c5 commit 682c297

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

website/docs/concepts/probes.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ These probes can be used in isolation or in several combinations to achieve the
2525

2626
The probes can be set up to run in different modes:
2727

28-
- **SoT**: Executed at the Start of Test as a pre-chaos check
29-
- **EoT**: Executed at the End of Test as a post-chaos check
28+
- **SOT**: Executed at the Start of Test as a pre-chaos check
29+
- **EOT**: Executed at the End of Test as a post-chaos check
3030
- **Edge**: Executed both, before and after the chaos
3131
- **Continuous**: The probe is executed continuously, with a specified polling interval during the chaos injection.
3232
- **OnChaos**: The probe is executed continuously, with a specified polling interval strictly for chaos duration of chaos
@@ -37,7 +37,7 @@ Some common attributes shared between the Probes:
3737
- **retry**: The number of times a check is re-run upon failure in the first attempt before declaring the probe status as failed.
3838
- **interval**: The period between subsequent retries
3939
- **probePollingInterval**: The time interval for which continuous probe should be sleep after each iteration
40-
- **initialDelaySeconds**: Represents the initial waiting time interval for the probes.
40+
- **initialDelay**: Represents the initial waiting time interval for the probes.
4141
- **stopOnFailure**: It can be set to true/false to stop or continue the fault execution after probe fails
4242

4343
:::note
@@ -73,10 +73,10 @@ probe:
7373
responseCode: '<response code>'
7474
mode: 'Continuous'
7575
runProperties:
76-
probeTimeout: 5
77-
interval: 5
76+
probeTimeout: 5s
77+
interval: 5s
7878
retry: 1
79-
probePollingInterval: 2
79+
probePollingInterval: 2s
8080
```
8181
8282
The `httpProbe` is better used in the Continuous mode of operation as a parallel liveness indicator of a target or downstream application. It uses the `probePollingInterval` property to specify the polling interval for the access checks.
@@ -104,10 +104,10 @@ probe:
104104
hostNetwork: false
105105
mode: 'Edge'
106106
runProperties:
107-
probeTimeout: 5
108-
interval: 5
107+
probeTimeout: 5s
108+
interval: 5s
109109
retry: 1
110-
initialDelaySeconds: 5
110+
initialDelay: 5s
111111
```
112112

113113
> `source.hostNetwork` can be set to `true` to allow access to the node network namespace for the pod executing the probe
@@ -137,8 +137,8 @@ probe:
137137
operation: 'present' # it can be present, absent, create, delete
138138
mode: 'EOT'
139139
runProperties:
140-
probeTimeout: 5
141-
interval: 5
140+
probeTimeout: 5s
141+
interval: 5s
142142
retry: 1
143143
```
144144

@@ -162,8 +162,8 @@ probe:
162162
value: '<value-for-criteria-match>'
163163
mode: 'Edge'
164164
runProperties:
165-
probeTimeout: 5
166-
interval: 5
165+
probeTimeout: 5s
166+
interval: 5s
167167
retry: 1
168168
```
169169

@@ -247,8 +247,8 @@ probe:
247247
source: 'inline'
248248
mode: 'SOT'
249249
runProperties:
250-
probeTimeout: 5
251-
interval: 5
250+
probeTimeout: 5s
251+
interval: 5s
252252
retry: 1
253253
- name: 'probe2'
254254
type: 'cmdProbe'
@@ -262,8 +262,8 @@ probe:
262262
source: 'inline'
263263
mode: 'SOT'
264264
runProperties:
265-
probeTimeout: 5
266-
interval: 5
265+
probeTimeout: 5s
266+
interval: 5s
267267
retry: 1
268268
```
269269

@@ -921,11 +921,11 @@ This section describes the different fields of the litmus probes and the possibl
921921
</tr>
922922
<tr>
923923
<th>Range</th>
924-
<td>n/a <code>type: integer</code></td>
924+
<td>n/a <code>type: string</code></td>
925925
</tr>
926926
<tr>
927927
<th>Notes</th>
928-
<td>The <code>.runProperties.probeTimeout</code> represents the time limit for the probe to execute the specified check and return the expected data</td>
928+
<td>The <code>.runProperties.probeTimeout</code> represents the time limit for the probe to execute the specified check and return the expected data. Examples: <code>5s</code>, <code>5m</code>, <code>1h</code></td>
929929
</tr>
930930
</table>
931931

@@ -967,11 +967,11 @@ This section describes the different fields of the litmus probes and the possibl
967967
</tr>
968968
<tr>
969969
<th>Range</th>
970-
<td>n/a <code>type: integer</code></td>
970+
<td>n/a <code>type: string</code></td>
971971
</tr>
972972
<tr>
973973
<th>Notes</th>
974-
<td>The <code>.runProperties.interval</code> contains the interval for which probes waits between subsequent retries</td>
974+
<td>The <code>.runProperties.interval</code> contains the interval for which probes waits between subsequent retries. Examples: <code>5s</code>, <code>5m</code>, <code>1h</code></td>
975975
</tr>
976976
</table>
977977

@@ -990,18 +990,18 @@ This section describes the different fields of the litmus probes and the possibl
990990
</tr>
991991
<tr>
992992
<th>Range</th>
993-
<td>n/a <code>type: integer</code></td>
993+
<td>n/a <code>type: string</code></td>
994994
</tr>
995995
<tr>
996996
<th>Notes</th>
997-
<td>The <code>.runProperties.probePollingInterval</code> contains the time interval for which continuous probe should be sleep after each iteration</td>
997+
<td>The <code>.runProperties.probePollingInterval</code> contains the time interval for which continuous probe should be sleep after each iteration. Examples: <code>5s</code>, <code>5m</code>, <code>1h</code></td>
998998
</tr>
999999
</table>
10001000

10011001
<table>
10021002
<tr>
10031003
<th>Field</th>
1004-
<td><code>.runProperties.initialDelaySeconds</code></td>
1004+
<td><code>.runProperties.initialDelay</code></td>
10051005
</tr>
10061006
<tr>
10071007
<th>Description</th>
@@ -1013,11 +1013,11 @@ This section describes the different fields of the litmus probes and the possibl
10131013
</tr>
10141014
<tr>
10151015
<th>Range</th>
1016-
<td>n/a <code>type: integer</code></td>
1016+
<td>n/a <code>type: string</code></td>
10171017
</tr>
10181018
<tr>
10191019
<th>Notes</th>
1020-
<td>The <code>.runProperties.initialDelaySeconds</code> represents the initial waiting time interval for the probes.</td>
1020+
<td>The <code>.runProperties.initialDelaySeconds</code> represents the initial waiting time interval for the probes. Examples: <code>5s</code>, <code>5m</code>, <code>1h</code></td>
10211021
</tr>
10221022
</table>
10231023

@@ -1119,7 +1119,7 @@ This section describes the different fields of the litmus probes and the possibl
11191119

11201120
Probes are pluggable checks that can be defined within the ChaosEngine for any Chaos Experiment. There are four kinds of probes `httpProbe` (allows developers to specify a URL which the fault uses to gauge health/service availability as part of the entry/exit criteria), `cmdProbe` (allows developers to run shell commands and match the resulting output as part of the entry/exit criteria), `k8sProbe` (addresses verification of the desired resource state by allowing users to define the Kubernetes GVR with appropriate filters) and `promProbe` (allows users to run Prometheus queries and match the resulting output against specific conditions).
11211121

1122-
The different modes these probes can be used in are `SoT`, `EoT`, `Edge`, `Continuous` and `OnChaos`. The litmus chaos faults run the probes defined in the ChaosEngine and update their stage-wise success in the ChaosResult custom resource with `probeSuccessPercentage`. A `probeSuccessPercentage` is the ratio of successful checks v/s total probes.
1122+
The different modes these probes can be used in are `SOT`, `EOT`, `Edge`, `Continuous` and `OnChaos`. The litmus chaos faults run the probes defined in the ChaosEngine and update their stage-wise success in the ChaosResult custom resource with `probeSuccessPercentage`. A `probeSuccessPercentage` is the ratio of successful checks v/s total probes.
11231123

11241124
Probes can be Chained, Probe chaining enables reuse of probe, the order of execution of probes in the fault depends purely on the order in which they are defined in the ChaosEngine.
11251125

0 commit comments

Comments
 (0)