PortForward v1alpha1

apiVersion: tilt.dev/v1alpha1

import "github.com/tilt-dev/tilt/pkg/apis/core/v1alpha1"

PortForward

PortForward


PortForwardSpec

PortForwardSpec defines the desired state of PortForward


  • forwards ([]Forward), required

    One or more port forwards to execute on the given pod. Required.

    Forward defines a port forward to execute on a given pod.

    • forwards.containerPort (int32), required

      The port on the Kubernetes pod to connect to. Required.

    • forwards.host (string)

      Optional host to bind to on the current machine (localhost by default)

    • forwards.localPort (int32)

      The port to expose on the current machine.

      If not specified (or 0), a random free port will be chosen and can be discovered via the status once established.

  • podName (string), required

    The name of the pod to port forward to/from. Required.

  • namespace (string)

    The namespace of the pod to port forward to/from. Defaults to the kubecontext default namespace.

PortForwardStatus

PortForwardStatus defines the observed state of PortForward


  • forwardStatuses ([]ForwardStatus)

    **

    • forwardStatuses.addresses ([]string), required

      Addresses that the forwarder is bound to.

      For example, a localhost host will bind to 127.0.0.1 and [::1].

    • forwardStatuses.containerPort (int32), required

      ContainerPort is the port in the container being forwarded.

    • forwardStatuses.localPort (int32), required

      LocalPort is the port bound to on the system running Tilt.

    • forwardStatuses.error (string)

      Error is a human-readable description if a problem was encountered while initializing the forward.

    • forwardStatuses.startedAt (MicroTime)

      StartedAt is the time at which the forward was initiated.

      If the forwarder is not running yet, this will be zero/empty.

      MicroTime is version of Time with microsecond level precision.

PortForwardList

PortForwardList


  • apiVersion: tilt.dev/v1alpha1

  • kind: PortForwardList

  • metadata (ListMeta)

  • items ([]PortForward), required

Operations


get read the specified PortForward

HTTP Request

GET /apis/tilt.dev/v1alpha1/portforwards/{name}

Parameters

  • name (in path): string, required

    name of the PortForward

  • pretty (in query): string

    pretty

Response

200 (PortForward): OK

get read status of the specified PortForward

HTTP Request

GET /apis/tilt.dev/v1alpha1/portforwards/{name}/status

Parameters

  • name (in path): string, required

    name of the PortForward

  • pretty (in query): string

    pretty

Response

200 (PortForward): OK

list list or watch objects of kind PortForward

HTTP Request

GET /apis/tilt.dev/v1alpha1/portforwards

Parameters

Response

200 (PortForwardList): OK

create create a PortForward

HTTP Request

POST /apis/tilt.dev/v1alpha1/portforwards

Parameters

Response

200 (PortForward): OK

201 (PortForward): Created

202 (PortForward): Accepted

update replace the specified PortForward

HTTP Request

PUT /apis/tilt.dev/v1alpha1/portforwards/{name}

Parameters

  • name (in path): string, required

    name of the PortForward

  • body: PortForward, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • pretty (in query): string

    pretty

Response

200 (PortForward): OK

201 (PortForward): Created

update replace status of the specified PortForward

HTTP Request

PUT /apis/tilt.dev/v1alpha1/portforwards/{name}/status

Parameters

  • name (in path): string, required

    name of the PortForward

  • body: PortForward, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • pretty (in query): string

    pretty

Response

200 (PortForward): OK

201 (PortForward): Created

patch partially update the specified PortForward

HTTP Request

PATCH /apis/tilt.dev/v1alpha1/portforwards/{name}

Parameters

  • name (in path): string, required

    name of the PortForward

  • body: Patch, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • force (in query): boolean

    force

  • pretty (in query): string

    pretty

Response

200 (PortForward): OK

patch partially update status of the specified PortForward

HTTP Request

PATCH /apis/tilt.dev/v1alpha1/portforwards/{name}/status

Parameters

  • name (in path): string, required

    name of the PortForward

  • body: Patch, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • force (in query): boolean

    force

  • pretty (in query): string

    pretty

Response

200 (PortForward): OK

delete delete a PortForward

HTTP Request

DELETE /apis/tilt.dev/v1alpha1/portforwards/{name}

Parameters

Response

200 (Status): OK

202 (Status): Accepted

deletecollection delete collection of PortForward

HTTP Request

DELETE /apis/tilt.dev/v1alpha1/portforwards

Parameters

Response

200 (Status): OK