pod

package
v1.30.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 17, 2024 License: Apache-2.0 Imports: 50 Imported by: 143

Documentation

Index

Constants

View Source 
const (
	VolumeMountPathTemplate = "/mnt/volume%d"
	VolumeMountPath1        = "/mnt/volume1"
)
View Source 
const DefaultNonRootUser = 1000

DefaultNonRootUser is the default user ID used for running restricted (non-root) containers.

View Source 
const DefaultNonRootUserName = "ContainerUser"

DefaultNonRootUserName is the default username in Windows used for running restricted (non-root) containers

View Source 
const (
	// DefaultPodDeletionTimeout is the default timeout for deleting pod
	DefaultPodDeletionTimeout = 3 * time.Minute
)
View Source 
const LabelLogOnPodFailure = "log-on-pod-failure"

LabelLogOnPodFailure can be used to mark which Pods will have their logs logged in the case of a test failure. By default, if there are no Pods with this label, only the first 5 Pods will have their logs fetched.

View Source 
const (
	// PodDeleteTimeout is how long to wait for a pod to be deleted.
	PodDeleteTimeout = 5 * time.Minute
)

Variables

View Source 
var ImagePrePullList sets.String

ImagePrePullList is the images used in the current test suite. It should be initialized in test suite and the images in the list should be pre-pulled in the test suite. Currently, this is only used by node e2e test.

Functions

func BeInPhase added in v1.27.0 

func BeInPhase(phase v1.PodPhase) types.GomegaMatcher

BeInPhase matches if pod.status.phase is the expected phase.

func BeRunningNoRetries added in v1.27.0 

func BeRunningNoRetries() types.GomegaMatcher

BeRunningNoRetries verifies that a pod starts running. It's a permanent failure when the pod enters some other permanent phase.

func CheckPodsRunningReady 

func CheckPodsRunningReady(ctx context.Context, c clientset.Interface, ns string, podNames []string, timeout time.Duration) bool

CheckPodsRunningReady returns whether all pods whose names are listed in podNames in namespace ns are running and ready, using c and waiting at most timeout.

func CheckPodsRunningReadyOrSucceeded 

func CheckPodsRunningReadyOrSucceeded(ctx context.Context, c clientset.Interface, ns string, podNames []string, timeout time.Duration) bool

CheckPodsRunningReadyOrSucceeded returns whether all pods whose names are listed in podNames in namespace ns are running and ready, or succeeded; use c and waiting at most timeout.

func CreateClientPod 

func CreateClientPod(ctx context.Context, c clientset.Interface, ns string, pvc *v1.PersistentVolumeClaim) (*v1.Pod, error)

CreateClientPod defines and creates a pod with a mounted PV. Pod runs infinite loop until killed.

func CreateExecPodOrFail 

func CreateExecPodOrFail(ctx context.Context, client clientset.Interface, ns, generateName string, tweak func(*v1.Pod)) *v1.Pod

CreateExecPodOrFail creates a agnhost pause pod used as a vessel for kubectl exec commands. Pod name is uniquely generated.

func CreatePod 

func CreatePod(ctx context.Context, client clientset.Interface, namespace string, nodeSelector map[string]string, pvclaims []*v1.PersistentVolumeClaim, securityLevel admissionapi.Level, command string) (*v1.Pod, error)

CreatePod with given claims based on node selector

func CreateSecPod 

func CreateSecPod(ctx context.Context, client clientset.Interface, podConfig *Config, timeout time.Duration) (*v1.Pod, error)

CreateSecPod creates security pod with given claims

func CreateSecPodWithNodeSelection 

func CreateSecPodWithNodeSelection(ctx context.Context, client clientset.Interface, podConfig *Config, timeout time.Duration) (*v1.Pod, error)

CreateSecPodWithNodeSelection creates security pod with given claims

func CreateUnschedulablePod 

func CreateUnschedulablePod(ctx context.Context, client clientset.Interface, namespace string, nodeSelector map[string]string, pvclaims []*v1.PersistentVolumeClaim, securityLevel admissionapi.Level, command string) (*v1.Pod, error)

CreateUnschedulablePod with given claims based on node selector

func DeletePodOrFail 

func DeletePodOrFail(ctx context.Context, c clientset.Interface, ns, name string)

DeletePodOrFail deletes the pod of the specified namespace and name. Resilient to the pod not existing.

func DeletePodWithGracePeriod added in v1.19.0 

func DeletePodWithGracePeriod(ctx context.Context, c clientset.Interface, pod *v1.Pod, grace int64) error

DeletePodWithGracePeriod deletes the passed-in pod. Resilient to the pod not existing.

func DeletePodWithGracePeriodByName added in v1.19.0 

func DeletePodWithGracePeriodByName(ctx context.Context, c clientset.Interface, podName, podNamespace string, grace int64) error

