mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-26 05:03:09 +00:00
updated probe handler types descriptions
This commit is contained in:
parent
9af2ece18a
commit
57ed0174b1
@ -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
|
||||||
}
|
}
|
||||||
|
@ -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
|
||||||
|
Loading…
Reference in New Issue
Block a user