github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-20 18:31:15 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #106285 from SergeyKanzhelev/updateHandlersDescription

Browse Source 
updated probe handler types descriptions
This commit is contained in:
Kubernetes Prow Robot 2021-11-15 15:07:52 -08:00 committed by GitHub
commit 058ce89c60
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 39 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
api/openapi-spec/swagger.json generated
View File

@ -6782,17 +6782,17 @@
}, },
"preStop": { "preStop": {
"$ref": "#/definitions/io.k8s.api.core.v1.LifecycleHandler", "$ref": "#/definitions/io.k8s.api.core.v1.LifecycleHandler",
"description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" "description": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"
} }
}, },
"type": "object" "type": "object"
}, },
"io.k8s.api.core.v1.LifecycleHandler": { "io.k8s.api.core.v1.LifecycleHandler": {
"description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. This type has a strong relationship to ProbeHandler - overlapping fields should be identical.", "description": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"properties": { "properties": {
"exec": { "exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction", "$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take." "description": "Exec specifies the action to take."
}, },
"httpGet": { "httpGet": {
"$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction", "$ref": "#/definitions/io.k8s.api.core.v1.HTTPGetAction",
@ -6800,7 +6800,7 @@
}, },
"tcpSocket": { "tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction", "$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported" "description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified."
} }
}, },
"type": "object" "type": "object"
@ -8793,7 +8793,7 @@
"properties": { "properties": {
"exec": { "exec": {
"$ref": "#/definitions/io.k8s.api.core.v1.ExecAction", "$ref": "#/definitions/io.k8s.api.core.v1.ExecAction",
"description": "One and only one of the following should be specified. Exec specifies the action to take." "description": "Exec specifies the action to take."
}, },
"failureThreshold": { "failureThreshold": {
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.", "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.",
@ -8821,7 +8821,7 @@
}, },
"tcpSocket": { "tcpSocket": {
"$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction", "$ref": "#/definitions/io.k8s.api.core.v1.TCPSocketAction",
"description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported" "description": "TCPSocket specifies an action involving a TCP port."
}, },
"terminationGracePeriodSeconds": { "terminationGracePeriodSeconds": {
"description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.", "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.",

25
pkg/apis/core/types.go
View File

@ -2189,11 +2189,8 @@ type Container struct {
} }
// ProbeHandler defines a specific action that should be taken in a probe. // ProbeHandler defines a specific action that should be taken in a probe.
// This type has a strong relationship to LifecycleHandler - overlapping fields // One and only one of the fields must be specified.
// should be identical.
// TODO: pass structured data to these actions, and document that data here.
type ProbeHandler struct { type ProbeHandler struct {
// One and only one of the following should be specified.
// Exec specifies the action to take. // Exec specifies the action to take.
// +optional // +optional
Exec *ExecAction Exec *ExecAction
@ -2201,25 +2198,22 @@ type ProbeHandler struct {
// +optional // +optional
HTTPGet *HTTPGetAction HTTPGet *HTTPGetAction
// TCPSocket specifies an action involving a TCP port. // TCPSocket specifies an action involving a TCP port.
// TODO: implement a realistic TCP lifecycle hook
// +optional // +optional
TCPSocket *TCPSocketAction TCPSocket *TCPSocketAction
} }
// LifecycleHandler defines a specific action that should be taken in a lifecycle // LifecycleHandler defines a specific action that should be taken in a lifecycle
// hook. This type has a strong relationship to ProbeHandler - overlapping fields // hook. One and only one of the fields, except TCPSocket must be specified.
// should be identical.
// TODO: pass structured data to these actions, and document that data here.
type LifecycleHandler struct { type LifecycleHandler struct {
// One and only one of the following should be specified.
// Exec specifies the action to take. // Exec specifies the action to take.
// +optional // +optional
Exec *ExecAction Exec *ExecAction
// HTTPGet specifies the http request to perform. // HTTPGet specifies the http request to perform.
// +optional // +optional
HTTPGet *HTTPGetAction HTTPGet *HTTPGetAction
// TCPSocket specifies an action involving a TCP port. // Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
// TODO: implement a realistic TCP lifecycle hook // for the backward compatibility. There are no validation of this field and
// lifecycle hooks will fail in runtime when tcp handler is specified.
// +optional // +optional
TCPSocket *TCPSocketAction TCPSocket *TCPSocketAction
} }
@ -2230,17 +2224,18 @@ type LifecycleHandler struct {
type Lifecycle struct { type Lifecycle struct {
// PostStart is called immediately after a container is created. If the handler fails, the container // PostStart is called immediately after a container is created. If the handler fails, the container
// is terminated and restarted. // is terminated and restarted.
// More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
// +optional // +optional
PostStart *LifecycleHandler PostStart *LifecycleHandler
// PreStop is called immediately before a container is terminated due to an // PreStop is called immediately before a container is terminated due to an
// API request or management event such as liveness/startup probe failure, // API request or management event such as liveness/startup probe failure,
// preemption, resource contention, etc. The handler is not called if the // preemption, resource contention, etc. The handler is not called if the
// container crashes or exits. The reason for termination is passed to the // container crashes or exits. The Pod's termination grace period countdown begins before the
// handler. The Pod's termination grace period countdown begins before the // PreStop hook is executed. Regardless of the outcome of the handler, the
// PreStop hooked is executed. Regardless of the outcome of the handler, the
// container will eventually terminate within the Pod's termination grace // container will eventually terminate within the Pod's termination grace
// period. Other management of the container blocks until the hook completes // period (unless delayed by finalizers). Other management of the container blocks until the hook completes
// or until the termination grace period is reached. // or until the termination grace period is reached.
// More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
// +optional // +optional
PreStop *LifecycleHandler PreStop *LifecycleHandler
} }

25
staging/src/k8s.io/api/core/v1/generated.proto
View File

@ -1918,11 +1918,10 @@ message Lifecycle {
// PreStop is called immediately before a container is terminated due to an // PreStop is called immediately before a container is terminated due to an
// API request or management event such as liveness/startup probe failure, // API request or management event such as liveness/startup probe failure,
// preemption, resource contention, etc. The handler is not called if the // preemption, resource contention, etc. The handler is not called if the
// container crashes or exits. The reason for termination is passed to the // container crashes or exits. The Pod's termination grace period countdown begins before the
// handler. The Pod's termination grace period countdown begins before the // PreStop hook is executed. Regardless of the outcome of the handler, the
// PreStop hooked is executed. Regardless of the outcome of the handler, the
// container will eventually terminate within the Pod's termination grace // container will eventually terminate within the Pod's termination grace
// period. Other management of the container blocks until the hook completes // period (unless delayed by finalizers). Other management of the container blocks until the hook completes
// or until the termination grace period is reached. // or until the termination grace period is reached.
// More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks // More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
// +optional // +optional
@ -1930,11 +1929,8 @@ message Lifecycle {
} }
// LifecycleHandler defines a specific action that should be taken in a lifecycle // LifecycleHandler defines a specific action that should be taken in a lifecycle
// hook. This type has a strong relationship to ProbeHandler - overlapping fields // hook. One and only one of the fields, except TCPSocket must be specified.
// should be identical.
// TODO: pass structured data to these actions, and document that data here.
message LifecycleHandler { message LifecycleHandler {
// One and only one of the following should be specified.
// Exec specifies the action to take. // Exec specifies the action to take.
// +optional // +optional
optional ExecAction exec = 1; optional ExecAction exec = 1;
@ -1943,9 +1939,9 @@ message LifecycleHandler {
// +optional // +optional
optional HTTPGetAction httpGet = 2; optional HTTPGetAction httpGet = 2;
// TCPSocket specifies an action involving a TCP port. // Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
// TCP hooks not yet supported // for the backward compatibility. There are no validation of this field and
// TODO: implement a realistic TCP lifecycle hook // lifecycle hooks will fail in runtime when tcp handler is specified.
// +optional // +optional
optional TCPSocketAction tcpSocket = 3; optional TCPSocketAction tcpSocket = 3;
} }
@ -3973,11 +3969,8 @@ message Probe {
} }
// ProbeHandler defines a specific action that should be taken in a probe. // ProbeHandler defines a specific action that should be taken in a probe.
// This type has a strong relationship to LifecycleHandler - overlapping fields // One and only one of the fields must be specified.
// should be identical.
// TODO: pass structured data to these actions, and document that data here.
message ProbeHandler { message ProbeHandler {
// One and only one of the following should be specified.
// Exec specifies the action to take. // Exec specifies the action to take.
// +optional // +optional
optional ExecAction exec = 1; optional ExecAction exec = 1;
@ -3987,8 +3980,6 @@ message ProbeHandler {
optional HTTPGetAction httpGet = 2; optional HTTPGetAction httpGet = 2;
// TCPSocket specifies an action involving a TCP port. // TCPSocket specifies an action involving a TCP port.
// TCP hooks not yet supported
// TODO: implement a realistic TCP lifecycle hook
// +optional // +optional
optional TCPSocketAction tcpSocket = 3; optional TCPSocketAction tcpSocket = 3;
} }

25
staging/src/k8s.io/api/core/v1/types.go
View File

@ -2382,11 +2382,8 @@ type Container struct {
} }
// ProbeHandler defines a specific action that should be taken in a probe. // ProbeHandler defines a specific action that should be taken in a probe.
// This type has a strong relationship to LifecycleHandler - overlapping fields // One and only one of the fields must be specified.
// should be identical.
// TODO: pass structured data to these actions, and document that data here.
type ProbeHandler struct { type ProbeHandler struct {
// One and only one of the following should be specified.
// Exec specifies the action to take. // Exec specifies the action to take.
// +optional // +optional
Exec *ExecAction `json:"exec,omitempty" protobuf:"bytes,1,opt,name=exec"` Exec *ExecAction `json:"exec,omitempty" protobuf:"bytes,1,opt,name=exec"`
@ -2394,27 +2391,22 @@ type ProbeHandler struct {
// +optional // +optional
HTTPGet *HTTPGetAction `json:"httpGet,omitempty" protobuf:"bytes,2,opt,name=httpGet"` HTTPGet *HTTPGetAction `json:"httpGet,omitempty" protobuf:"bytes,2,opt,name=httpGet"`
// TCPSocket specifies an action involving a TCP port. // TCPSocket specifies an action involving a TCP port.
// TCP hooks not yet supported
// TODO: implement a realistic TCP lifecycle hook
// +optional // +optional
TCPSocket *TCPSocketAction `json:"tcpSocket,omitempty" protobuf:"bytes,3,opt,name=tcpSocket"` TCPSocket *TCPSocketAction `json:"tcpSocket,omitempty" protobuf:"bytes,3,opt,name=tcpSocket"`
} }
// LifecycleHandler defines a specific action that should be taken in a lifecycle // LifecycleHandler defines a specific action that should be taken in a lifecycle
// hook. This type has a strong relationship to ProbeHandler - overlapping fields // hook. One and only one of the fields, except TCPSocket must be specified.
// should be identical.
// TODO: pass structured data to these actions, and document that data here.
type LifecycleHandler struct { type LifecycleHandler struct {
// One and only one of the following should be specified.
// Exec specifies the action to take. // Exec specifies the action to take.
// +optional // +optional
Exec *ExecAction `json:"exec,omitempty" protobuf:"bytes,1,opt,name=exec"` Exec *ExecAction `json:"exec,omitempty" protobuf:"bytes,1,opt,name=exec"`
// HTTPGet specifies the http request to perform. // HTTPGet specifies the http request to perform.
// +optional // +optional
HTTPGet *HTTPGetAction `json:"httpGet,omitempty" protobuf:"bytes,2,opt,name=httpGet"` HTTPGet *HTTPGetAction `json:"httpGet,omitempty" protobuf:"bytes,2,opt,name=httpGet"`
// TCPSocket specifies an action involving a TCP port. // Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
// TCP hooks not yet supported // for the backward compatibility. There are no validation of this field and
// TODO: implement a realistic TCP lifecycle hook // lifecycle hooks will fail in runtime when tcp handler is specified.
// +optional // +optional
TCPSocket *TCPSocketAction `json:"tcpSocket,omitempty" protobuf:"bytes,3,opt,name=tcpSocket"` TCPSocket *TCPSocketAction `json:"tcpSocket,omitempty" protobuf:"bytes,3,opt,name=tcpSocket"`
} }
@ -2432,11 +2424,10 @@ type Lifecycle struct {
// PreStop is called immediately before a container is terminated due to an // PreStop is called immediately before a container is terminated due to an
// API request or management event such as liveness/startup probe failure, // API request or management event such as liveness/startup probe failure,
// preemption, resource contention, etc. The handler is not called if the // preemption, resource contention, etc. The handler is not called if the
// container crashes or exits. The reason for termination is passed to the // container crashes or exits. The Pod's termination grace period countdown begins before the
// handler. The Pod's termination grace period countdown begins before the // PreStop hook is executed. Regardless of the outcome of the handler, the
// PreStop hooked is executed. Regardless of the outcome of the handler, the
// container will eventually terminate within the Pod's termination grace // container will eventually terminate within the Pod's termination grace
// period. Other management of the container blocks until the hook completes // period (unless delayed by finalizers). Other management of the container blocks until the hook completes
// or until the termination grace period is reached. // or until the termination grace period is reached.
// More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks // More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
// +optional // +optional

14
staging/src/k8s.io/api/core/v1/types_swagger_doc_generated.go generated
View File

@ -878,7 +878,7 @@ func (KeyToPath) SwaggerDoc() map[string]string {
var map_Lifecycle = map[string]string{ var map_Lifecycle = map[string]string{
"": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.", "": "Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.",
"postStart": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks", "postStart": "PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks",
"preStop": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The reason for termination is passed to the handler. The Pod's termination grace period countdown begins before the PreStop hooked is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks", "preStop": "PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks",
} }
func (Lifecycle) SwaggerDoc() map[string]string { func (Lifecycle) SwaggerDoc() map[string]string {
@ -886,10 +886,10 @@ func (Lifecycle) SwaggerDoc() map[string]string {
} }
var map_LifecycleHandler = map[string]string{ var map_LifecycleHandler = map[string]string{
"": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. This type has a strong relationship to ProbeHandler - overlapping fields should be identical.", "": "LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.",
"exec": "One and only one of the following should be specified. Exec specifies the action to take.", "exec": "Exec specifies the action to take.",
"httpGet": "HTTPGet specifies the http request to perform.", "httpGet": "HTTPGet specifies the http request to perform.",
"tcpSocket": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported", "tcpSocket": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified.",
} }
func (LifecycleHandler) SwaggerDoc() map[string]string { func (LifecycleHandler) SwaggerDoc() map[string]string {
@ -1793,10 +1793,10 @@ func (Probe) SwaggerDoc() map[string]string {
} }
var map_ProbeHandler = map[string]string{ var map_ProbeHandler = map[string]string{
"": "ProbeHandler defines a specific action that should be taken in a probe. This type has a strong relationship to LifecycleHandler - overlapping fields should be identical.", "": "ProbeHandler defines a specific action that should be taken in a probe. One and only one of the fields must be specified.",
"exec": "One and only one of the following should be specified. Exec specifies the action to take.", "exec": "Exec specifies the action to take.",
"httpGet": "HTTPGet specifies the http request to perform.", "httpGet": "HTTPGet specifies the http request to perform.",
"tcpSocket": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported", "tcpSocket": "TCPSocket specifies an action involving a TCP port.",
} }
func (ProbeHandler) SwaggerDoc() map[string]string { func (ProbeHandler) SwaggerDoc() map[string]string {