Skip to content

chore: Fixes probe run properties and headings #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 14, 2024
Merged

chore: Fixes probe run properties and headings #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions website/docs/concepts/probes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
- **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
- **probePollingInterval**: The time interval for which continuous probe should be sleep after each iteration
- **initialDelaySeconds**: 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
- **interval**: The period between subsequent retries.
- **probePollingInterval**: The time interval for which continuous probe should be sleep after each iteration.
- **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.

:::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)`.
Expand Down Expand Up @@ -73,10 +73,10 @@ probe:
responseCode: '<response code>'
mode: 'Continuous'
runProperties:
probeTimeout: 5
interval: 5
probeTimeout: 5s
interval: 5s
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.
Expand Down Expand Up @@ -104,10 +104,10 @@ probe:
hostNetwork: false
mode: 'Edge'
runProperties:
probeTimeout: 5
interval: 5
probeTimeout: 5s
interval: 5s
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
Expand Down Expand Up @@ -137,8 +137,8 @@ probe:
operation: 'present' # it can be present, absent, create, delete
mode: 'EOT'
runProperties:
probeTimeout: 5
interval: 5
probeTimeout: 5s
interval: 5s
retry: 1
```

Expand All @@ -162,8 +162,8 @@ probe:
value: '<value-for-criteria-match>'
mode: 'Edge'
runProperties:
probeTimeout: 5
interval: 5
probeTimeout: 5s
interval: 5s
retry: 1
```

Expand Down Expand Up @@ -247,8 +247,8 @@ probe:
source: 'inline'
mode: 'SOT'
runProperties:
probeTimeout: 5
interval: 5
probeTimeout: 5s
interval: 5s
retry: 1
- name: 'probe2'
type: 'cmdProbe'
Expand All @@ -262,8 +262,8 @@ probe:
source: 'inline'
mode: 'SOT'
runProperties:
probeTimeout: 5
interval: 5
probeTimeout: 5s
interval: 5s
retry: 1
```

Expand Down Expand Up @@ -921,7 +921,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr>
<tr>
<th>Range</th>
<td>n/a <code>type: integer</code></td>
<td>n/a <code>type: string</code></td>
</tr>
<tr>
<th>Notes</th>
Expand Down Expand Up @@ -967,7 +967,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr>
<tr>
<th>Range</th>
<td>n/a <code>type: integer</code></td>
<td>n/a <code>type: string</code></td>
</tr>
<tr>
<th>Notes</th>
Expand All @@ -990,7 +990,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr>
<tr>
<th>Range</th>
<td>n/a <code>type: integer</code></td>
<td>n/a <code>type: string</code></td>
</tr>
<tr>
<th>Notes</th>
Expand All @@ -1001,7 +1001,7 @@ This section describes the different fields of the litmus probes and the possibl
<table>
<tr>
<th>Field</th>
<td><code>.runProperties.initialDelaySeconds</code></td>
<td><code>.runProperties.initialDelay</code></td>
</tr>
<tr>
<th>Description</th>
Expand All @@ -1013,7 +1013,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr>
<tr>
<th>Range</th>
<td>n/a <code>type: integer</code></td>
<td>n/a <code>type: string</code></td>
</tr>
<tr>
<th>Notes</th>
Expand Down
4 changes: 2 additions & 2 deletions website/docs/user-guides/chaos-infrastructure-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: chaos-infrastructure-installation
title: chaos-infrastructure-installation
sidebar_label: chaos-infrastructure-installation
title: Chaos Infrastructure Installation
sidebar_label: Chaos Infrastructure Installation
---

---
Expand Down
44 changes: 22 additions & 22 deletions website/versioned_docs/version-3.0.0/concepts/probes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
- **interval**: The period between subsequent retries
- **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

:::note
Expand Down Expand Up @@ -73,10 +73,10 @@ probe:
responseCode: '<response code>'
mode: 'Continuous'
runProperties:
probeTimeout: 5
interval: 5
probeTimeout: 5s
interval: 5s
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.
Expand Down Expand Up @@ -104,10 +104,10 @@ probe:
hostNetwork: false
mode: 'Edge'
runProperties:
probeTimeout: 5
interval: 5
probeTimeout: 5s
interval: 5s
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
Expand Down Expand Up @@ -137,8 +137,8 @@ probe:
operation: 'present' # it can be present, absent, create, delete
mode: 'EOT'
runProperties:
probeTimeout: 5
interval: 5
probeTimeout: 5s
interval: 5s
retry: 1
```

Expand All @@ -162,8 +162,8 @@ probe:
value: '<value-for-criteria-match>'
mode: 'Edge'
runProperties:
probeTimeout: 5
interval: 5
probeTimeout: 5s
interval: 5s
retry: 1
```

Expand Down Expand Up @@ -247,10 +247,10 @@ probe:
source: 'inline'
mode: 'SOT'
runProperties:
probeTimeout: 5
interval: 5
probeTimeout: 5s
interval: 5s
retry: 1
- name: 'probe2'
- name: 'probe2's
type: 'cmdProbe'
cmdProbe/inputs:
## probe1's result being used as one of the args in probe2
Expand All @@ -262,8 +262,8 @@ probe:
source: 'inline'
mode: 'SOT'
runProperties:
probeTimeout: 5
interval: 5
probeTimeout: 5s
interval: 5s
retry: 1
```

Expand Down Expand Up @@ -921,7 +921,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr>
<tr>
<th>Range</th>
<td>n/a <code>type: integer</code></td>
<td>n/a <code>type: string</code></td>
</tr>
<tr>
<th>Notes</th>
Expand Down Expand Up @@ -967,7 +967,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr>
<tr>
<th>Range</th>
<td>n/a <code>type: integer</code></td>
<td>n/a <code>type: string</code></td>
</tr>
<tr>
<th>Notes</th>
Expand All @@ -990,7 +990,7 @@ This section describes the different fields of the litmus probes and the possibl
</tr>
<tr>
<th>Range</th>
<td>n/a <code>type: integer</code></td>
<td>n/a <code>type: string</code></td>
</tr>
<tr>
<th>Notes</th>
Expand All @@ -1001,7 +1001,7 @@ This section describes the different fields of the litmus probes and the possibl
<table>
<tr>
<th>Field</th>
<td><code>.runProperties.initialDelaySeconds</code></td>
<td><code>.runProperties.initialDelay</code></td>
</tr>
<tr>
<th>Description</th>
Expand All @@ -1013,11 +1013,11 @@ This section describes the different fields of the litmus probes and the possibl
</tr>
<tr>
<th>Range</th>
<td>n/a <code>type: integer</code></td>
<td>n/a <code>type: string</code></td>
</tr>
<tr>
<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>
</table>

Expand Down
4 changes: 2 additions & 2 deletions ...e/versioned_docs/version-3.0.0/user-guides/chaos-infrastructure-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: chaos-infrastructure-installation
title: chaos-infrastructure-installation
sidebar_label: chaos-infrastructure-installation
title: Chaos Infrastructure Installation
sidebar_label: Chaos Infrastructure Installation
---

---
Expand Down