Skip to content

Commit 419234f

Browse files
authored
Merge pull request #28486 from strideynet/fix-incorrect-graceful-shutdown-defaults
chore: regenerate kubelet-config reference page
2 parents 4f13852 + a5bff81 commit 419234f

File tree

1 file changed

+127
-35
lines changed

1 file changed

+127
-35
lines changed

content/en/docs/reference/config-api/kubelet-config.v1beta1.md

Lines changed: 127 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,48 @@ auto_generated: true
1414

1515

1616

17+
## `LoggingConfiguration` {#LoggingConfiguration}
18+
19+
20+
21+
22+
**Appears in:**
23+
24+
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
25+
26+
27+
LoggingConfiguration contains logging options
28+
Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information.
29+
30+
<table class="table">
31+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
32+
<tbody>
33+
34+
35+
36+
<tr><td><code>format</code> <B>[Required]</B><br/>
37+
<code>string</code>
38+
</td>
39+
<td>
40+
Format Flag specifies the structure of log messages.
41+
default value of format is `text`</td>
42+
</tr>
43+
44+
45+
<tr><td><code>sanitization</code> <B>[Required]</B><br/>
46+
<code>bool</code>
47+
</td>
48+
<td>
49+
[Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens).
50+
Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)</td>
51+
</tr>
52+
53+
54+
</tbody>
55+
</table>
56+
57+
58+
1759

1860
## `KubeletConfiguration` {#kubelet-config-k8s-io-v1beta1-KubeletConfiguration}
1961

@@ -445,10 +487,10 @@ Default: "10s"</td>
445487
status to master if node status does not change. Kubelet will ignore this
446488
frequency and post node status immediately if any change is detected. It is
447489
only used when node lease feature is enabled. nodeStatusReportFrequency's
448-
default value is 1m. But if nodeStatusUpdateFrequency is set explicitly,
490+
default value is 5m. But if nodeStatusUpdateFrequency is set explicitly,
449491
nodeStatusReportFrequency's default value will be set to
450492
nodeStatusUpdateFrequency for backward compatibility.
451-
Default: "1m"</td>
493+
Default: "5m"</td>
452494
</tr>
453495

454496

@@ -590,7 +632,7 @@ Default: "cgroupfs"</td>
590632
Requires the CPUManager feature gate to be enabled.
591633
Dynamic Kubelet Config (beta): This field should not be updated without a full node
592634
reboot. It is safest to keep this value the same as the local config.
593-
Default: "none"</td>
635+
Default: "None"</td>
594636
</tr>
595637

596638

@@ -606,6 +648,18 @@ Default: "10s"</td>
606648
</tr>
607649

608650

651+
<tr><td><code>memoryManagerPolicy</code><br/>
652+
<code>string</code>
653+
</td>
654+
<td>
655+
MemoryManagerPolicy is the name of the policy to use by memory manager.
656+
Requires the MemoryManager feature gate to be enabled.
657+
Dynamic Kubelet Config (beta): This field should not be updated without a full node
658+
reboot. It is safest to keep this value the same as the local config.
659+
Default: "none"</td>
660+
</tr>
661+
662+
609663
<tr><td><code>topologyManagerPolicy</code><br/>
610664
<code>string</code>
611665
</td>
@@ -1231,7 +1285,7 @@ Default: true</td>
12311285
</td>
12321286
<td>
12331287
ShutdownGracePeriod specifies the total duration that the node should delay the shutdown and total grace period for pod termination during a node shutdown.
1234-
Default: "30s"</td>
1288+
Default: "0s"</td>
12351289
</tr>
12361290

12371291

