Resource Type: kubernetes_pod_spec

Defined in:

lib/puppet/type/kubernetes_pod_spec.rb

Providers:

swagger

Overview

PodSpec is a description of a pod.

Properties

• active_deadline_seconds

  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.

• affinity

  If specified, the pod’s scheduling constraints

• automount_service_account_token

  AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.

• containers

  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.

• dns_policy

  Set DNS policy for containers within the pod. One of ‘ClusterFirstWithHostNet’, ‘ClusterFirst’ or ‘Default’. Defaults to ‘ClusterFirst’. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to ‘ClusterFirstWithHostNet’.

• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• host_aliases

  HostAliases is an optional list of hosts and IPs that will be injected into the pod’s hosts file if specified. This is only valid for non-hostNetwork pods.

• host_ipc

  Use the host’s ipc namespace. Optional: Default to false.

• host_network

  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. Default to false.

• host_pid

  Use the host’s pid namespace. Optional: Default to false.

• hostname

  Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

• image_pull_secrets

  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: kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

• init_containers

  List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: kubernetes.io/docs/concepts/workloads/pods/init-containers/

• node_name

  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

  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: kubernetes.io/docs/concepts/configuration/assign-pod-node/

• restart_policy

  Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

• scheduler_name

  If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

• security_context

  SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

• service_account

  DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

• service_account_name

  ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

• subdomain

  If specified, the fully qualified Pod hostname will be ‘<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>’. If not specified, the pod will not have a domainname at all.

• termination_grace_period_seconds

  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. Defaults to 30 seconds.

• tolerations

  If specified, the pod’s tolerations.

• volumes

  List of volumes that can be mounted by containers belonging to the pod. More info: kubernetes.io/docs/concepts/storage/volumes

Parameters

• name (namevar)

  Name of the pod_spec.

• provider

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