Skip to content

Commit db64727

Browse files
committed
doc: add support for container sleep lifecycle hook
1 parent 7c47a67 commit db64727

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed

docs/resources/pod.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,7 @@ Optional:
492492

493493
- `exec` (Block List, Max: 1) exec specifies the action to take. (see [below for nested schema](#nestedblock--spec--container--lifecycle--post_start--exec))
494494
- `http_get` (Block List, Max: 1) Specifies the http request to perform. (see [below for nested schema](#nestedblock--spec--container--lifecycle--post_start--http_get))
495+
- `sleep` (Block List, Max: 1) Sleep represents a duration that the container should sleep (see [below for nested schema](#nestedblock--spec--container--lifecycle--post_start--sleep))
495496
- `tcp_socket` (Block List) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported (see [below for nested schema](#nestedblock--spec--container--lifecycle--post_start--tcp_socket))
496497

497498
<a id="nestedblock--spec--container--lifecycle--post_start--exec"></a>
@@ -523,6 +524,14 @@ Optional:
523524

524525

525526

527+
<a id="nestedblock--spec--container--lifecycle--post_start--sleep"></a>
528+
### Nested Schema for `spec.container.lifecycle.post_start.sleep`
529+
530+
Required:
531+
532+
- `seconds` (Number) Number of seconds to sleep.
533+
534+
526535
<a id="nestedblock--spec--container--lifecycle--post_start--tcp_socket"></a>
527536
### Nested Schema for `spec.container.lifecycle.post_start.tcp_socket`
528537

@@ -539,6 +548,7 @@ Optional:
539548

540549
- `exec` (Block List, Max: 1) exec specifies the action to take. (see [below for nested schema](#nestedblock--spec--container--lifecycle--pre_stop--exec))
541550
- `http_get` (Block List, Max: 1) Specifies the http request to perform. (see [below for nested schema](#nestedblock--spec--container--lifecycle--pre_stop--http_get))
551+
- `sleep` (Block List, Max: 1) Sleep represents a duration that the container should sleep (see [below for nested schema](#nestedblock--spec--container--lifecycle--pre_stop--sleep))
542552
- `tcp_socket` (Block List) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported (see [below for nested schema](#nestedblock--spec--container--lifecycle--pre_stop--tcp_socket))
543553

544554
<a id="nestedblock--spec--container--lifecycle--pre_stop--exec"></a>
@@ -570,6 +580,14 @@ Optional:
570580

571581

572582

583+
<a id="nestedblock--spec--container--lifecycle--pre_stop--sleep"></a>
584+
### Nested Schema for `spec.container.lifecycle.pre_stop.sleep`
585+
586+
Required:
587+
588+
- `seconds` (Number) Number of seconds to sleep.
589+
590+
573591
<a id="nestedblock--spec--container--lifecycle--pre_stop--tcp_socket"></a>
574592
### Nested Schema for `spec.container.lifecycle.pre_stop.tcp_socket`
575593

@@ -1054,6 +1072,7 @@ Optional:
10541072

10551073
- `exec` (Block List, Max: 1) exec specifies the action to take. (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--post_start--exec))
10561074
- `http_get` (Block List, Max: 1) Specifies the http request to perform. (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--post_start--http_get))
1075+
- `sleep` (Block List, Max: 1) Sleep represents a duration that the container should sleep (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--post_start--sleep))
10571076
- `tcp_socket` (Block List) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--post_start--tcp_socket))
10581077

10591078
<a id="nestedblock--spec--init_container--lifecycle--post_start--exec"></a>
@@ -1085,6 +1104,14 @@ Optional:
10851104

10861105

10871106

1107+
<a id="nestedblock--spec--init_container--lifecycle--post_start--sleep"></a>
1108+
### Nested Schema for `spec.init_container.lifecycle.post_start.sleep`
1109+
1110+
Required:
1111+
1112+
- `seconds` (Number) Number of seconds to sleep.
1113+
1114+
10881115
<a id="nestedblock--spec--init_container--lifecycle--post_start--tcp_socket"></a>
10891116
### Nested Schema for `spec.init_container.lifecycle.post_start.tcp_socket`
10901117

@@ -1101,6 +1128,7 @@ Optional:
11011128

11021129
- `exec` (Block List, Max: 1) exec specifies the action to take. (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--pre_stop--exec))
11031130
- `http_get` (Block List, Max: 1) Specifies the http request to perform. (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--pre_stop--http_get))
1131+
- `sleep` (Block List, Max: 1) Sleep represents a duration that the container should sleep (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--pre_stop--sleep))
11041132
- `tcp_socket` (Block List) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--pre_stop--tcp_socket))
11051133

11061134
<a id="nestedblock--spec--init_container--lifecycle--pre_stop--exec"></a>
@@ -1132,6 +1160,14 @@ Optional:
11321160

11331161

11341162

1163+
<a id="nestedblock--spec--init_container--lifecycle--pre_stop--sleep"></a>
1164+
### Nested Schema for `spec.init_container.lifecycle.pre_stop.sleep`
1165+
1166+
Required:
1167+
1168+
- `seconds` (Number) Number of seconds to sleep.
1169+
1170+
11351171
<a id="nestedblock--spec--init_container--lifecycle--pre_stop--tcp_socket"></a>
11361172
### Nested Schema for `spec.init_container.lifecycle.pre_stop.tcp_socket`
11371173

docs/resources/pod_v1.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -491,6 +491,7 @@ Optional:
491491

492492
- `exec` (Block List, Max: 1) exec specifies the action to take. (see [below for nested schema](#nestedblock--spec--container--lifecycle--post_start--exec))
493493
- `http_get` (Block List, Max: 1) Specifies the http request to perform. (see [below for nested schema](#nestedblock--spec--container--lifecycle--post_start--http_get))
494+
- `sleep` (Block List, Max: 1) Sleep represents a duration that the container should sleep (see [below for nested schema](#nestedblock--spec--container--lifecycle--post_start--sleep))
494495
- `tcp_socket` (Block List) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported (see [below for nested schema](#nestedblock--spec--container--lifecycle--post_start--tcp_socket))
495496

496497
<a id="nestedblock--spec--container--lifecycle--post_start--exec"></a>
@@ -522,6 +523,14 @@ Optional:
522523

523524

524525

526+
<a id="nestedblock--spec--container--lifecycle--post_start--sleep"></a>
527+
### Nested Schema for `spec.container.lifecycle.post_start.sleep`
528+
529+
Required:
530+
531+
- `seconds` (Number) Number of seconds to sleep.
532+
533+
525534
<a id="nestedblock--spec--container--lifecycle--post_start--tcp_socket"></a>
526535
### Nested Schema for `spec.container.lifecycle.post_start.tcp_socket`
527536

@@ -538,6 +547,7 @@ Optional:
538547

539548
- `exec` (Block List, Max: 1) exec specifies the action to take. (see [below for nested schema](#nestedblock--spec--container--lifecycle--pre_stop--exec))
540549
- `http_get` (Block List, Max: 1) Specifies the http request to perform. (see [below for nested schema](#nestedblock--spec--container--lifecycle--pre_stop--http_get))
550+
- `sleep` (Block List, Max: 1) Sleep represents a duration that the container should sleep (see [below for nested schema](#nestedblock--spec--container--lifecycle--pre_stop--sleep))
541551
- `tcp_socket` (Block List) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported (see [below for nested schema](#nestedblock--spec--container--lifecycle--pre_stop--tcp_socket))
542552

543553
<a id="nestedblock--spec--container--lifecycle--pre_stop--exec"></a>
@@ -569,6 +579,14 @@ Optional:
569579

570580

571581

582+
<a id="nestedblock--spec--container--lifecycle--pre_stop--sleep"></a>
583+
### Nested Schema for `spec.container.lifecycle.pre_stop.sleep`
584+
585+
Required:
586+
587+
- `seconds` (Number) Number of seconds to sleep.
588+
589+
572590
<a id="nestedblock--spec--container--lifecycle--pre_stop--tcp_socket"></a>
573591
### Nested Schema for `spec.container.lifecycle.pre_stop.tcp_socket`
574592

@@ -1054,6 +1072,7 @@ Optional:
10541072

10551073
- `exec` (Block List, Max: 1) exec specifies the action to take. (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--post_start--exec))
10561074
- `http_get` (Block List, Max: 1) Specifies the http request to perform. (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--post_start--http_get))
1075+
- `sleep` (Block List, Max: 1) Sleep represents a duration that the container should sleep (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--post_start--sleep))
10571076
- `tcp_socket` (Block List) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--post_start--tcp_socket))
10581077

10591078
<a id="nestedblock--spec--init_container--lifecycle--post_start--exec"></a>
@@ -1085,6 +1104,14 @@ Optional:
10851104

10861105

10871106

1107+
<a id="nestedblock--spec--init_container--lifecycle--post_start--sleep"></a>
1108+
### Nested Schema for `spec.init_container.lifecycle.post_start.sleep`
1109+
1110+
Required:
1111+
1112+
- `seconds` (Number) Number of seconds to sleep.
1113+
1114+
10881115
<a id="nestedblock--spec--init_container--lifecycle--post_start--tcp_socket"></a>
10891116
### Nested Schema for `spec.init_container.lifecycle.post_start.tcp_socket`
10901117

@@ -1101,6 +1128,7 @@ Optional:
11011128

11021129
- `exec` (Block List, Max: 1) exec specifies the action to take. (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--pre_stop--exec))
11031130
- `http_get` (Block List, Max: 1) Specifies the http request to perform. (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--pre_stop--http_get))
1131+
- `sleep` (Block List, Max: 1) Sleep represents a duration that the container should sleep (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--pre_stop--sleep))
11041132
- `tcp_socket` (Block List) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported (see [below for nested schema](#nestedblock--spec--init_container--lifecycle--pre_stop--tcp_socket))
11051133

11061134
<a id="nestedblock--spec--init_container--lifecycle--pre_stop--exec"></a>
@@ -1132,6 +1160,14 @@ Optional:
11321160

11331161

11341162

1163+
<a id="nestedblock--spec--init_container--lifecycle--pre_stop--sleep"></a>
1164+
### Nested Schema for `spec.init_container.lifecycle.pre_stop.sleep`
1165+
1166+
Required:
1167+
1168+
- `seconds` (Number) Number of seconds to sleep.
1169+
1170+
11351171
<a id="nestedblock--spec--init_container--lifecycle--pre_stop--tcp_socket"></a>
11361172
### Nested Schema for `spec.init_container.lifecycle.pre_stop.tcp_socket`
11371173

@@ -1352,6 +1388,7 @@ Optional:
13521388
- `http_get` (Block List, Max: 1) Specifies the http request to perform. (see [below for nested schema](#nestedblock--spec--init_container--startup_probe--http_get))
13531389
- `initial_delay_seconds` (Number) Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
13541390
- `period_seconds` (Number) How often (in seconds) to perform the probe
1391+
- `sleep` (Block List, Max: 1) Sleep represents a duration that the container should sleep (see [below for nested schema](#nestedblock--spec--init_container--startup_probe--sleep))
13551392
- `success_threshold` (Number) Minimum consecutive successes for the probe to be considered successful after having failed.
13561393
- `tcp_socket` (Block List) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported (see [below for nested schema](#nestedblock--spec--init_container--startup_probe--tcp_socket))
13571394
- `timeout_seconds` (Number) Number of seconds after which the probe times out. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
@@ -1397,6 +1434,14 @@ Optional:
13971434

13981435

13991436

1437+
<a id="nestedblock--spec--init_container--startup_probe--sleep"></a>
1438+
### Nested Schema for `spec.init_container.startup_probe.sleep`
1439+
1440+
Required:
1441+
1442+
- `seconds` (Number) Number of seconds to sleep.
1443+
1444+
14001445
<a id="nestedblock--spec--init_container--startup_probe--tcp_socket"></a>
14011446
### Nested Schema for `spec.init_container.startup_probe.tcp_socket`
14021447

0 commit comments

Comments
 (0)