Skip to content

Commit 7bdf7b6

Browse files
authored
K8SPS-574 Renamed pmm.readinessProbe and pmm.livenessProbe options (#154)
modified: docs/monitoring.md modified: docs/operator.md
1 parent ac59896 commit 7bdf7b6

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

docs/monitoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ PMM Client has the following probes:
1111
* **Readiness probe** determines when a PMM Client is available and ready to accept traffic
1212
* **Liveness probe** determines when to restart a PMM Client
1313

14-
To configure probes, use the `spec.pmm.readinessProbes` and `spec.pmm.livenessProbes` Custom Resource options.
14+
To configure probes, use the `spec.pmm.readinessProbe` and `spec.pmm.livenessProbe` Custom Resource options.
1515

docs/operator.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2155,79 +2155,79 @@ Enables to pass MySQL parameters to PMM. For example, to change the number of ta
21552155
| ----------- | ---------- |
21562156
| :material-code-string: string | `"--disable-tablestats-limit=2000"` |
21572157

2158-
### `pmm.readinessProbes.initialDelaySeconds`
2158+
### `pmm.readinessProbe.initialDelaySeconds`
21592159

21602160
The number of seconds to wait before performing the first [readiness probe :octicons-link-external-16:](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/).
21612161

21622162
| Value type | Example |
21632163
| ----------- | ---------- |
21642164
| :material-numeric-1-box: int | `15` |
21652165

2166-
### `pmm.readinessProbes.timeoutSeconds`
2166+
### `pmm.readinessProbe.timeoutSeconds`
21672167

21682168
The number of seconds after which the [readiness probe :octicons-link-external-16:](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) times out.
21692169

21702170
| Value type | Example |
21712171
| ----------- | ---------- |
21722172
| :material-numeric-1-box: int | `15` |
21732173

2174-
### `pmm.readinessProbes.periodSeconds`
2174+
### `pmm.readinessProbe.periodSeconds`
21752175

21762176
How often to perform the [readiness probe :octicons-link-external-16:](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/). Measured in seconds.
21772177

21782178
| Value type | Example |
21792179
| ----------- | ---------- |
21802180
| :material-numeric-1-box: int | `30` |
21812181

2182-
### `pmm.readinessProbes.successThreshold`
2182+
### `pmm.readinessProbe.successThreshold`
21832183

21842184
The number of successful probes required to mark the container successful.
21852185

21862186
| Value type | Example |
21872187
| ----------- | ---------- |
21882188
| :material-numeric-1-box: int | `1` |
21892189

2190-
### `pmm.readinessProbes.failureThreshold`
2190+
### `pmm.readinessProbe.failureThreshold`
21912191

21922192
The number of failed probes required to mark the container unready.
21932193

21942194
| Value type | Example |
21952195
| ----------- | ---------- |
21962196
| :material-numeric-1-box: int | `5` |
21972197

2198-
### `pmm.livenessProbes.initialDelaySeconds`
2198+
### `pmm.livenessProbe.initialDelaySeconds`
21992199

22002200
The number of seconds to wait before performing the first [liveness probe :octicons-link-external-16:](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/).
22012201

22022202
| Value type | Example |
22032203
| ----------- | ---------- |
22042204
| :material-numeric-1-box: int | `300` |
22052205

2206-
### `pmm.livenessProbes.timeoutSeconds`
2206+
### `pmm.livenessProbe.timeoutSeconds`
22072207

22082208
The number of seconds after which the [liveness probe :octicons-link-external-16:](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) times out.
22092209

22102210
| Value type | Example |
22112211
| ----------- | ---------- |
22122212
| :material-numeric-1-box: int | `5` |
22132213

2214-
### `pmm.livenessProbes.periodSeconds`
2214+
### `pmm.livenessProbe.periodSeconds`
22152215

22162216
How often to perform the [liveness probe :octicons-link-external-16:](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/). Measured in seconds.
22172217

22182218
| Value type | Example |
22192219
| ----------- | ---------- |
22202220
| :material-numeric-1-box: int | `10` |
22212221

2222-
### `pmm.livenessProbes.successThreshold`
2222+
### `pmm.livenessProbe.successThreshold`
22232223

22242224
The number of successful probes required to mark the container successful.
22252225

22262226
| Value type | Example |
22272227
| ----------- | ---------- |
22282228
| :material-numeric-1-box: int | `1` |
22292229

2230-
### `pmm.livenessProbes.failureThreshold`
2230+
### `pmm.livenessProbe.failureThreshold`
22312231

22322232
The number of failed probes required to mark the container unhealthy.
22332233

0 commit comments

Comments
 (0)