@hashgraph/solo
    Preparing search index...

    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: true,
            reuse?: boolean,
        ): Promise<number>;
        portForward(
            localPort: number,
            podPort: number,
            detach?: false,
            reuse?: boolean,
        ): Promise<ExtendedNetServer>;
        stopPortForward(
            server: ExtendedNetServer,
            maxAttempts?: number,
            timeout?: number,
        ): Promise<void>;
    }

    Implemented by

    Index

    Properties

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

    Methods

    killPod portForward stopPortForward

    Properties

    conditions?: PodCondition[]

    The conditions of the pod

    containerCommand?: string[]

    The container command

    containerImage?: string

    The container image

    containerName?: ContainerName

    The container name

    deletionTimestamp?: Date

    The deletion timestamp of the pod

    labels?: Record<string, string>

    The labels of the pod

    podIp?: string

    The pod IP

    podReference: PodReference

    The pod reference

    startupProbeCommand?: string[]

    The command to run for the startup probe

    Methods

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

    • 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

      • detach: true

        if true, the port forward will run in the background and return the port number

      • Optionalreuse: boolean

        if true, reuse the port number from previous port forward operation

      Returns Promise<number>

      Promise resolving to the port forwarder server when not detached, or the port number (which may differ from localPort if it was in use) when detached

    • Parameters

      • localPort: number
      • podPort: number
      • Optionaldetach: false
      • Optionalreuse: boolean

      Returns Promise<ExtendedNetServer>

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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods