Resource Type: kubernetes_container

Defined in:
lib/puppet/type/kubernetes_container.rb
Providers:
swagger

Overview

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

Properties

  • args

    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: kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

  • command

    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: kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • env

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

  • env_from

    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.

  • image

    Docker image name. More info: kubernetes.io/docs/concepts/containers/images

  • image_pull_policy

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

  • lifecycle

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

  • liveness_probe

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

  • name (namevar)

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

  • ports

    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.

  • readiness_probe

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

  • resources

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

  • security_context

    Security options the pod should run with. More info: kubernetes.io/docs/concepts/policy/security-context/ More info: git.k8s.io/community/contributors/design-proposals/security_context.md

  • stdin

    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.

  • stdin_once

    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 stdinOnce 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

  • termination_message_path

    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.

  • termination_message_policy

    Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError 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.

  • tty

    Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.

  • volume_mounts

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

  • working_dir

    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.

Parameters

  • name

    Name of the container.

  • provider

    The specific backend to use for this ‘kubernetes_container` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.