pod

Documentation

Index

• Constants
• func FindPort(pod *v1.Pod, svcPort *v1.ServicePort) (int, error)
• func SetInitContainersAndStatuses(pod *v1.Pod) error
• func SetInitContainersAnnotations(pod *v1.Pod) error
• func SetInitContainersStatusesAnnotations(pod *v1.Pod) error
• func VisitPodSecretNames(pod *v1.Pod, visitor func(string) bool) bool

Constants

const (
	// TODO: to be deleted after v1.3 is released. PodSpec has a dedicated Hostname field.
	// The annotation value is a string specifying the hostname to be used for the pod e.g 'my-webserver-1'
	PodHostnameAnnotation = "pod.beta.kubernetes.io/hostname"

	// TODO: to be deleted after v1.3 is released. PodSpec has a dedicated Subdomain field.
	// The annotation value is a string specifying the subdomain e.g. "my-web-service"
	// If specified, on the pod itself, "<hostname>.my-web-service.<namespace>.svc.<cluster domain>" would resolve to
	// the pod's IP.
	// If there is a headless service named "my-web-service" in the same namespace as the pod, then,
	// <hostname>.my-web-service.<namespace>.svc.<cluster domain>" would be resolved by the cluster DNS Server.
	PodSubdomainAnnotation = "pod.beta.kubernetes.io/subdomain"
)

Functions

func FindPort

func FindPort(pod *v1.Pod, svcPort *v1.ServicePort) (int, error)

FindPort locates the container port for the given pod and portName. If the targetPort is a number, use that. If the targetPort is a string, look that string up in all named ports in all containers in the target pod. If no match is found, fail.

func SetInitContainersAndStatuses

func SetInitContainersAndStatuses(pod *v1.Pod) error

TODO: remove this function when init containers becomes a stable feature

func SetInitContainersAnnotations

func SetInitContainersAnnotations(pod *v1.Pod) error

TODO: remove this function when init containers becomes a stable feature

func SetInitContainersStatusesAnnotations

func SetInitContainersStatusesAnnotations(pod *v1.Pod) error

TODO: remove this function when init containers becomes a stable feature

func VisitPodSecretNames

func VisitPodSecretNames(pod *v1.Pod, visitor func(string) bool) bool

VisitPodSecretNames invokes the visitor function with the name of every secret referenced by the pod spec. If visitor returns false, visiting is short-circuited. Transitive references (e.g. pod -> pvc -> pv -> secret) are not visited. Returns true if visiting completed, false if visiting was short-circuited.