core.v1.lifecycleHandler

"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."

Index

obj exec
- fn withCommand(command)
- fn withCommandMixin(command)
obj httpGet
obj sleep
- fn withSeconds(seconds)
obj tcpSocket
- fn withHost(host)
- fn withPort(port)

Fields

obj exec

"ExecAction describes a \"run in container\" action."

fn exec.withCommand

withCommand(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

fn exec.withCommandMixin

withCommandMixin(command)

"Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy."

Note: This function appends passed data to existing values

obj httpGet

"HTTPGetAction describes an action based on HTTP Get requests."

fn httpGet.withHost

withHost(host)

"Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead."

fn httpGet.withHttpHeaders

withHttpHeaders(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

fn httpGet.withHttpHeadersMixin

withHttpHeadersMixin(httpHeaders)

"Custom headers to set in the request. HTTP allows repeated headers."

Note: This function appends passed data to existing values

fn httpGet.withPath

withPath(path)

"Path to access on the HTTP server."

fn httpGet.withPort

withPort(port)

"IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number."

fn httpGet.withScheme

withScheme(scheme)

"Scheme to use for connecting to the host. Defaults to HTTP."

obj sleep

"SleepAction describes a \"sleep\" action."

fn sleep.withSeconds

withSeconds(seconds)

"Seconds is the number of seconds to sleep."

obj tcpSocket

"TCPSocketAction describes an action based on opening a socket"

fn tcpSocket.withHost

withHost(host)

"Optional: Host name to connect to, defaults to the pod IP."

fn tcpSocket.withPort

withPort(port)

"IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number."