Skip to content

docker.md

Latest commit

 

History

History
104 lines (70 loc) · 3.43 KB

docker.md

File metadata and controls

104 lines (70 loc) · 3.43 KB
Raw

Docker

Run TAG using Docker Compose. For all configuration options, see the Configuration Reference.

Build-from-source vs. released image

Two sets of Compose files ship in this repo:

  • docker/docker-compose.yml / docker/docker-compose-cluster.yml — package a locally built binary into the image via the local Dockerfile. Use these for local development against source. The Dockerfile does not compile TAG; it copies a pre-built Linux binary from docker/bin/<arch>/tag (<arch> is amd64 or arm64), so you must stage that binary before building — see Building the local image below.
  • deploy/docker/docker-compose.release.yml / deploy/docker/docker-compose-cluster.release.yml — pull the published tigrisdata/tag image. Use these to run a released version without building anything, e.g. docker compose -f docker-compose.release.yml up -d.

The examples below use the build-from-source files in docker/. To run a released image instead, cd deploy/docker and pass the *.release.yml files with -f. The released-image files default to the latest published image; to pin a specific release, set TAG_VERSION (e.g. TAG_VERSION=v1.19.0) in your .env.

Building the local image

The docker/ Compose files expect a Linux binary staged at docker/bin/<arch>/tag. Build (or cross-compile) it first, then bring the stack up:

# From the repo root — produce a linux/amd64 binary and stage it for the build
mkdir -p docker/bin/amd64
GOOS=linux GOARCH=amd64 make build   # or: go build -o docker/bin/amd64/tag ./cmd/tag
cp tag docker/bin/amd64/tag           # if 'make build' wrote ./tag

cd docker
docker compose up -d

If you just want to run TAG without a local toolchain, use the released-image files under deploy/docker/ instead.

Prerequisites

Create a .env file in the directory of the Compose files you run (docker/ for build-from-source, deploy/docker/ for the released image) with your Tigris credentials:

AWS_ACCESS_KEY_ID=your_access_key
AWS_SECRET_ACCESS_KEY=your_secret_key

AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY are TAG's own Tigris credentials with read-only access to all buckets accessed through TAG (required). Clients use their own credentials directly.

Single Node

cd docker
docker compose up -d

TAG will be available at http://localhost:8080.

# View logs
docker compose logs -f tag

# Stop
docker compose down

Cluster Mode

Run 3 TAG nodes with an embedded distributed cache cluster:

cd docker
docker compose -f docker-compose-cluster.yml up -d

TAG endpoints:

  • http://localhost:8081 (tag-1)
  • http://localhost:8082 (tag-2)
  • http://localhost:8083 (tag-3)

Each node discovers the others via gossip and shares cached objects across the cluster.

# View logs
docker compose -f docker-compose-cluster.yml logs -f

# Stop and remove volumes
docker compose -f docker-compose-cluster.yml down -v

Environment Variables

You can add optional environment variables to the .env file:

AWS_ACCESS_KEY_ID=your_access_key
AWS_SECRET_ACCESS_KEY=your_secret_key
TAG_LOG_LEVEL=info

See the full Configuration Reference for all options.

Test

# Health check
curl http://localhost:8080/health

# Download an object using AWS CLI
aws s3 cp s3://your-bucket/your-key ./local-file \
  --endpoint-url http://localhost:8080