tarfetch

Tarfetch

This extension leverages kubectl exec and tar to archive files in a Kubernetes container and then extract them to a destination on the local filesystem.

Overview

Tarfetch provides a local resource method (tarfetch) to perform manually triggered reverse file synchronization (i.e. from pod container to local filesystem).

Tarfetch resources can be triggered manually either via the Tilt Web UI, or via CLI using tilt trigger <resource name>.

Usage

Tarfetch's only requirement is that both the local machine and container have tar installed. This is typically a given (yes, even on Windows).

Import Tarfetch with the following in your Tiltfile:

load('ext://tarfetch', 'tarfetch')

A tarfetch resource can be created with the following parameters:

Required parameters:

• name (str): a name for the local resource
• k8s_object (str): a Kubernetes object identifier (e.g. deploy/my-deploy, job/my-job, or a pod ID) that Tilt can use to select a pod. As per the behavior of kubectl exec, we will act on the first pod of the specified object, using the first container by default
• src_dir (str): directory in the remote container to sync from. Any paths, if specified, should be relative to this dir. This path must be a directory and must contain a trailing slash (e.g. /app/ is acceptable; /app is not)

Optional parameters:

• target_dir (str, optional): directory on the local filesystem to sync to. Defaults to '.'
• namespace (str, optiona): namespace of the desired k8s_object, if not default.
• container (str, optional): name of the container to sync from (by default, the first container)
• ignore (List[str], optional): patterns to ignore when syncing, see tar --exclude documentation for details on supported patterns.
• keep_newer (bool, optional): prevents files overwrites when the destination file is newer. Default is true.
• verbose (bool, optional): if true, shows tar extract activity.
• labels (Union[str, List[str]], optional): used to group resources in the Web UI.

Example invocation

Create a local resource called "tarfetch-app" which connects to the first pod of "deploy/frontend" (and the default container) and syncs the contents of "/app/" to local directory "./frontend" while ignoring all directories named "node_modules":

tarfetch(
   'tarfetch-app', 
   'deployments/frontend',
   '/app/',
   './frontend',
   ignore=["node_modules"]
)