Skip to main content

TARE CLI

tare (Tetrate Agent Router) is a single-command operator tool for deploying the TARS dataplane. It collapses three manual steps (image sync, pull-secret creation, and Helm deployment) into one invocation.


Commands

CommandDescription
tare installInstall the TARS dataplane
tare uninstallTear down the TARS dataplane (cluster-only; reverses install)
tare upgradeUpgrade an existing TARS dataplane release (HA-safe, atomic)
tare gateway installInstall serve gateway resources (GCP)
tare gateway config initGenerate a starter gcp-gateway.json from a domain + project ID
tare gateway config lintLint a gcp-gateway.json config (hermetic, CI-safe)
tare mcp installDeploy MCP server pods on a customer cluster
tare mcp listShow deployed MCP server status
tare mcp enableRegister a deployed MCP server in fraser's catalog
tare mcp uninstallRemove the tars-mcp Helm release

Quick start

# Print Helm values without touching the cluster
tare install identity.json --serve-url https://proxy.acme.com --print-helm-values

# Full install
tare install identity.json --serve-url https://proxy.acme.com

# Sync images to a private registry then install
tare install identity.json --serve-url https://proxy.acme.com \
--image-sync myregistry.example.com

# Sync + create pull secret + install in one command
echo "user:password" | tare install identity.json \
--serve-url https://proxy.acme.com \
--image-sync myregistry.example.com \
--image-pull-secret-stdin

Identity file

tare accepts the service-account file in both formats produced by the management plane:

Wrapped format (standard):

{
"serviceAccount": { ... },
"checksum": "664b355c...",
"checksumAlgorithm": "sha256"
}

Naked format (direct service account JSON):

{
"type": "service_account",
"clientEmail": "[email protected]",
...
}

Use tars sa wrap to convert a naked file to the wrapped format.

Gateway config schema

For tare gateway install, the config file shape depends on the provider:

Version

tare --version

CLI reference docs

The docs/tare/cli/ref/ directory contains auto-generated per-command reference files derived directly from each command's --help output.

Regenerate after any flag or help-text change:

make cli.docs

CI verifies the directory is up to date on every PR:

make cli.docs && git diff --exit-code docs/tare/cli/ref/

make cli.docs depends on cli.embed-charts and cli.manifest (both run automatically as prerequisites). The generator binary lives at svc/cli/cmd/tare-docgen.