PodLogStream v1alpha1

apiVersion: tilt.dev/v1alpha1

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

PodLogStream

PodLogStream

Streams logs from a pod on Kubernetes into the core Tilt engine.


PodLogStreamSpec

PodLogStreamSpec defines the desired state of PodLogStream

Translated into a PodLog query to the current Kubernetes cluster: https://pkg.go.dev/k8s.io/api/core/v1#PodLogOptions

which Kubernetes context to use?


  • ignoreContainers ([]string)

    The names of containers to exclude from the stream.

    If onlyContainers and ignoreContainers are not set, will watch all containers in the pod.

  • namespace (string)

    The namespace of the pod to watch. Defaults to the kubecontext default namespace.

  • onlyContainers ([]string)

    The names of containers to include in the stream.

    If onlyContainers and ignoreContainers are not set, will watch all containers in the pod.

  • pod (string)

    The name of the pod to watch. Required.

  • sinceTime (Time)

    An RFC3339 timestamp from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned.

    Translates directly to the underlying PodLogOptions.

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

PodLogStreamStatus

PodLogStreamStatus defines the observed state of PodLogStream


  • containerStatuses ([]ContainerLogStreamStatus)

    A list of containers being watched.

    ContainerLogStreamStatus defines the current status of each individual container log stream.

    • containerStatuses.active (boolean)

      True when the stream is set up and streaming logs properly.

    • containerStatuses.error (string)

      The last error message encountered while streaming.

      Empty when the stream is actively streaming or successfully terminated.

    • containerStatuses.name (string)

      The name of the container.

    • containerStatuses.terminated (boolean)

      True when the logs are done stream and the container is terminated.

PodLogStreamList

PodLogStreamList


  • apiVersion: tilt.dev/v1alpha1

  • kind: PodLogStreamList

  • metadata (ListMeta)

  • items ([]PodLogStream), required

Operations


get read the specified PodLogStream

HTTP Request

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

Parameters

  • name (in path): string, required

    name of the PodLogStream

  • pretty (in query): string

    pretty

Response

200 (PodLogStream): OK

get read status of the specified PodLogStream

HTTP Request

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

Parameters

  • name (in path): string, required

    name of the PodLogStream

  • pretty (in query): string

    pretty

Response

200 (PodLogStream): OK

list list or watch objects of kind PodLogStream

HTTP Request

GET /apis/tilt.dev/v1alpha1/podlogstreams

Parameters

  • allowWatchBookmarks (in query): boolean

    allowWatchBookmarks requests watch events with type “BOOKMARK”. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server’s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

  • continue (in query): string

    continue

  • fieldSelector (in query): string

    fieldSelector

  • labelSelector (in query): string

    labelSelector

  • limit (in query): integer

    limit

  • pretty (in query): string

    pretty

  • resourceVersion (in query): string

    resourceVersion

  • resourceVersionMatch (in query): string

    resourceVersionMatch

  • timeoutSeconds (in query): integer

    timeoutSeconds

  • watch (in query): boolean

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Response

200 (PodLogStreamList): OK

create create a PodLogStream

HTTP Request

POST /apis/tilt.dev/v1alpha1/podlogstreams

Parameters

Response

200 (PodLogStream): OK

201 (PodLogStream): Created

202 (PodLogStream): Accepted

update replace the specified PodLogStream

HTTP Request

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

Parameters

  • name (in path): string, required

    name of the PodLogStream

  • body: PodLogStream, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • pretty (in query): string

    pretty

Response

200 (PodLogStream): OK

201 (PodLogStream): Created

update replace status of the specified PodLogStream

HTTP Request

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

Parameters

  • name (in path): string, required

    name of the PodLogStream

  • body: PodLogStream, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • pretty (in query): string

    pretty

Response

200 (PodLogStream): OK

201 (PodLogStream): Created

patch partially update the specified PodLogStream

HTTP Request

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

Parameters

  • name (in path): string, required

    name of the PodLogStream

  • 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 (PodLogStream): OK

patch partially update status of the specified PodLogStream

HTTP Request

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

Parameters

  • name (in path): string, required

    name of the PodLogStream

  • 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 (PodLogStream): OK

delete delete a PodLogStream

HTTP Request

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

Parameters

Response

200 (Status): OK

202 (Status): Accepted

deletecollection delete collection of PodLogStream

HTTP Request

DELETE /apis/tilt.dev/v1alpha1/podlogstreams

Parameters

Response

200 (Status): OK