8.2 KiB
8.2 KiB
Pod v1
bdocs-tab:example Pod Config to print "Hello World".
apiVersion: v1
kind: Pod
metadata:
name: pod-example
spec:
containers:
- image: ubuntu:trusty
command: ["echo"]
args: ["Hello World"]
| Group | Version | Kind |
|---|---|---|
| Core | v1 | Pod |
Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.
| Field | Description |
|---|---|
| apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
| kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
| metadata ObjectMeta |
Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata |
| spec PodSpec |
Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
| status PodStatus |
Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status |
PodSpec v1
| Field | Description |
|---|---|
| activeDeadlineSeconds integer |
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. |
| containers Container array |
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 |
| dnsPolicy string |
Set DNS policy for containers within the pod. One of 'ClusterFirst' or 'Default'. Defaults to "ClusterFirst". |
| hostIPC boolean |
Use the host's ipc namespace. Optional: Default to false. |
| hostNetwork boolean |
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. |
| hostPID boolean |
Use the host's pid namespace. Optional: Default to false. |
| hostname string |
Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. |
| imagePullSecrets LocalObjectReference array |
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 |
| nodeName string |
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. |
| nodeSelector object |
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/README |
| restartPolicy string |
Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://kubernetes.io/docs/user-guide/pod-states#restartpolicy |
| securityContext PodSecurityContext |
SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. |
| serviceAccount string |
DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. |
| serviceAccountName string |
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 string |
If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. |
| terminationGracePeriodSeconds integer |
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. |
| volumes Volume array |
List of volumes that can be mounted by containers belonging to the pod. More info: http://kubernetes.io/docs/user-guide/volumes |
PodStatus v1
| Field | Description |
|---|---|
| conditions PodCondition array |
Current service state of pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-conditions |
| containerStatuses ContainerStatus array |
The list has one entry per container in the manifest. Each entry is currently the output of docker inspect. More info: http://kubernetes.io/docs/user-guide/pod-states#container-statuses |
| hostIP string |
IP address of the host to which the pod is assigned. Empty if not yet scheduled. |
| message string |
A human readable message indicating details about why the pod is in this condition. |
| phase string |
Current condition of the pod. More info: http://kubernetes.io/docs/user-guide/pod-states#pod-phase |
| podIP string |
IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated. |
| reason string |
A brief CamelCase message indicating details about why the pod is in this state. e.g. 'OutOfDisk' |
| startTime Time |
RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod. |
PodList v1
| Field | Description |
|---|---|
| apiVersion string |
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources |
| items Pod array |
List of pods. More info: http://kubernetes.io/docs/user-guide/pods |
| kind string |
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |
| metadata ListMeta |
Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds |