Tiltfile v1alpha1

apiVersion: tilt.dev/v1alpha1

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

Tiltfile

Tiltfile is the main way users add services to Tilt.

The Tiltfile evaluator executes the Tiltfile, then adds all the objects it creates as children of the Tiltfile object.


TiltfileSpec

TiltfileSpec defines the desired state of Tiltfile


  • path (string), required

    The path to the Tiltfile on disk.

  • labels (map[string]string)

    A set of labels to apply to all objects owned by this Tiltfile.

  • restartOn (RestartOnSpec)

    Objects that can trigger a re-execution of this Tiltfile.

    RestartOnSpec indicates the set of objects that can trigger a restart of this object.

    • restartOn.fileWatches ([]string), required

      A list of file watches that can trigger a restart.

TiltfileStatus

TiltfileStatus defines the observed state of Tiltfile


  • running (TiltfileStateRunning)

    Details about a running tiltfile.

    TiltfileStateRunning is a running state of a tiltfile execution.

    • running.reasons ([]string)

      The reason why this tiltfile was built. May contain more than one reason.

    • running.startedAt (MicroTime)

      Time at which previous execution of the command started.

      MicroTime is version of Time with microsecond level precision.

  • terminated (TiltfileStateTerminated)

    Details about a terminated tiltfile.

    TiltfileStateTerminated is a terminated state of a tiltfile execution.

    • terminated.error (string)

      Error message if this tiltfile execution failed.

    • terminated.finishedAt (MicroTime)

      Time at which the command last terminated.

      MicroTime is version of Time with microsecond level precision.

    • terminated.reasons ([]string)

      The reasons why this tiltfile was built. May contain more than one reason.

    • terminated.startedAt (MicroTime)

      Time at which previous execution of the command started.

      MicroTime is version of Time with microsecond level precision.

    • terminated.warningCount (int32)

      Number of warnings generated by this Tiltfile. (brief) reason the process is terminated

  • waiting (TiltfileStateWaiting)

    Details about a waiting tiltfile.

    TiltfileStateWaiting is a waiting state of a tiltfile execution.

    • waiting.reason (string)

      (brief) reason the tiltfile is waiting.

TiltfileList

TiltfileList


  • apiVersion: tilt.dev/v1alpha1

  • kind: TiltfileList

  • metadata (ListMeta)

  • items ([]Tiltfile), required

Operations


get read the specified Tiltfile

HTTP Request

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

Parameters

  • name (in path): string, required

    name of the Tiltfile

  • pretty (in query): string

    pretty

Response

200 (Tiltfile): OK

get read status of the specified Tiltfile

HTTP Request

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

Parameters

  • name (in path): string, required

    name of the Tiltfile

  • pretty (in query): string

    pretty

Response

200 (Tiltfile): OK

list list or watch objects of kind Tiltfile

HTTP Request

GET /apis/tilt.dev/v1alpha1/tiltfiles

Parameters

Response

200 (TiltfileList): OK

create create a Tiltfile

HTTP Request

POST /apis/tilt.dev/v1alpha1/tiltfiles

Parameters

Response

200 (Tiltfile): OK

201 (Tiltfile): Created

202 (Tiltfile): Accepted

update replace the specified Tiltfile

HTTP Request

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

Parameters

  • name (in path): string, required

    name of the Tiltfile

  • body: Tiltfile, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • pretty (in query): string

    pretty

Response

200 (Tiltfile): OK

201 (Tiltfile): Created

update replace status of the specified Tiltfile

HTTP Request

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

Parameters

  • name (in path): string, required

    name of the Tiltfile

  • body: Tiltfile, required

  • dryRun (in query): string

    dryRun

  • fieldManager (in query): string

    fieldManager

  • pretty (in query): string

    pretty

Response

200 (Tiltfile): OK

201 (Tiltfile): Created

patch partially update the specified Tiltfile

HTTP Request

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

Parameters

  • name (in path): string, required

    name of the Tiltfile

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

patch partially update status of the specified Tiltfile

HTTP Request

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

Parameters

  • name (in path): string, required

    name of the Tiltfile

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

delete delete a Tiltfile

HTTP Request

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

Parameters

Response

200 (Status): OK

202 (Status): Accepted

deletecollection delete collection of Tiltfile

HTTP Request

DELETE /apis/tilt.dev/v1alpha1/tiltfiles

Parameters

Response

200 (Status): OK