Class K8ClientPod

constructor

• new K8ClientPod(
      podReference: PodReference,
      pods: Pods,
      kubeClient: CoreV1Api,
      kubeConfig: KubeConfig,
      labels?: Record<string, string>,
      startupProbeCommand?: string[],
      containerName?: ContainerName,
      containerImage?: string,
      containerCommand?: string[],
      conditions?: PodCondition[],
      podIp?: string,
      deletionTimestamp?: Date,
  ): K8ClientPod

  Parameters

  • podReference: PodReference
  • pods: Pods
  • kubeClient: CoreV1Api
  • kubeConfig: KubeConfig
  • Optionallabels: Record<string, string>
  • OptionalstartupProbeCommand: string[]
  • OptionalcontainerName: ContainerName
  • OptionalcontainerImage: string
  • OptionalcontainerCommand: string[]
  • Optionalconditions: PodCondition[]
  • OptionalpodIp: string
  • OptionaldeletionTimestamp: Date

  Returns K8ClientPod

Optional Readonlyconditions

Optional ReadonlycontainerCommand

Optional ReadonlycontainerImage

Optional ReadonlycontainerName

Optional ReadonlydeletionTimestamp

Optional Readonlylabels

Optional ReadonlypodIp

ReadonlypodReference

Optional ReadonlystartupProbeCommand

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>

portForward

• portForward(localPort: number, podPort: number): 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

  Returns Promise<ExtendedNetServer>

  an instance of ExtendedNetServer

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
  • maxAttempts: number = 20

    the maximum number of attempts to check if the server is stopped
  • timeout: number = 500

    the delay between checks in milliseconds

  Returns Promise<void>

StaticfromV1Pod

• fromV1Pod(
      v1Pod: V1Pod,
      pods: Pods,
      coreV1Api: CoreV1Api,
      kubeConfig: KubeConfig,
  ): Pod

  Parameters

  • v1Pod: V1Pod
  • pods: Pods
  • coreV1Api: CoreV1Api
  • kubeConfig: KubeConfig

  Returns Pod

StatictoV1Pod

• toV1Pod(pod: Pod): V1Pod

  Parameters

  • pod: Pod

  Returns V1Pod