Interface Pod

podRef

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
  • 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>