Merge pull request #96812 from bboreham/comment-grace

Comment default behaviour of kubectl drain.GracePeriodSeconds
kubernetes · Jan 21, 2021 · c2ac8c3 · c2ac8c3
2 parents 6a161bf + 7c764c8
commit c2ac8c3
Showing 1 changed file with 9 additions and 4 deletions.
diff --git a/staging/src/k8s.io/kubectl/pkg/drain/drain.go b/staging/src/k8s.io/kubectl/pkg/drain/drain.go
@@ -46,10 +46,15 @@ const (
 
 // Helper contains the parameters to control the behaviour of drainer
 type Helper struct {
-	Ctx                 context.Context
-	Client              kubernetes.Interface
-	Force               bool
-	GracePeriodSeconds  int
+	Ctx    context.Context
+	Client kubernetes.Interface
+	Force  bool
+
+	// GracePeriodSeconds is how long to wait for a pod to terminate.
+	// IMPORTANT: 0 means "delete immediately"; set to a negative value
+	// to use the pod's terminationGracePeriodSeconds.
+	GracePeriodSeconds int
+
 	IgnoreAllDaemonSets bool
 	Timeout             time.Duration
 	DeleteEmptyDirData  bool