DeletePodWithGracePeriodByName deletes a pod by name and namespace. Resilient to the pod not existing.

func DeletePodWithWait 

func DeletePodWithWait(ctx context.Context, c clientset.Interface, pod *v1.Pod) error

DeletePodWithWait deletes the passed-in pod and waits for the pod to be terminated. Resilient to the pod not existing.

func DeletePodWithWaitByName 

func DeletePodWithWaitByName(ctx context.Context, c clientset.Interface, podName, podNamespace string) error

DeletePodWithWaitByName deletes the named and namespaced pod and waits for the pod to be terminated. Resilient to the pod not existing.

func DeletePodsWithGracePeriod added in v1.19.0 

func DeletePodsWithGracePeriod(ctx context.Context, c clientset.Interface, pods []v1.Pod, grace int64) error

DeletePodsWithGracePeriod deletes the passed-in pods. Resilient to the pods not existing.

func DumpAllPodInfoForNamespace 

func DumpAllPodInfoForNamespace(ctx context.Context, c clientset.Interface, namespace, reportDir string)

DumpAllPodInfoForNamespace logs all pod information for a given namespace.

func ExecCommandInContainer added in v1.26.0 

func ExecCommandInContainer(f *framework.Framework, podName, containerName string, cmd ...string) string

ExecCommandInContainer executes a command in the specified container.

func ExecCommandInContainerWithFullOutput added in v1.26.0 

func ExecCommandInContainerWithFullOutput(f *framework.Framework, podName, containerName string, cmd ...string) (string, string, error)

ExecCommandInContainerWithFullOutput executes a command in the specified container and return stdout, stderr and error

func ExecShellInContainer added in v1.26.0 

func ExecShellInContainer(f *framework.Framework, podName, containerName string, cmd string) string

ExecShellInContainer executes the specified command on the pod's container.

func ExecShellInPod added in v1.26.0 

func ExecShellInPod(ctx context.Context, f *framework.Framework, podName string, cmd string) string

ExecShellInPod executes the specified command on the pod.

func ExecShellInPodWithFullOutput added in v1.26.0 

func ExecShellInPodWithFullOutput(ctx context.Context, f *framework.Framework, podName string, cmd string) (string, string, error)

ExecShellInPodWithFullOutput executes the specified command on the Pod and returns stdout, stderr and error.

func ExecWithOptions added in v1.26.0 

func ExecWithOptions(f *framework.Framework, options ExecOptions) (string, string, error)

ExecWithOptions executes a command in the specified container, returning stdout, stderr and error. `options` allowed for additional parameters to be passed.

func FilterActivePods added in v1.19.0 

func FilterActivePods(pods []*v1.Pod) []*v1.Pod

FilterActivePods returns pods that have not terminated.

func FilterNonRestartablePods 

func FilterNonRestartablePods(pods []*v1.Pod) []*v1.Pod

FilterNonRestartablePods filters out pods that will never get recreated if deleted after termination.

func FindContainerStatusInPod added in v1.27.0 

func FindContainerStatusInPod(pod *v1.Pod, containerName string) *v1.ContainerStatus

FindContainerStatusInPod finds a container status by its name in the provided pod

func FindPodConditionByType added in v1.26.0 

func FindPodConditionByType(podStatus *v1.PodStatus, conditionType v1.PodConditionType) *v1.PodCondition

FindPodConditionByType loops through all pod conditions in pod status and returns the specified condition.

func FormatPod added in v1.28.0 

func FormatPod(pod *v1.Pod) string

FormatPod returns a string representing a pod in a consistent human readable format, with pod name, namespace and pod UID as part of the string. This code is taken from k/k/pkg/kubelet/util/format/pod.go to remove e2e framework -> k/k/pkg/kubelet dependency.

func GenerateContainerSecurityContext added in v1.21.0 

func GenerateContainerSecurityContext(level psaapi.Level) *v1.SecurityContext

GenerateContainerSecurityContext generates the corresponding container security context with the given inputs If the Node OS is windows, currently we will ignore the inputs and return nil. TODO: Will modify it after windows has its own security context

func GeneratePodSecurityContext added in v1.21.0 

func GeneratePodSecurityContext(fsGroup *int64, seLinuxOptions *v1.SELinuxOptions) *v1.PodSecurityContext

GeneratePodSecurityContext generates the corresponding pod security context with the given inputs If the Node OS is windows, currently we will ignore the inputs and return nil. TODO: Will modify it after windows has its own security context

func GenerateScriptCmd added in v1.21.0 

func GenerateScriptCmd(command string) []string

GenerateScriptCmd generates the corresponding command lines to execute a command.

func Get added in v1.27.0 

func Get(c clientset.Interface, pod framework.NamedObject) framework.GetFunc[*v1.Pod]

