Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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 GetContainerStatus

    func GetContainerStatus(statuses []v1.ContainerStatus, name string) (v1.ContainerStatus, bool)

      GetContainerStatus extracts the status of container "name" from "statuses". It also returns if "name" exists.

      func GetExistingContainerStatus

      func GetExistingContainerStatus(statuses []v1.ContainerStatus, name string) v1.ContainerStatus

        GetExistingContainerStatus extracts the status of container "name" from "statuses", It also returns if "name" exists.

        func GetPodCondition

        func GetPodCondition(status *v1.PodStatus, conditionType v1.PodConditionType) (int, *v1.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 GetPodConditionFromList

          func GetPodConditionFromList(conditions []v1.PodCondition, conditionType v1.PodConditionType) (int, *v1.PodCondition)

            GetPodConditionFromList extracts the provided condition from the given list of condition and returns the index of the condition and the condition. Returns -1 and nil if the condition is not present.

            func GetPodReadyCondition

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

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

              func IsPodAvailable

              func IsPodAvailable(pod *v1.Pod, minReadySeconds int32, now metav1.Time) bool

                IsPodAvailable returns true if a pod is available; false otherwise. Precondition for an available pod is that it must be ready. On top of that, there are two cases when a pod can be considered available: 1. minReadySeconds == 0, or 2. LastTransitionTime (is set) + minReadySeconds < current time

                func IsPodReady

                func IsPodReady(pod *v1.Pod) bool

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

                  func IsPodReadyConditionTrue

                  func IsPodReadyConditionTrue(status v1.PodStatus) bool

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

                    func UpdatePodCondition

                    func UpdatePodCondition(status *v1.PodStatus, condition *v1.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 *v1.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 *v1.Pod, visitor Visitor) 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 *v1.Pod, visitor Visitor) 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 *v1.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