API Reference

Packages:

ivaltryek.github.com/v1

ivaltryek.github.com/v1

Resource Types:

Nimble

Nimble

Auto-generated derived type for NimbleSpec via CustomResource

Name	Type	Description	Required
apiVersion	string	ivaltryek.github.com/v1	true
kind	string	Nimble	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object		true

Nimble.spec

^{^{↩ Parent}}

Name	Type	Description	Required
deployment	object		true

Nimble.spec.deployment

^{^{↩ Parent}}

Name	Type	Description	Required
containers	[]object	Containers to run in the deployment.	true
labels	map[string]string	Labels to be applied to the deployment and its pods.	true
annotations	map[string]string	Annotations to be applied to the deployment and its pods. Default: map[app.kubernetes.io/managed-by:kube-nimble]	false
replicas	integer	Number of desired replicas for the deployment. Format: int32 Default: 1	false

Nimble.spec.deployment.containers[index]

^{^{↩ Parent}}

Name	Type	Description	Required
image	string	Image to use for a container.	true
name	string	Name of the container.	true
command	[]string	override entrypoint command for a container.	false
env	[]object	List of environment variables to set in the container. Cannot be updated.	false
envFrom	[]object	List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.	false
limits	object	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
livenessProbe	object	Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
readinessProbe	object	Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false
requests	object	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/	false
startupProbe	object	StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes	false

Nimble.spec.deployment.containers[index].env[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of environment variable	true
value	string	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.	false

Nimble.spec.deployment.containers[index].envFrom[index]

^{^{↩ Parent}}

Name	Type	Description	Required
configMapRef	string	The ConfigMap to select from	false
secretRef	string	The Secret to select from	false

Nimble.spec.deployment.containers[index].limits

^{^{↩ Parent}}

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Name	Type	Description	Required
cpu	string	cpu config (requests/limits) for the container.	false
memory	string	memory config (requests/limits) for the container.	false

Nimble.spec.deployment.containers[index].livenessProbe

^{^{↩ Parent}}

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	[]string	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 Default: 0	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32 Default: 10	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32 Default: 1	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false

Nimble.spec.deployment.containers[index].livenessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
path	string	Path to access on the HTTP server.	true
port	integer	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Format: int32	true

Nimble.spec.deployment.containers[index].livenessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	integer	TCP Port to make checks against. Format: int32	true

Nimble.spec.deployment.containers[index].readinessProbe

^{^{↩ Parent}}

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	[]string	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 Default: 0	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32 Default: 10	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32 Default: 1	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false

Nimble.spec.deployment.containers[index].readinessProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
path	string	Path to access on the HTTP server.	true
port	integer	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Format: int32	true

Nimble.spec.deployment.containers[index].readinessProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	integer	TCP Port to make checks against. Format: int32	true

Nimble.spec.deployment.containers[index].requests

^{^{↩ Parent}}

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

Name	Type	Description	Required
cpu	string	cpu config (requests/limits) for the container.	false
memory	string	memory config (requests/limits) for the container.	false

Nimble.spec.deployment.containers[index].startupProbe

^{^{↩ Parent}}

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Name	Type	Description	Required
exec	[]string	Exec specifies the action to take.	false
httpGet	object	HTTPGet specifies the http request to perform.	false
initialDelaySeconds	integer	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes Format: int32 Default: 0	false
periodSeconds	integer	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Format: int32 Default: 10	false
successThreshold	integer	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Format: int32 Default: 1	false
tcpSocket	object	TCPSocket specifies an action involving a TCP port.	false

Nimble.spec.deployment.containers[index].startupProbe.httpGet

^{^{↩ Parent}}

HTTPGet specifies the http request to perform.

Name	Type	Description	Required
path	string	Path to access on the HTTP server.	true
port	integer	Name or number of the port to access on the container. Number must be in the range 1 to 65535. Format: int32	true

Nimble.spec.deployment.containers[index].startupProbe.tcpSocket

^{^{↩ Parent}}

TCPSocket specifies an action involving a TCP port.

Name	Type	Description	Required
port	integer	TCP Port to make checks against. Format: int32	true