package kubecaml

  1. Overview
  2. Docs
package kubecaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

A single application container that you want to run within a pod.

type t
val to_yojson : t -> Yojson.Safe.t
val make : ?working_dir:string -> ?volume_mounts:Kubernetes.Definitions.Api.Core.V1.Volume_mount.t list -> ?volume_devices:Kubernetes.Definitions.Api.Core.V1.Volume_device.t list -> ?tty:bool -> ?termination_message_policy:string -> ?termination_message_path:string -> ?stdin_once:bool -> ?stdin:bool -> ?security_context:Kubernetes.Definitions.Api.Core.V1.Security_context.t -> ?resources:Kubernetes.Definitions.Api.Core.V1.Resource_requirements.t -> ?readiness_probe:Kubernetes.Definitions.Api.Core.V1.Probe.t -> ?ports:Kubernetes.Definitions.Api.Core.V1.Container_port.t list -> name:string -> ?liveness_probe:Kubernetes.Definitions.Api.Core.V1.Probe.t -> ?lifecycle:Kubernetes.Definitions.Api.Core.V1.Lifecycle.t -> ?image_pull_policy:string -> ?image:string -> ?env_from:Kubernetes.Definitions.Api.Core.V1.Env_from_source.t list -> ?env:Kubernetes.Definitions.Api.Core.V1.Env_var.t list -> ?command:string list -> ?args:string list -> unit -> t
val args : t -> string list option

Arguments to the entrypoint. The docker image's Cmd is used if this is not provided. Variable references $(var_name) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(var_name) syntax can be escaped with a double $$, ie: $$(var_name). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

val command : t -> string list option

Entrypoint array. Not executed within a shell. The docker image's Entrypoint is used if this is not provided. Variable references $(var_name) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(var_name) syntax can be escaped with a double $$, ie: $$(var_name). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

List of environment variables to set in the container. Cannot be updated.

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.

val image : t -> string option

Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and Stateful_sets.

val image_pull_policy : t -> string option

Image pull policy. One of Always, Never, If_not_present. Defaults to Always if :latest tag is specified, or If_not_present otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

val liveness_probe : t -> Kubernetes.Definitions.Api.Core.V1.Probe.t option

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

val name : t -> string

Name of the container specified as a Dns_label. Each container in a pod must have a unique name (dns_label). Cannot be updated.

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here Does Not prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

val readiness_probe : t -> Kubernetes.Definitions.Api.Core.V1.Probe.t option

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

Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

val stdin : t -> bool option

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in Eof. Default is false.

val stdin_once : t -> bool option

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdin_once is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an Eof. Default is false

val termination_message_path : t -> string option

Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination_log. Cannot be updated.

val termination_message_policy : t -> string option

Indicate how the termination message should be populated. File will use the contents of termination_message_path to populate the container status message on both success and failure. Fallback_to_logs_on_error will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

val tty : t -> bool option

Whether this container should allocate a Tty for itself, also requires 'stdin' to be true. Default is false.

val volume_devices : t -> Kubernetes.Definitions.Api.Core.V1.Volume_device.t list option

volume_devices is the list of block devices to be used by the container. This is an alpha feature and may change in the future.

val volume_mounts : t -> Kubernetes.Definitions.Api.Core.V1.Volume_mount.t list option

Pod volumes to mount into the container's filesystem. Cannot be updated.

val working_dir : t -> string option

Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

module Object : Object.S with type value := t