kubernetes_pod

A pod is a group of one or more containers, the shared storage for those containers, and options about how to run the containers. Pods are always co-located and co-scheduled, and run in a shared context.

Read more at https://kubernetes.io/docs/concepts/workloads/pods/pod/

Example Usage 

resource "kubernetes_pod" "test" {
  metadata {
    name = "terraform-example"
  }

  spec {
    container {
      image = "nginx:1.7.9"
      name  = "example"
    }
  }
}

Argument Reference

The following arguments are supported:

Nested Blocks

metadata

Arguments

Attributes

spec

Arguments

  • active_deadline_seconds - (Optional) Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
  • container - (Optional) List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers
  • dns_policy - (Optional) Set DNS policy for containers within the pod. One of 'ClusterFirst' or 'Default'. Defaults to 'ClusterFirst'.
  • host_ipc - (Optional) Use the host's ipc namespace. Optional: Default to false.
  • host_network - (Optional) Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified.
  • host_pid - (Optional) Use the host's pid namespace.
  • hostname - (Optional) Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
  • image_pull_secrets - (Optional) ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
  • node_name - (Optional) NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
  • node_selector - (Optional) NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: http://kubernetes.io/docs/user-guide/node-selection.
  • restart_policy - (Optional) Restart policy for all containers within the pod. One of Always, OnFailure, Never. More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy.
  • security_context - (Optional) SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty
  • service_account_name - (Optional) ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/HEAD/docs/design/service_accounts.md.
  • subdomain - (Optional) If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all..
  • termination_grace_period_seconds - (Optional) Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process.
  • volume - (Optional) List of volumes that can be mounted by containers belonging to the pod. More info: http://kubernetes.io/docs/user-guide/volumes

container

Arguments

  • args - (Optional) 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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
  • command - (Optional) 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: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
  • env - (Optional) List of environment variables to set in the container. Cannot be updated.
  • image - (Optional) Docker image name. More info: http://kubernetes.io/docs/user-guide/images
  • image_pull_policy - (Optional) Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images
  • lifecycle - (Optional) Actions that the management system should take in response to container lifecycle events
  • liveness_probe - (Optional) Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
  • name - (Required) Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
  • port - (Optional) 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 - (Optional) Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
  • resources - (Optional) Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources
  • security_context - (Optional) Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md
  • stdin - (Optional) 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.
  • stdin_once - (Optional) 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.
  • termination_message_path - (Optional) 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. Defaults to /dev/termination-log. Cannot be updated.
  • tty - (Optional) Whether this container should allocate a TTY for itself
  • volume_mount - (Optional) Pod volumes to mount into the container's filesystem. Cannot be updated.
  • working_dir - (Optional) 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.

aws_elastic_block_store

Arguments

azure_disk

Arguments

  • caching_mode - (Required) Host Caching mode: None, Read Only, Read Write.
  • data_disk_uri - (Required) The URI the data disk in the blob storage
  • disk_name - (Required) The Name of the data disk in the blob storage
  • fs_type - (Optional) Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  • read_only - (Optional) Whether to force the read-only setting in VolumeMounts. Defaults to false (read/write).

azure_file

Arguments

  • read_only - (Optional) Whether to force the read-only setting in VolumeMounts. Defaults to false (read/write).
  • secret_name - (Required) The name of secret that contains Azure Storage Account Name and Key
  • share_name - (Required) Share Name

capabilities

Arguments

  • add - (Optional) Added capabilities
  • drop - (Optional) Removed capabilities

ceph_fs

Arguments

cinder

Arguments

config_map

Arguments

  • default_mode - (Optional) Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
  • items - (Optional) If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'.
  • name - (Optional) Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names

config_map_key_ref

Arguments

downward_api

Arguments

  • default_mode - (Optional) Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
  • items - (Optional) If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the '..' path or start with '..'.

empty_dir

Arguments

env

Arguments

  • name - (Required) Name of the environment variable. Must be a C_IDENTIFIER
  • value - (Optional) Variable references $(VAR_NAME) are expanded using the previous 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. 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. Defaults to "".
  • value_from - (Optional) Source for the environment variable's value

exec

Arguments

  • command - (Optional) 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. 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.

fc

Arguments

  • fs_type - (Optional) Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  • lun - (Required) FC target lun number
  • read_only - (Optional) Whether to force the read-only setting in VolumeMounts. Defaults to false (read/write).
  • target_ww_ns - (Required) FC target worldwide names (WWNs)

field_ref

Arguments

  • api_version - (Optional) Version of the schema the FieldPath is written in terms of, defaults to "v1".
  • field_path - (Optional) Path of the field to select in the specified API version

flex_volume

Arguments

  • driver - (Required) Driver is the name of the driver to use for this volume.
  • fs_type - (Optional) Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
  • options - (Optional) Extra command options if any.
  • read_only - (Optional) Whether to force the ReadOnly setting in VolumeMounts. Defaults to false (read/write).
  • secret_ref - (Optional) Reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

flocker

Arguments

  • dataset_name - (Optional) Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
  • dataset_uuid - (Optional) UUID of the dataset. This is unique identifier of a Flocker dataset

gce_persistent_disk

