Skip to content

Commit e4bdcbc

Browse files
committed
Add the windows graceful node shutdown doc
1 parent bbcfe89 commit e4bdcbc

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

content/en/docs/concepts/cluster-administration/node-shutdown.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,28 @@ via the [Non-Graceful Node Shutdown](#non-graceful-node-shutdown) procedure ment
265265
{{< /note >}}
266266

267267

268+
## Windows Graceful node shutdown {#windows-graceful-node-shutdown}
269+
270+
{{< feature-state feature_gate_name="WindowsGracefulNodeShutdown" >}}
271+
272+
The Windows graceful node shutdown feature depends on kubelet running as a Windows service,
273+
it will then have a registered [service control handler](https://learn.microsoft.com/en-us/windows/win32/services/service-control-handler-function)
274+
to delay the presshutdown event with a given duration.
275+
276+
Windows graceful node shutdown is controlled with the `WindowsGracefulNodeShutdown`
277+
[feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
278+
which is introduced in 1.32 as an alpha feature.
279+
280+
Windows graceful node shutdown can not be cancelled.
281+
282+
If Kubelet is not running as a Windows service, it will not be able to set and monitor
283+
the [Preshutdown](https://learn.microsoft.com/en-us/windows/win32/api/winsvc/ns-winsvc-service_preshutdown_info) event,
284+
the node will have to go through the [Non-Graceful Node Shutdown](#non-graceful-node-shutdown) procedure mentioned above.
285+
286+
In the case where the Windows graceful node shutdown feature is enabled, but the kubelet is not
287+
running as a Windows service, the kubelet will continue running instead of failing. However,
288+
it will log an error indicating that it needs to be run as a Windows service.
289+
268290
## {{% heading "whatsnext" %}}
269291

270292
Learn more about the following:
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: WindowsGracefulNodeShutdown
3+
content_type: feature_gate
4+
_build:
5+
list: never
6+
render: false
7+
8+
stages:
9+
- stage: alpha
10+
defaultValue: false
11+
fromVersion: "1.32"
12+
13+
---
14+
Enables support for windows node graceful shutdown in kubelet.
15+
During a system shutdown, kubelet will attempt to detect the shutdown event
16+
and gracefully terminate pods running on the node. See
17+
[Graceful Node Shutdown](/docs/concepts/architecture/nodes/#graceful-node-shutdown)
18+
for more details.

0 commit comments

Comments
 (0)