chore: Fixes probe run properties and headings (#261)

Signed-off-by: neelanjan00 <neelanjan.manna@harness.io>
This commit is contained in:
Neelanjan Manna 2024-06-14 19:01:36 +05:30 committed by GitHub
parent 67ae0c3ce9
commit a27b61853c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 49 additions and 49 deletions

View File

@ -35,10 +35,10 @@ Some common attributes shared between the Probes:
- **probeTimeout**: Represents the time limit for the probe to execute the check specified and return the expected data. - **probeTimeout**: Represents the time limit for the probe to execute the check specified and return the expected data.
- **retry**: The number of times a check is re-run upon failure in the first attempt before declaring the probe status as failed. - **retry**: The number of times a check is re-run upon failure in the first attempt before declaring the probe status as failed.
- **interval**: The period between subsequent retries - **interval**: The period between subsequent retries.
- **probePollingInterval**: The time interval for which continuous probe should be sleep after each iteration - **probePollingInterval**: The time interval for which continuous probe should be sleep after each iteration.
- **initialDelaySeconds**: Represents the initial waiting time interval for the probes. - **initialDelay**: Represents the initial waiting time interval for the probes.
- **stopOnFailure**: It can be set to true/false to stop or continue the fault execution after probe fails - **stopOnFailure**: It can be set to true/false to stop or continue the fault execution after probe fails.
:::note :::note
If probe needs any additional RBAC permissions other than the fault's serviceAccount `(<fault-name>-sa)` permissions, then the additional permissions should be provided inside the corresponding Role/ClusterRole bind with the serviceAccount `(<fault-name>-sa)`. If probe needs any additional RBAC permissions other than the fault's serviceAccount `(<fault-name>-sa)` permissions, then the additional permissions should be provided inside the corresponding Role/ClusterRole bind with the serviceAccount `(<fault-name>-sa)`.
@ -73,10 +73,10 @@ probe:
responseCode: '<response code>' responseCode: '<response code>'
mode: 'Continuous' mode: 'Continuous'
runProperties: runProperties:
probeTimeout: 5 probeTimeout: 5s
interval: 5 interval: 5s
retry: 1 retry: 1
probePollingInterval: 2 probePollingInterval: 2s
``` ```
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. 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:
hostNetwork: false hostNetwork: false
mode: 'Edge' mode: 'Edge'
runProperties: runProperties:
probeTimeout: 5 probeTimeout: 5s
interval: 5 interval: 5s
retry: 1 retry: 1
initialDelaySeconds: 5 initialDelay: 5s
``` ```
> `source.hostNetwork` can be set to `true` to allow access to the node network namespace for the pod executing the probe > `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:
operation: 'present' # it can be present, absent, create, delete operation: 'present' # it can be present, absent, create, delete
mode: 'EOT' mode: 'EOT'
runProperties: runProperties:
probeTimeout: 5 probeTimeout: 5s
interval: 5 interval: 5s
retry: 1 retry: 1
``` ```
@ -162,8 +162,8 @@ probe:
value: '<value-for-criteria-match>' value: '<value-for-criteria-match>'
mode: 'Edge' mode: 'Edge'
runProperties: runProperties:
probeTimeout: 5 probeTimeout: 5s
interval: 5 interval: 5s
retry: 1 retry: 1
``` ```
@ -247,8 +247,8 @@ probe:
source: 'inline' source: 'inline'
mode: 'SOT' mode: 'SOT'
runProperties: runProperties:
probeTimeout: 5 probeTimeout: 5s
interval: 5 interval: 5s
retry: 1 retry: 1
- name: 'probe2' - name: 'probe2'
type: 'cmdProbe' type: 'cmdProbe'
@ -262,8 +262,8 @@ probe:
source: 'inline' source: 'inline'
mode: 'SOT' mode: 'SOT'
runProperties: runProperties:
probeTimeout: 5 probeTimeout: 5s
interval: 5 interval: 5s
retry: 1 retry: 1
``` ```
@ -921,7 +921,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr> </tr>
<tr> <tr>
<th>Range</th> <th>Range</th>
<td>n/a <code>type: integer</code></td> <td>n/a <code>type: string</code></td>
</tr> </tr>
<tr> <tr>
<th>Notes</th> <th>Notes</th>
@ -967,7 +967,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr> </tr>
<tr> <tr>
<th>Range</th> <th>Range</th>
<td>n/a <code>type: integer</code></td> <td>n/a <code>type: string</code></td>
</tr> </tr>
<tr> <tr>
<th>Notes</th> <th>Notes</th>
@ -990,7 +990,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr> </tr>
<tr> <tr>
<th>Range</th> <th>Range</th>
<td>n/a <code>type: integer</code></td> <td>n/a <code>type: string</code></td>
</tr> </tr>
<tr> <tr>
<th>Notes</th> <th>Notes</th>
@ -1001,7 +1001,7 @@ This section describes the different fields of the litmus probes and the possibl
<table> <table>
<tr> <tr>
<th>Field</th> <th>Field</th>
<td><code>.runProperties.initialDelaySeconds</code></td> <td><code>.runProperties.initialDelay</code></td>
</tr> </tr>
<tr> <tr>
<th>Description</th> <th>Description</th>
@ -1013,7 +1013,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr> </tr>
<tr> <tr>
<th>Range</th> <th>Range</th>
<td>n/a <code>type: integer</code></td> <td>n/a <code>type: string</code></td>
</tr> </tr>
<tr> <tr>
<th>Notes</th> <th>Notes</th>

View File

@ -1,7 +1,7 @@
--- ---
id: chaos-infrastructure-installation id: chaos-infrastructure-installation
title: chaos-infrastructure-installation title: Chaos Infrastructure Installation
sidebar_label: chaos-infrastructure-installation sidebar_label: Chaos Infrastructure Installation
--- ---
--- ---

View File

@ -37,7 +37,7 @@ Some common attributes shared between the Probes:
- **retry**: The number of times a check is re-run upon failure in the first attempt before declaring the probe status as failed. - **retry**: The number of times a check is re-run upon failure in the first attempt before declaring the probe status as failed.
- **interval**: The period between subsequent retries - **interval**: The period between subsequent retries
- **probePollingInterval**: The time interval for which continuous probe should be sleep after each iteration - **probePollingInterval**: The time interval for which continuous probe should be sleep after each iteration
- **initialDelaySeconds**: Represents the initial waiting time interval for the probes. - **initialDelay**: Represents the initial waiting time interval for the probes.
- **stopOnFailure**: It can be set to true/false to stop or continue the fault execution after probe fails - **stopOnFailure**: It can be set to true/false to stop or continue the fault execution after probe fails
:::note :::note
@ -73,10 +73,10 @@ probe:
responseCode: '<response code>' responseCode: '<response code>'
mode: 'Continuous' mode: 'Continuous'
runProperties: runProperties:
probeTimeout: 5 probeTimeout: 5s
interval: 5 interval: 5s
retry: 1 retry: 1
probePollingInterval: 2 probePollingInterval: 2s
``` ```
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. 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:
hostNetwork: false hostNetwork: false
mode: 'Edge' mode: 'Edge'
runProperties: runProperties:
probeTimeout: 5 probeTimeout: 5s
interval: 5 interval: 5s
retry: 1 retry: 1
initialDelaySeconds: 5 initialDelay: 5s
``` ```
> `source.hostNetwork` can be set to `true` to allow access to the node network namespace for the pod executing the probe > `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:
operation: 'present' # it can be present, absent, create, delete operation: 'present' # it can be present, absent, create, delete
mode: 'EOT' mode: 'EOT'
runProperties: runProperties:
probeTimeout: 5 probeTimeout: 5s
interval: 5 interval: 5s
retry: 1 retry: 1
``` ```
@ -162,8 +162,8 @@ probe:
value: '<value-for-criteria-match>' value: '<value-for-criteria-match>'
mode: 'Edge' mode: 'Edge'
runProperties: runProperties:
probeTimeout: 5 probeTimeout: 5s
interval: 5 interval: 5s
retry: 1 retry: 1
``` ```
@ -247,10 +247,10 @@ probe:
source: 'inline' source: 'inline'
mode: 'SOT' mode: 'SOT'
runProperties: runProperties:
probeTimeout: 5 probeTimeout: 5s
interval: 5 interval: 5s
retry: 1 retry: 1
- name: 'probe2' - name: 'probe2's
type: 'cmdProbe' type: 'cmdProbe'
cmdProbe/inputs: cmdProbe/inputs:
## probe1's result being used as one of the args in probe2 ## probe1's result being used as one of the args in probe2
@ -262,8 +262,8 @@ probe:
source: 'inline' source: 'inline'
mode: 'SOT' mode: 'SOT'
runProperties: runProperties:
probeTimeout: 5 probeTimeout: 5s
interval: 5 interval: 5s
retry: 1 retry: 1
``` ```
@ -921,7 +921,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr> </tr>
<tr> <tr>
<th>Range</th> <th>Range</th>
<td>n/a <code>type: integer</code></td> <td>n/a <code>type: string</code></td>
</tr> </tr>
<tr> <tr>
<th>Notes</th> <th>Notes</th>
@ -967,7 +967,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr> </tr>
<tr> <tr>
<th>Range</th> <th>Range</th>
<td>n/a <code>type: integer</code></td> <td>n/a <code>type: string</code></td>
</tr> </tr>
<tr> <tr>
<th>Notes</th> <th>Notes</th>
@ -990,7 +990,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr> </tr>
<tr> <tr>
<th>Range</th> <th>Range</th>
<td>n/a <code>type: integer</code></td> <td>n/a <code>type: string</code></td>
</tr> </tr>
<tr> <tr>
<th>Notes</th> <th>Notes</th>
@ -1001,7 +1001,7 @@ This section describes the different fields of the litmus probes and the possibl
<table> <table>
<tr> <tr>
<th>Field</th> <th>Field</th>
<td><code>.runProperties.initialDelaySeconds</code></td> <td><code>.runProperties.initialDelay</code></td>
</tr> </tr>
<tr> <tr>
<th>Description</th> <th>Description</th>
@ -1013,11 +1013,11 @@ This section describes the different fields of the litmus probes and the possibl
</tr> </tr>
<tr> <tr>
<th>Range</th> <th>Range</th>
<td>n/a <code>type: integer</code></td> <td>n/a <code>type: string</code></td>
</tr> </tr>
<tr> <tr>
<th>Notes</th> <th>Notes</th>
<td>The <code>.runProperties.initialDelaySeconds</code> represents the initial waiting time interval for the probes.</td> <td>The <code>.runProperties.initialDelay</code> represents the initial waiting time interval for the probes.</td>
</tr> </tr>
</table> </table>

View File

@ -1,7 +1,7 @@
--- ---
id: chaos-infrastructure-installation id: chaos-infrastructure-installation
title: chaos-infrastructure-installation title: Chaos Infrastructure Installation
sidebar_label: chaos-infrastructure-installation sidebar_label: Chaos Infrastructure Installation
--- ---
--- ---