Get creates a function which retrieves the pod anew each time the function is called. Fatal errors are detected by framework.GetObject and cause polling to stop.

func GetDefaultNonRootUser added in v1.25.0 

func GetDefaultNonRootUser() *int64

GetDefaultNonRootUser returns default non root user If the Node OS is windows, we return nill due to issue with invalid permissions set on projected volumes https://github.com/kubernetes/kubernetes/issues/102849

func GetDefaultTestImage added in v1.21.0 

func GetDefaultTestImage() string

GetDefaultTestImage returns the default test image based on OS. If the node OS is windows, currently we return Agnhost image for Windows node due to the issue of #https://github.com/kubernetes-sigs/windows-testing/pull/35. If the node OS is linux, return busybox image

func GetDefaultTestImageID added in v1.21.0 

func GetDefaultTestImageID() imageutils.ImageID

GetDefaultTestImageID returns the default test image id based on OS. If the node OS is windows, currently we return Agnhost image for Windows node due to the issue of #https://github.com/kubernetes-sigs/windows-testing/pull/35. If the node OS is linux, return busybox image

func GetLinuxLabel added in v1.21.0 

func GetLinuxLabel() *v1.SELinuxOptions

GetLinuxLabel returns the default SELinuxLabel based on OS. If the node OS is windows, it will return nil

func GetPodLogs 

func GetPodLogs(ctx context.Context, c clientset.Interface, namespace, podName, containerName string) (string, error)

GetPodLogs returns the logs of the specified container (namespace/pod/container).

func GetPodLogsSince added in v1.19.3 

func GetPodLogsSince(ctx context.Context, c clientset.Interface, namespace, podName, containerName string, since time.Time) (string, error)

GetPodLogsSince returns the logs of the specified container (namespace/pod/container) since a timestamp.

func GetPodSecretUpdateTimeout added in v1.19.0 

func GetPodSecretUpdateTimeout(ctx context.Context, c clientset.Interface) time.Duration

GetPodSecretUpdateTimeout returns the timeout duration for updating pod secret.

func GetPods added in v1.20.0 

func GetPods(ctx context.Context, c clientset.Interface, ns string, matchLabels map[string]string) ([]v1.Pod, error)

GetPods return the label matched pods in the given ns

func GetPodsInNamespace 

func GetPodsInNamespace(ctx context.Context, c clientset.Interface, ns string, ignoreLabels map[string]string) ([]*v1.Pod, error)

GetPodsInNamespace returns the pods in the given namespace.

func GetPreviousPodLogs 

func GetPreviousPodLogs(ctx context.Context, c clientset.Interface, namespace, podName, containerName string) (string, error)

GetPreviousPodLogs returns the logs of the previous instance of the specified container (namespace/pod/container).

func GetRestrictedContainerSecurityContext added in v1.24.0 

func GetRestrictedContainerSecurityContext() *v1.SecurityContext

GetRestrictedContainerSecurityContext returns a minimal restricted container security context.

func GetRestrictedPodSecurityContext added in v1.24.0 

func GetRestrictedPodSecurityContext() *v1.PodSecurityContext

GetRestrictedPodSecurityContext returns a restricted pod security context. This includes setting RunAsUser for convenience, to pass the RunAsNonRoot check. Tests that require a specific user ID should override this.

func GetTestImage added in v1.21.0 

func GetTestImage(id imageutils.ImageID) string

GetTestImage returns the image name with the given input If the Node OS is windows, currently we return Agnhost image for Windows node due to the issue of #https://github.com/kubernetes-sigs/windows-testing/pull/35.

func GetTestImageID added in v1.21.0 

func GetTestImageID(id imageutils.ImageID) imageutils.ImageID

GetTestImageID returns the image id with the given input If the Node OS is windows, currently we return Agnhost image for Windows node due to the issue of #https://github.com/kubernetes-sigs/windows-testing/pull/35.

func IsPodActive added in v1.19.0 

func IsPodActive(p *v1.Pod) bool

IsPodActive return true if the pod meets certain conditions.

func LogPodStates 

func LogPodStates(pods []v1.Pod)

LogPodStates logs basic info of provided pods for debugging.

func MakePod 

func MakePod(ns string, nodeSelector map[string]string, pvclaims []*v1.PersistentVolumeClaim, securityLevel admissionapi.Level, command string) *v1.Pod

MakePod returns a pod definition based on the namespace. The pod references the PVC's name. A slice of BASH commands can be supplied as args to be run by the pod

func MakePodSpec added in v1.21.0 

func MakePodSpec(podConfig *Config) *v1.PodSpec

MakePodSpec returns a PodSpec definition

func MakeSecPod 

func MakeSecPod(podConfig *Config) (*v1.Pod, error)

MakeSecPod returns a pod definition based on the namespace. The pod references the PVC's name. A slice of BASH commands can be supplied as args to be run by the pod.

