Interface Pod

interface Pod {
    conditions?: PodCondition[];
    containerCommand?: string[];
    containerImage?: string;
    containerName?: ContainerName;
    deletionTimestamp?: Date;
    labels?: Record<string, string>;
    podIp?: string;
    podReference: PodReference;
    startupProbeCommand?: string[];
    killPod(): Promise<void>;
    portForward(
        localPort: number,
        podPort: number,
        detach?: boolean,
    ): Promise<ExtendedNetServer>;
    stopPortForward(
        server: ExtendedNetServer,
        maxAttempts?: number,
        timeout?: number,
    ): Promise<void>;
}

Implemented by

K8ClientPod

Index

Properties

conditions? containerCommand? containerImage? containerName? deletionTimestamp? labels? podIp? podReference startupProbeCommand?

Methods

killPod portForward stopPortForward

Properties

`Optional` `Readonly`conditions

conditions?: PodCondition[]

The conditions of the pod

`Optional` `Readonly`containerCommand

containerCommand?: string[]

The container command

`Optional` `Readonly`containerImage

containerImage?: string

The container image

`Optional` `Readonly`containerName

containerName?: ContainerName

The container name

`Optional` `Readonly`deletionTimestamp

deletionTimestamp?: Date

The deletion timestamp of the pod

`Optional` `Readonly`labels

labels?: Record<string, string>

The labels of the pod

`Optional` `Readonly`podIp

podIp?: string

The pod IP

`Readonly`podReference

podReference: PodReference

The pod reference

`Optional` `Readonly`startupProbeCommand

startupProbeCommand?: string[]

The command to run for the startup probe

Methods

killPod

killPod(): Promise<void>
Get a pod by name and namespace, will check every 1 second until the pod is no longer found. Can throw a SoloError if there is an error while deleting the pod.

Returns Promise<void>
- Defined in src/integration/kube/resources/pod/pod.ts:58

portForward

portForward(
    localPort: number,
    podPort: number,
    detach?: boolean,
): Promise<ExtendedNetServer>
Port forward a port from a pod to localhost

This simple server just forwards traffic from itself to a service running in kubernetes -> localhost:localPort -> port-forward-tunnel -> kubernetes-pod:targetPort
Parameters
- localPort: number
  the local port to forward to
- podPort: number
  the port on the pod to forward from
- Optionaldetach: boolean
  if true, the port forward will run in the background and return immediately
Returns Promise<ExtendedNetServer>
an instance of ExtendedNetServer
- Defined in src/integration/kube/resources/pod/pod.ts:70

stopPortForward

stopPortForward(
    server: ExtendedNetServer,
    maxAttempts?: number,
    timeout?: number,
): Promise<void>
Stop the port forward
Parameters
- server: ExtendedNetServer
  an instance of server returned by portForward method
- OptionalmaxAttempts: number
  the maximum number of attempts to check if the server is stopped
- Optionaltimeout: number
  the delay between checks in milliseconds
Returns Promise<void>
- Defined in src/integration/kube/resources/pod/pod.ts:78