Arguments

git_repo

Arguments

  • directory - (Optional) Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
  • repository - (Optional) Repository URL
  • revision - (Optional) Commit hash for the specified revision.

glusterfs

Arguments

host_path

Arguments

http_get

Arguments

  • host - (Optional) Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
  • http_header - (Optional) Scheme to use for connecting to the host.
  • path - (Optional) Path to access on the HTTP server.
  • port - (Optional) Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
  • scheme - (Optional) Scheme to use for connecting to the host.

http_header

Arguments

  • name - (Optional) The header field name
  • value - (Optional) The header field value

image_pull_secrets

Arguments

iscsi

Arguments

  • fs_type - (Optional) Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://kubernetes.io/docs/user-guide/volumes#iscsi
  • iqn - (Required) Target iSCSI Qualified Name.
  • iscsi_interface - (Optional) iSCSI interface name that uses an iSCSI transport. Defaults to 'default' (tcp).
  • lun - (Optional) iSCSI target lun number.
  • read_only - (Optional) Whether to force the read-only setting in VolumeMounts. Defaults to false.
  • target_portal - (Required) iSCSI target portal. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

items

Arguments

  • key - (Optional) The key to project.
  • mode - (Optional) Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
  • path - (Optional) The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

lifecycle

Arguments

limits

Arguments

  • cpu - (Optional) CPU
  • memory - (Optional) Memory

liveness_probe

Arguments

nfs

Arguments

persistent_volume_claim

Arguments

  • claim_name - (Optional) ClaimName is the name of a PersistentVolumeClaim in the same
  • read_only - (Optional) Will force the ReadOnly setting in VolumeMounts.

photon_persistent_disk

Arguments

  • fs_type - (Optional) Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  • pd_id - (Required) ID that identifies Photon Controller persistent disk

port

Arguments

  • container_port - (Required) Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
  • host_ip - (Optional) What host IP to bind the external port to.
  • host_port - (Optional) Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
  • name - (Optional) If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services
  • protocol - (Optional) Protocol for port. Must be UDP or TCP. Defaults to "TCP".

post_start

Arguments

  • exec - (Optional) exec specifies the action to take.
  • http_get - (Optional) Specifies the http request to perform.
  • tcp_socket - (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

pre_stop

Arguments

  • exec - (Optional) exec specifies the action to take.
  • http_get - (Optional) Specifies the http request to perform.
  • tcp_socket - (Optional) TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

quobyte

Arguments

  • group - (Optional) Group to map volume access to Default is no group
  • read_only - (Optional) Whether to force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
  • registry - (Required) Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
  • user - (Optional) User to map volume access to Defaults to serivceaccount user
  • volume - (Required) Volume is a string that references an already created Quobyte volume by name.

rbd

Arguments

readiness_probe

Arguments

resources

Arguments

requests

Arguments

  • cpu - (Optional) CPU
  • memory - (Optional) Memory

resource_field_ref

Arguments

se_linux_options

Arguments

  • level - (Optional) Level is SELinux level label that applies to the container.
  • role - (Optional) Role is a SELinux role label that applies to the container.
  • type - (Optional) Type is a SELinux type label that applies to the container.
  • user - (Optional) User is a SELinux user label that applies to the container.

secret

Arguments

  • default_mode - (Optional) Mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
  • items - (Optional) List of Secret Items to project into the volume. See items block definition below. If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
  • optional - (Optional) Specify whether the Secret or it's keys must be defined.
  • secret_name - (Optional) Name of the secret in the pod's namespace to use. More info: http://kubernetes.io/docs/user-guide/volumes#secrets

The items block supports the following:

  • key - (Required) The key to project.
  • mode - (Optional) Mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used.
  • path - (Required) The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

secret_key_ref

Arguments

secret_ref

Arguments

security_context

Arguments

  • fs_group - (Optional) A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- If unset, the Kubelet will not modify the ownership and permissions of any volume.
  • run_as_non_root - (Optional) Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does.
  • run_as_user - (Optional) The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified
  • se_linux_options - (Optional) The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
  • supplemental_groups - (Optional) A list of groups applied to the first process run in each container, in addition to the container's primary GID. If unspecified, no groups will be added to any container.

tcp_socket

Arguments

  • port - (Required) Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

value_from

Arguments

  • config_map_key_ref - (Optional) Selects a key of a ConfigMap.
  • field_ref - (Optional) Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP..
  • resource_field_ref - (Optional) Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP..
  • secret_key_ref - (Optional) Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP..

volume

Arguments

volume_mount

Arguments

  • mount_path - (Required) Path within the container at which the volume should be mounted. Must not contain ':'.
  • name - (Required) This must match the Name of a Volume.
  • read_only - (Optional) Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
  • sub_path - (Optional) Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).

vsphere_volume

Arguments

  • fs_type - (Optional) Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
  • volume_path - (Required) Path that identifies vSphere volume vmdk

Import

Pod can be imported using the namespace and name, e.g.

$ terraform import kubernetes_pod.example default/terraform-example

© 2018 HashiCorp
Licensed under the MPL 2.0 License.
https://www.terraform.io/docs/providers/kubernetes/r/pod.html