@@ -1241,7 +1295,46 @@ Default: "30s"</td>
12411295
<td>
12421296
ShutdownGracePeriodCriticalPods specifies the duration used to terminate critical pods during a node shutdown. This should be less than ShutdownGracePeriod.
12431297
For example, if ShutdownGracePeriod=30s, and ShutdownGracePeriodCriticalPods=10s, during a node shutdown the first 20 seconds would be reserved for gracefully terminating normal pods, and the last 10 seconds would be reserved for terminating critical pods.
1244-
Default: "10s"</td>
1298+
Default: "0s"</td>
1299+
</tr>
1300+
1301+
1302+
<tr><td><code>reservedMemory</code><br/>
1303+
<a href="#kubelet-config-k8s-io-v1beta1-MemoryReservation"><code>[]MemoryReservation</code></a>
1304+
</td>
1305+
<td>
1306+
ReservedMemory specifies a comma-separated list of memory reservations for NUMA nodes.
1307+
The parameter makes sense only in the context of the memory manager feature. The memory manager will not allocate reserved memory for container workloads.
1308+
For example, if you have a NUMA0 with 10Gi of memory and the ReservedMemory was specified to reserve 1Gi of memory at NUMA0,
1309+
the memory manager will assume that only 9Gi is available for allocation.
1310+
You can specify a different amount of NUMA node and memory types.
1311+
You can omit this parameter at all, but you should be aware that the amount of reserved memory from all NUMA nodes
1312+
should be equal to the amount of memory specified by the node allocatable features(https://kubernetes.io/docs/tasks/administer-cluster/reserve-compute-resources/#node-allocatable).
1313+
If at least one node allocatable parameter has a non-zero value, you will need to specify at least one NUMA node.
1314+
Also, avoid specifying:
1315+
1. Duplicates, the same NUMA node, and memory type, but with a different value.
1316+
2. zero limits for any memory type.
1317+
3. NUMAs nodes IDs that do not exist under the machine.
1318+
4. memory types except for memory and hugepages-<size>
1319+
Default: nil</td>
1320+
</tr>
1321+
1322+
1323+
<tr><td><code>enableProfilingHandler</code><br/>
1324+
<code>bool</code>
1325+
</td>
1326+
<td>
1327+
enableProfilingHandler enables profiling via web interface host:port/debug/pprof/
1328+
Default: true</td>
1329+
</tr>
1330+
1331+
1332+
<tr><td><code>enableDebugFlagsHandler</code><br/>
1333+
<code>bool</code>
1334+
</td>
1335+
<td>
1336+
enableDebugFlagsHandler enables flags endpoint via web interface host:port/debug/flags/v
1337+
Default: true</td>
12451338
</tr>
12461339

12471340

@@ -1544,26 +1637,7 @@ and groups corresponding to the Organization in the client certificate.</td>
15441637

15451638

15461639

1547-
## `ResourceChangeDetectionStrategy` {#kubelet-config-k8s-io-v1beta1-ResourceChangeDetectionStrategy}
1548-
1549-
(Alias of `string`)
1550-
1551-
1552-
**Appears in:**
1553-
1554-
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
1555-
1556-
1557-
ResourceChangeDetectionStrategy denotes a mode in which internal
1558-
managers (secret, configmap) are discovering object changes.
1559-
1560-
1561-
1562-
1563-
1564-
1565-
1566-
## `LoggingConfiguration` {#LoggingConfiguration}
1640+
## `MemoryReservation` {#kubelet-config-k8s-io-v1beta1-MemoryReservation}
15671641

15681642

15691643

@@ -1573,32 +1647,50 @@ managers (secret, configmap) are discovering object changes.
15731647
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
15741648

15751649

1576-
LoggingConfiguration contains logging options
1577-
Refer [Logs Options](https://github.com/kubernetes/component-base/blob/master/logs/options.go) for more information.
1650+
MemoryReservation specifies the memory reservation of different types for each NUMA node
15781651

15791652
<table class="table">
15801653
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
15811654
<tbody>
15821655

15831656

15841657

1585-
<tr><td><code>format</code> <B>[Required]</B><br/>
1586-
<code>string</code>
1658+
<tr><td><code>numaNode</code> <B>[Required]</B><br/>
1659+
<code>int32</code>
15871660
</td>
15881661
<td>
1589-
Format Flag specifies the structure of log messages.
1590-
default value of format is `text`</td>
1662+
<span class="text-muted">No description provided.</span>
1663+
</td>
15911664
</tr>
15921665

15931666

1594-
<tr><td><code>sanitization</code> <B>[Required]</B><br/>
1595-
<code>bool</code>
1667+
<tr><td><code>limits</code> <B>[Required]</B><br/>
1668+
<a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#resourcelist-v1-core"><code>core/v1.ResourceList</code></a>
15961669
</td>
15971670
<td>
1598-
[Experimental] When enabled prevents logging of fields tagged as sensitive (passwords, keys, tokens).
1599-
Runtime log sanitization may introduce significant computation overhead and therefore should not be enabled in production.`)</td>
1671+
<span class="text-muted">No description provided.</span>
1672+
</td>
16001673
</tr>
16011674

16021675

16031676
</tbody>
16041677
</table>
1678+
1679+
1680+
1681+
## `ResourceChangeDetectionStrategy` {#kubelet-config-k8s-io-v1beta1-ResourceChangeDetectionStrategy}
1682+
1683+
(Alias of `string`)
1684+
1685+
1686+
**Appears in:**
1687+
1688+
- [KubeletConfiguration](#kubelet-config-k8s-io-v1beta1-KubeletConfiguration)
1689+
1690+
1691+
ResourceChangeDetectionStrategy denotes a mode in which internal
1692+
managers (secret, configmap) are discovering object changes.
1693+
1694+
1695+
1696+

0 commit comments

Comments
 (0)