diff --git a/website/docs/concepts/probes.md b/website/docs/concepts/probes.md index 0b37d464..57459cb0 100644 --- a/website/docs/concepts/probes.md +++ b/website/docs/concepts/probes.md @@ -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 `(-sa)` permissions, then the additional permissions should be provided inside the corresponding Role/ClusterRole bind with the serviceAccount `(-sa)`. @@ -73,10 +73,10 @@ probe: responseCode: '' 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. @@ -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 @@ -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 ``` @@ -162,8 +162,8 @@ probe: value: '' mode: 'Edge' runProperties: - probeTimeout: 5 - interval: 5 + probeTimeout: 5s + interval: 5s retry: 1 ``` @@ -247,8 +247,8 @@ probe: source: 'inline' mode: 'SOT' runProperties: - probeTimeout: 5 - interval: 5 + probeTimeout: 5s + interval: 5s retry: 1 - name: 'probe2' type: 'cmdProbe' @@ -262,8 +262,8 @@ probe: source: 'inline' mode: 'SOT' runProperties: - probeTimeout: 5 - interval: 5 + probeTimeout: 5s + interval: 5s retry: 1 ``` @@ -921,7 +921,7 @@ This section describes the different fields of the litmus probes and the possibl Range - n/a type: integer + n/a type: string Notes @@ -967,7 +967,7 @@ This section describes the different fields of the litmus probes and the possibl Range - n/a type: integer + n/a type: string Notes @@ -990,7 +990,7 @@ This section describes the different fields of the litmus probes and the possibl Range - n/a type: integer + n/a type: string Notes @@ -1001,7 +1001,7 @@ This section describes the different fields of the litmus probes and the possibl - + @@ -1013,7 +1013,7 @@ This section describes the different fields of the litmus probes and the possibl - + diff --git a/website/docs/user-guides/chaos-infrastructure-installation.md b/website/docs/user-guides/chaos-infrastructure-installation.md index b2f28d6b..f80768db 100644 --- a/website/docs/user-guides/chaos-infrastructure-installation.md +++ b/website/docs/user-guides/chaos-infrastructure-installation.md @@ -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 --- --- diff --git a/website/versioned_docs/version-3.0.0/concepts/probes.md b/website/versioned_docs/version-3.0.0/concepts/probes.md index 0b37d464..00bdb159 100644 --- a/website/versioned_docs/version-3.0.0/concepts/probes.md +++ b/website/versioned_docs/version-3.0.0/concepts/probes.md @@ -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 @@ -73,10 +73,10 @@ probe: responseCode: '' 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. @@ -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 @@ -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 ``` @@ -162,8 +162,8 @@ probe: value: '' mode: 'Edge' runProperties: - probeTimeout: 5 - interval: 5 + probeTimeout: 5s + interval: 5s retry: 1 ``` @@ -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 @@ -262,8 +262,8 @@ probe: source: 'inline' mode: 'SOT' runProperties: - probeTimeout: 5 - interval: 5 + probeTimeout: 5s + interval: 5s retry: 1 ``` @@ -921,7 +921,7 @@ This section describes the different fields of the litmus probes and the possibl - + @@ -967,7 +967,7 @@ This section describes the different fields of the litmus probes and the possibl - + @@ -990,7 +990,7 @@ This section describes the different fields of the litmus probes and the possibl - + @@ -1001,7 +1001,7 @@ This section describes the different fields of the litmus probes and the possibl
Field.runProperties.initialDelaySeconds.runProperties.initialDelay
Description
Rangen/a type: integern/a type: string
Notes
Rangen/a type: integern/a type: string
Notes
Rangen/a type: integern/a type: string
Notes
Rangen/a type: integern/a type: string
Notes
- + @@ -1013,11 +1013,11 @@ This section describes the different fields of the litmus probes and the possibl - + - +
Field.runProperties.initialDelaySeconds.runProperties.initialDelay
Description
Rangen/a type: integern/a type: string
NotesThe .runProperties.initialDelaySeconds represents the initial waiting time interval for the probes.The .runProperties.initialDelay represents the initial waiting time interval for the probes.
diff --git a/website/versioned_docs/version-3.0.0/user-guides/chaos-infrastructure-installation.md b/website/versioned_docs/version-3.0.0/user-guides/chaos-infrastructure-installation.md index b2f28d6b..f80768db 100644 --- a/website/versioned_docs/version-3.0.0/user-guides/chaos-infrastructure-installation.md +++ b/website/versioned_docs/version-3.0.0/user-guides/chaos-infrastructure-installation.md @@ -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 --- ---