func MixinRestrictedPodSecurity added in v1.25.0 

func MixinRestrictedPodSecurity(pod *v1.Pod) error

MixinRestrictedPodSecurity makes the given pod compliant with the restricted pod security level. If doing so would overwrite existing non-conformant configuration, an error is returned. Note that this sets a default RunAsUser. See GetRestrictedPodSecurityContext. TODO(#105919): Handle PodOS for windows pods.

func MustMixinRestrictedPodSecurity added in v1.25.0 

func MustMixinRestrictedPodSecurity(pod *v1.Pod) *v1.Pod

MustMixinRestrictedPodSecurity makes the given pod compliant with the restricted pod security level. If doing so would overwrite existing non-conformant configuration, a test failure is triggered.

func NewAgnhostContainer added in v1.19.9 

func NewAgnhostContainer(containerName string, mounts []v1.VolumeMount, ports []v1.ContainerPort, args ...string) v1.Container

NewAgnhostContainer returns the container Spec of an agnhost container.

func NewAgnhostPod added in v1.19.9 

func NewAgnhostPod(ns, podName string, volumes []v1.Volume, mounts []v1.VolumeMount, ports []v1.ContainerPort, args ...string) *v1.Pod

NewAgnhostPod returns a pod that uses the agnhost image. The image's binary supports various subcommands that behave the same, no matter the underlying OS. If no args are given, it defaults to the pause subcommand. For more information about agnhost subcommands, see: https://github.com/kubernetes/kubernetes/tree/master/test/images/agnhost#agnhost

func NewAgnhostPodFromContainers added in v1.26.0 

func NewAgnhostPodFromContainers(ns, podName string, volumes []v1.Volume, containers ...v1.Container) *v1.Pod

func NewExecPodSpec 

func NewExecPodSpec(ns, name string, hostNetwork bool) *v1.Pod

NewExecPodSpec returns the pod spec of hostexec pod

func NewTransport added in v1.21.6 

func NewTransport(client kubernetes.Interface, restConfig *rest.Config) *http.Transport

NewTransport creates a transport which uses the port forward dialer. URLs must use <namespace>.<pod>:<port> as host.

func NodeOSDistroIs added in v1.21.0 

func NodeOSDistroIs(distro string) bool

NodeOSDistroIs returns true if the distro is the same as `--node-os-distro` the package framework/pod can't import the framework package (see #81245) we need to check if the --node-os-distro=windows is set and the framework package is the one that's parsing the flags, as a workaround this method is looking for the same flag again TODO: replace with `framework.NodeOSDistroIs` when #81245 is complete

func PodsCreated 

func PodsCreated(ctx context.Context, c clientset.Interface, ns, name string, replicas int32) (*v1.PodList, error)

PodsCreated returns a pod list matched by the given name.

func PodsCreatedByLabel 

func PodsCreatedByLabel(ctx context.Context, c clientset.Interface, ns, name string, replicas int32, label labels.Selector) (*v1.PodList, error)

PodsCreatedByLabel returns a created pod list matched by the given label.

func RunningReady added in v1.27.0 

func RunningReady(p *v1.Pod) bool

RunningReady checks whether pod p's phase is running and it has a ready condition of status true.

func SetAffinity 

func SetAffinity(nodeSelection *NodeSelection, nodeName string)

SetAffinity sets affinity to nodeName to nodeSelection

func SetAntiAffinity 

func SetAntiAffinity(nodeSelection *NodeSelection, nodeName string)

SetAntiAffinity sets anti-affinity to nodeName to nodeSelection

func SetNodeAffinity added in v1.18.0 

func SetNodeAffinity(podSpec *v1.PodSpec, nodeName string)

SetNodeAffinity modifies the given pod object with NodeAffinity to the given node name.

func SetNodeAffinityTopologyRequirement added in v1.18.0 

func SetNodeAffinityTopologyRequirement(nodeSelection *NodeSelection, topology map[string]string)

SetNodeAffinityTopologyRequirement sets node affinity to a specified topology

func SetNodeSelection added in v1.18.0 

func SetNodeSelection(podSpec *v1.PodSpec, nodeSelection NodeSelection)

SetNodeSelection modifies the given pod object with the specified NodeSelection

func VerifyPodHasConditionWithType added in v1.26.0 

func VerifyPodHasConditionWithType(ctx context.Context, f *framework.Framework, pod *v1.Pod, cType v1.PodConditionType)

VerifyPodHasConditionWithType verifies the pod has the expected condition by type

func VerifyPods 

func VerifyPods(ctx context.Context, c clientset.Interface, ns, name string, wantName bool, replicas int32) error

VerifyPods checks if the specified pod is responding.

func VerifyPodsRunning 

func VerifyPodsRunning(ctx context.Context, c clientset.Interface, ns, name string, wantName bool, replicas int32) error

VerifyPodsRunning checks if the specified pod is running.

func WaitForContainerRunning added in v1.23.0 

func WaitForContainerRunning(ctx context.Context, c clientset.Interface, namespace, podName, containerName string, timeout time.Duration) error

WaitForContainerRunning waits for the given Pod container to have a state of running

func WaitForContainerTerminated added in v1.30.0 

func WaitForContainerTerminated(ctx context.Context, c clientset.Interface, namespace, podName, containerName string, timeout time.Duration) error

WaitForContainerTerminated waits for the given Pod container to have a state of terminated

func WaitForNRestartablePods 

func WaitForNRestartablePods(ctx context.Context, ps *testutils.PodStore, expect int, timeout time.Duration) ([]string, error)

WaitForNRestartablePods tries to list restarting pods using ps until it finds expect of them, returning their names if it can do so before timeout.

func WaitForNumberOfPods added in v1.22.0 

func WaitForNumberOfPods(ctx context.Context, c clientset.Interface, ns string, num int, timeout time.Duration) (pods *v1.PodList, err error)

WaitForNumberOfPods waits up to timeout to ensure there are exact `num` pods in namespace `ns`. It returns the matching Pods or a timeout error.

func WaitForPodCondition 

func WaitForPodCondition(ctx context.Context, c clientset.Interface, ns, podName, conditionDesc string, timeout time.Duration, condition podCondition) error

WaitForPodCondition waits a pods to be matched to the given condition. The condition callback may use gomega.StopTrying to abort early.

func WaitForPodContainerStarted added in v1.21.0 

func WaitForPodContainerStarted(ctx context.Context, c clientset.Interface, namespace, podName string, containerIndex int, timeout time.Duration) error

WaitForPodContainerStarted waits for the given Pod container to start, after a successful run of the startupProbe.

func WaitForPodContainerToFail added in v1.20.0 

func WaitForPodContainerToFail(ctx context.Context, c clientset.Interface, namespace, podName string, containerIndex int, reason string, timeout time.Duration) error

WaitForPodContainerToFail waits for the given Pod container to fail with the given reason, specifically due to invalid container configuration. In this case, the container will remain in a waiting state with a specific reason set, which should match the given reason.

func WaitForPodFailedReason added in v1.23.0 

func WaitForPodFailedReason(ctx context.Context, c clientset.Interface, pod *v1.Pod, reason string, timeout time.Duration) error

WaitForPodFailedReason wait for pod failed reason in status, for example "SysctlForbidden".

func WaitForPodNameRunningInNamespace 

func WaitForPodNameRunningInNamespace(ctx context.Context, c clientset.Interface, podName, namespace string) error

WaitForPodNameRunningInNamespace waits default amount of time (PodStartTimeout) for the specified pod to become running. Returns an error if timeout occurs first, or pod goes in to failed state.

func WaitForPodNameUnschedulableInNamespace 

func WaitForPodNameUnschedulableInNamespace(ctx context.Context, c clientset.Interface, podName, namespace string) error

WaitForPodNameUnschedulableInNamespace returns an error if it takes too long for the pod to become Pending and have condition Status equal to Unschedulable, if the pod Get api returns an error (IsNotFound or other), or if the pod failed with an unexpected reason. Typically called to test that the passed-in pod is Pending and Unschedulable.

func WaitForPodNoLongerRunningInNamespace 

func WaitForPodNoLongerRunningInNamespace(ctx context.Context, c clientset.Interface, podName, namespace string) error

WaitForPodNoLongerRunningInNamespace waits default amount of time (defaultPodDeletionTimeout) for the specified pod to stop running. Returns an error if timeout occurs first.

func WaitForPodNotFoundInNamespace 

func WaitForPodNotFoundInNamespace(ctx context.Context, c clientset.Interface, podName, ns string, timeout time.Duration) error

WaitForPodNotFoundInNamespace returns an error if it takes too long for the pod to fully terminate. Unlike `waitForPodTerminatedInNamespace`, the pod's Phase and Reason are ignored. If the pod Get api returns IsNotFound then the wait stops and nil is returned. If the Get api returns an error other than "not found" and that error is final, that error is returned and the wait stops.

func WaitForPodNotPending 

func WaitForPodNotPending(ctx context.Context, c clientset.Interface, ns, podName string) error

WaitForPodNotPending returns an error if it took too long for the pod to go out of pending state. The resourceVersion is used when Watching object changes, it tells since when we care about changes to the pod.

func WaitForPodRunningInNamespace 

func WaitForPodRunningInNamespace(ctx context.Context, c clientset.Interface, pod *v1.Pod) error

WaitForPodRunningInNamespace waits default amount of time (podStartTimeout) for the specified pod to become running. Returns an error if timeout occurs first, or pod goes in to failed state.

func WaitForPodRunningInNamespaceSlow 

func WaitForPodRunningInNamespaceSlow(ctx context.Context, c clientset.Interface, podName, namespace string) error

WaitForPodRunningInNamespaceSlow waits an extended amount of time (slowPodStartTimeout) for the specified pod to become running. The resourceVersion is used when Watching object changes, it tells since when we care about changes to the pod. Returns an error if timeout occurs first, or pod goes in to failed state.

func WaitForPodScheduled added in v1.27.0 

func WaitForPodScheduled(ctx context.Context, c clientset.Interface, namespace, podName string) error

WaitForPodScheduled waits for the pod to be schedule, ie. the .spec.nodeName is set

func WaitForPodSuccessInNamespace 

func WaitForPodSuccessInNamespace(ctx context.Context, c clientset.Interface, podName string, namespace string) error

WaitForPodSuccessInNamespace returns nil if the pod reached state success, or an error if it reached failure or until podStartupTimeout.

func WaitForPodSuccessInNamespaceTimeout added in v1.21.0 

func WaitForPodSuccessInNamespaceTimeout(ctx context.Context, c clientset.Interface, podName, namespace string, timeout time.Duration) error

WaitForPodSuccessInNamespaceTimeout returns nil if the pod reached state success, or an error if it reached failure or ran too long.

func WaitForPodTerminatedInNamespace 

func WaitForPodTerminatedInNamespace(ctx context.Context, c clientset.Interface, podName, reason, namespace string) error

WaitForPodTerminatedInNamespace returns an error if it takes too long for the pod to terminate, if the pod Get api returns an error (IsNotFound or other), or if the pod failed (and thus did not terminate) with an unexpected reason. Typically called to test that the passed-in pod is fully terminated (reason==""), but may be called to detect if a pod did *not* terminate according to the supplied reason.

func WaitForPodTerminatingInNamespaceTimeout added in v1.26.0 

func WaitForPodTerminatingInNamespaceTimeout(ctx context.Context, c clientset.Interface, podName, namespace string, timeout time.Duration) error

WaitForPodTerminatingInNamespaceTimeout returns if the pod is terminating, or an error if it is not after the timeout.

func WaitForPods added in v1.27.0 

func WaitForPods(ctx context.Context, c clientset.Interface, ns string, opts metav1.ListOptions, r Range, timeout time.Duration, conditionDesc string, condition func(*v1.Pod) bool) (*v1.PodList, error)

WaitForPods waits for pods in the given namespace to match the given condition. How many pods must exist and how many must match the condition is determined by the range parameter. The condition callback may use gomega.StopTrying(...).Now() to abort early. The condition description will be used with "expected pods to <description>".

func WaitForPodsResponding added in v1.27.0 

func WaitForPodsResponding(ctx context.Context, c clientset.Interface, ns string, controllerName string, wantName bool, timeout time.Duration, pods *v1.PodList) error

WaitForPodsResponding waits for the pods to response.

func WaitForPodsRunning added in v1.26.0 

func WaitForPodsRunning(ctx context.Context, c clientset.Interface, ns string, num int, timeout time.Duration) error

WaitForPodsRunning waits for a given `timeout` to evaluate if a certain amount of pods in given `ns` are running.

func WaitForPodsRunningReady 

func WaitForPodsRunningReady(ctx context.Context, c clientset.Interface, ns string, minPods, allowedNotReadyPods int32, timeout time.Duration) error

WaitForPodsRunningReady waits up to timeout to ensure that all pods in namespace ns are either running and ready, or failed but controlled by a controller. Also, it ensures that at least minPods are running and ready. It has separate behavior from other 'wait for' pods functions in that it requests the list of pods on every iteration. This is useful, for example, in cluster startup, because the number of pods increases while waiting. All pods that are in SUCCESS state are not counted.

If minPods or allowedNotReadyPods are -1, this method returns immediately without waiting.

func WaitForPodsSchedulingGated added in v1.26.0 

func WaitForPodsSchedulingGated(ctx context.Context, c clientset.Interface, ns string, num int, timeout time.Duration) error

WaitForPodsSchedulingGated waits for a given `timeout` to evaluate if a certain amount of pods in given `ns` stay in scheduling gated state.

func WaitForPodsWithLabel 

func WaitForPodsWithLabel(ctx context.Context, c clientset.Interface, ns string, label labels.Selector) (*v1.PodList, error)

WaitForPodsWithLabel waits up to podListTimeout for getting pods with certain label

func WaitForPodsWithLabelRunningReady 

func WaitForPodsWithLabelRunningReady(ctx context.Context, c clientset.Interface, ns string, label labels.Selector, num int, timeout time.Duration) (pods *v1.PodList, err error)

WaitForPodsWithLabelRunningReady waits for exact amount of matching pods to become running and ready. Return the list of matching pods.

func WaitForPodsWithLabelScheduled 

func WaitForPodsWithLabelScheduled(ctx context.Context, c clientset.Interface, ns string, label labels.Selector) (pods *v1.PodList, err error)

WaitForPodsWithLabelScheduled waits for all matching pods to become scheduled and at least one matching pod exists. Return the list of matching pods.

func WaitForPodsWithSchedulingGates added in v1.26.0 

func WaitForPodsWithSchedulingGates(ctx context.Context, c clientset.Interface, ns string, num int, timeout time.Duration, schedulingGates []v1.PodSchedulingGate) error

WaitForPodsWithSchedulingGates waits for a given `timeout` to evaluate if a certain amount of pods in given `ns` match the given `schedulingGates`stay in scheduling gated state.

func WaitTimeoutForPodNoLongerRunningInNamespace 

func WaitTimeoutForPodNoLongerRunningInNamespace(ctx context.Context, c clientset.Interface, podName, namespace string, timeout time.Duration) error

WaitTimeoutForPodNoLongerRunningInNamespace waits the given timeout duration for the specified pod to stop.

func WaitTimeoutForPodReadyInNamespace 

func WaitTimeoutForPodReadyInNamespace(ctx context.Context, c clientset.Interface, podName, namespace string, timeout time.Duration) error

WaitTimeoutForPodReadyInNamespace waits the given timeout duration for the specified pod to be ready and running.

func WaitTimeoutForPodRunningInNamespace 

func WaitTimeoutForPodRunningInNamespace(ctx context.Context, c clientset.Interface, podName, namespace string, timeout time.Duration) error

WaitTimeoutForPodRunningInNamespace waits the given timeout duration for the specified pod to become running. It does not need to exist yet when this function gets called and the pod is not expected to be recreated when it succeeds or fails.

func WithWindowsHostProcess added in v1.24.0 

func WithWindowsHostProcess(pod *v1.Pod, username string)

WithWindowsHostProcess sets the Pod's Windows HostProcess option to true. When this option is set, HostNetwork can be enabled. Containers running as HostProcess will require certain usernames to be set, otherwise the Pod will not start: NT AUTHORITY\SYSTEM, NT AUTHORITY\Local service, NT AUTHORITY\NetworkService. If the given username is empty, NT AUTHORITY\SYSTEM will be used instead. See: https://kubernetes.io/docs/tasks/configure-pod-container/create-hostprocess-pod/

Types

type Addr added in v1.21.6 

type Addr struct {
	Namespace, PodName string
	Port               int
}

Addr contains all relevant parameters for a certain port in a pod. The container should be running before connections are attempted, otherwise the connection will fail.

func ParseAddr added in v1.21.6 

func ParseAddr(addr string) (*Addr, error)

ParseAddr expects a <namespace>.<pod>:<port number> as produced by Addr.String.

func (Addr) Network added in v1.21.6 

func (a Addr) Network() string

func (Addr) String added in v1.21.6 

func (a Addr) String() string

type Config added in v1.19.0 

type Config struct {
	NS                     string
	PVCs                   []*v1.PersistentVolumeClaim
	PVCsReadOnly           bool
	InlineVolumeSources    []*v1.VolumeSource
	SecurityLevel          admissionapi.Level
	Command                string
	HostIPC                bool
	HostPID                bool
	SeLinuxLabel           *v1.SELinuxOptions
	FsGroup                *int64
	NodeSelection          NodeSelection
	ImageID                imageutils.ImageID
	PodFSGroupChangePolicy *v1.PodFSGroupChangePolicy
}

Config is a struct containing all arguments for creating a pod. SELinux testing requires to pass HostIPC and HostPID as boolean arguments.

type Dialer added in v1.21.6 

type Dialer struct {
	// contains filtered or unexported fields
}

Dialer holds the relevant parameters that are independent of a particular connection.

func NewDialer added in v1.21.6 

func NewDialer(client kubernetes.Interface, restConfig *rest.Config) *Dialer

NewDialer creates a dialer that supports connecting to container ports.

func (*Dialer) DialContainerPort added in v1.21.6 

func (d *Dialer) DialContainerPort(ctx context.Context, addr Addr) (conn net.Conn, finalErr error)

DialContainerPort connects to a certain container port in a pod.

type ExecOptions added in v1.26.0 

type ExecOptions struct {
	Command       []string
	Namespace     string
	PodName       string
	ContainerName string
	Stdin         io.Reader
	CaptureStdout bool
	CaptureStderr bool
	// If false, whitespace in std{err,out} will be removed.
	PreserveWhitespace bool
	Quiet              bool
}

ExecOptions passed to ExecWithOptions

type LocalAddr added in v1.21.6 

type LocalAddr struct{}

func (LocalAddr) Network added in v1.21.6 

func (l LocalAddr) Network() string

func (LocalAddr) String added in v1.21.6 

func (l LocalAddr) String() string

type NodeSelection 

type NodeSelection struct {
	Name     string
	Selector map[string]string
	Affinity *v1.Affinity
}

NodeSelection specifies where to run a pod, using a combination of fixed node name, node selector and/or affinity.

type PodClient added in v1.26.0 

type PodClient struct {
	v1core.PodInterface
	// contains filtered or unexported fields
}

PodClient is a struct for pod client.

func NewPodClient added in v1.26.0 

func NewPodClient(f *framework.Framework) *PodClient

NewPodClient is a convenience method for getting a pod client interface in the framework's namespace, possibly applying test-suite specific transformations to the pod spec, e.g. for node e2e pod scheduling.

func PodClientNS added in v1.26.0 

func PodClientNS(f *framework.Framework, namespace string) *PodClient

PodClientNS is a convenience method for getting a pod client interface in an alternative namespace, possibly applying test-suite specific transformations to the pod spec, e.g. for node e2e pod scheduling.

func (*PodClient) AddEphemeralContainerSync added in v1.26.0 

func (c *PodClient) AddEphemeralContainerSync(ctx context.Context, pod *v1.Pod, ec *v1.EphemeralContainer, timeout time.Duration) error

AddEphemeralContainerSync adds an EphemeralContainer to a pod and waits for it to be running.

func (*PodClient) Create added in v1.26.0 

func (c *PodClient) Create(ctx context.Context, pod *v1.Pod) *v1.Pod

Create creates a new pod according to the framework specifications (don't wait for it to start).

func (*PodClient) CreateBatch added in v1.26.0 

func (c *PodClient) CreateBatch(ctx context.Context, pods []*v1.Pod) []*v1.Pod

CreateBatch create a batch of pods. All pods are created before waiting.

func (*PodClient) CreateSync added in v1.26.0 

func (c *PodClient) CreateSync(ctx context.Context, pod *v1.Pod) *v1.Pod

CreateSync creates a new pod according to the framework specifications, and wait for it to start and be running and ready.

func (*PodClient) DeleteSync added in v1.26.0 

func (c *PodClient) DeleteSync(ctx context.Context, name string, options metav1.DeleteOptions, timeout time.Duration)

DeleteSync deletes the pod and wait for the pod to disappear for `timeout`. If the pod doesn't disappear before the timeout, it will fail the test.

func (*PodClient) MatchContainerOutput added in v1.26.0 

func (c *PodClient) MatchContainerOutput(ctx context.Context, name string, containerName string, expectedRegexp string) error

MatchContainerOutput gets output of a container and match expected regexp in the output.

func (*PodClient) PodIsReady added in v1.26.0 

func (c *PodClient) PodIsReady(ctx context.Context, name string) bool

PodIsReady returns true if the specified pod is ready. Otherwise false.

func (*PodClient) RemoveFinalizer added in v1.26.0 

func (c *PodClient) RemoveFinalizer(ctx context.Context, podName string, finalizerName string)

RemoveFinalizer removes the pod's finalizer

func (*PodClient) Update added in v1.26.0 

func (c *PodClient) Update(ctx context.Context, name string, updateFn func(pod *v1.Pod))

Update updates the pod object. It retries if there is a conflict, throw out error if there is any other apierrors. name is the pod name, updateFn is the function updating the pod object.

func (*PodClient) WaitForErrorEventOrSuccess added in v1.26.0 

func (c *PodClient) WaitForErrorEventOrSuccess(ctx context.Context, pod *v1.Pod) (*v1.Event, error)

WaitForErrorEventOrSuccess waits for pod to succeed or an error event for that pod.

func (*PodClient) WaitForFinish added in v1.26.0 

func (c *PodClient) WaitForFinish(ctx context.Context, name string, timeout time.Duration)

WaitForFinish waits for pod to finish running, regardless of success or failure.

func (*PodClient) WaitForSuccess added in v1.26.0 

func (c *PodClient) WaitForSuccess(ctx context.Context, name string, timeout time.Duration)

WaitForSuccess waits for pod to succeed. TODO(random-liu): Move pod wait function into this file

type Range added in v1.27.0 

type Range struct {
	// MinMatching must be <= actual matching items or <= 0.
	MinMatching int
	// MaxMatching must be >= actual matching items or <= 0.
	// To check for "no matching items", set NonMatching.
	MaxMatching int
	// NoneMatching indicates that no item must match.
	NoneMatching bool
	// AllMatching indicates that all items must match.
	AllMatching bool
	// MinFound must be <= existing items or <= 0.
	MinFound int
}

Range determines how many items must exist and how many must match a certain condition. Values <= 0 are ignored. TODO (?): move to test/e2e/framework/range

func (Range) Min added in v1.27.0 

func (r Range) Min() int

Min returns how many items must exist.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.