Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DropDisabledPodFields

func DropDisabledPodFields(pod, oldPod *api.Pod)

    DropDisabledPodFields removes disabled fields from the pod metadata and spec. This should be called from PrepareForCreate/PrepareForUpdate for all resources containing a Pod

    func DropDisabledTemplateFields

    func DropDisabledTemplateFields(podTemplate, oldPodTemplate *api.PodTemplateSpec)

      DropDisabledTemplateFields removes disabled fields from the pod template metadata and spec. This should be called from PrepareForCreate/PrepareForUpdate for all resources containing a PodTemplateSpec

      func GetPodCondition

      func GetPodCondition(status *api.PodStatus, conditionType api.PodConditionType) (int, *api.PodCondition)

        GetPodCondition extracts the provided condition from the given status and returns that. Returns nil and -1 if the condition is not present, and the index of the located condition.

        func GetPodReadyCondition

        func GetPodReadyCondition(status api.PodStatus) *api.PodCondition

          GetPodReadyCondition extracts the pod ready condition from the given status and returns that. Returns nil if the condition is not present.

          func GetValidationOptionsFromPodSpec

          func GetValidationOptionsFromPodSpec(podSpec, oldPodSpec *api.PodSpec) apivalidation.PodValidationOptions

            GetValidationOptionsFromPodSpec returns validation options based on pod specs

            func GetValidationOptionsFromPodTemplate

            func GetValidationOptionsFromPodTemplate(podTemplate, oldPodTemplate *api.PodTemplateSpec) apivalidation.PodValidationOptions

              GetValidationOptionsFromPodTemplate will return pod validation options for specified template.

              func IsPodReady

              func IsPodReady(pod *api.Pod) bool

                IsPodReady returns true if a pod is ready; false otherwise.

                func IsPodReadyConditionTrue

                func IsPodReadyConditionTrue(status api.PodStatus) bool

                  IsPodReadyConditionTrue returns true if a pod is ready; false otherwise.

                  func SeccompAnnotationForField

                  func SeccompAnnotationForField(field *api.SeccompProfile) string

                    SeccompAnnotationForField takes a pod seccomp profile field and returns the converted annotation value

                    func SeccompFieldForAnnotation

                    func SeccompFieldForAnnotation(annotation string) *api.SeccompProfile

                      SeccompFieldForAnnotation takes a pod annotation and returns the converted seccomp profile field.

                      func UpdatePodCondition

                      func UpdatePodCondition(status *api.PodStatus, condition *api.PodCondition) bool

                        UpdatePodCondition updates existing pod condition or creates a new one. Sets LastTransitionTime to now if the status has changed. Returns true if pod condition has changed or has been added.

                        func VisitContainers

                        func VisitContainers(podSpec *api.PodSpec, mask ContainerType, visitor ContainerVisitor) bool

                          VisitContainers invokes the visitor function with a pointer to every container spec in the given pod spec with type set in mask. If visitor returns false, visiting is short-circuited. VisitContainers returns true if visiting completes, false if visiting was short-circuited.

                          func VisitPodConfigmapNames

                          func VisitPodConfigmapNames(pod *api.Pod, visitor Visitor, containerType ContainerType) bool

                            VisitPodConfigmapNames invokes the visitor function with the name of every configmap 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.

                            func VisitPodSecretNames

                            func VisitPodSecretNames(pod *api.Pod, visitor Visitor, containerType ContainerType) 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.

                              Types

                              type ContainerType

                              type ContainerType int

                                ContainerType signifies container type

                                const (
                                	// Containers is for normal containers
                                	Containers ContainerType = 1 << iota
                                	// InitContainers is for init containers
                                	InitContainers
                                	// EphemeralContainers is for ephemeral containers
                                	EphemeralContainers
                                )

                                  AllContainers specifies that all containers be visited

                                  func AllFeatureEnabledContainers

                                  func AllFeatureEnabledContainers() ContainerType

                                    AllFeatureEnabledContainers returns a ContainerType mask which includes all container types except for the ones guarded by feature gate.

                                    type ContainerVisitor

                                    type ContainerVisitor func(container *api.Container, containerType ContainerType) (shouldContinue bool)

                                      ContainerVisitor is called with each container spec, and returns true if visiting should continue.

                                      type Visitor

                                      type Visitor func(name string) (shouldContinue bool)

                                        Visitor is called with each object name, and returns true if visiting should continue

                                        Source Files