LinuxCommandLibrary

concourse

TLDR

Start a quickstart all-in-one Concourse instance

$ concourse quickstart --add-local-user [admin]:[password] --main-team-local-user [admin]
copy
Start the web node with PostgreSQL
$ concourse web --postgres-host [localhost] --postgres-user [concourse] --postgres-password [password]
copy
Start a worker node
$ concourse worker --work-dir [/var/lib/concourse/worker] --tsa-host [127.0.0.1:2222]
copy
Generate encryption keys for secure communication
$ concourse generate-key -t rsa -f [/path/to/session_signing_key]
copy
Run database migrations
$ concourse migrate --postgres-host [localhost] --postgres-user [concourse]
copy
Retire a worker gracefully
$ concourse retire-worker --name [worker-name]
copy
Display help for a command
$ concourse [web|worker|quickstart] --help
copy

SYNOPSIS

concourse COMMAND [OPTIONS]

DESCRIPTION

Concourse is a container-based continuous integration system. The concourse CLI is used to run and manage Concourse server components including the web node (ATC for scheduling, TSA for worker registration) and worker nodes (for running pipeline tasks).
All configuration is defined via flags or environment variables. Each flag has a corresponding env var with the format CONCOURSE_FLAG_NAME (uppercase, underscores instead of dashes).
For typical usage, the quickstart command provides an all-in-one setup suitable for development. Production deployments typically run separate web and worker processes, often on different machines.
Users interact with Concourse through the fly CLI, not the concourse command directly.

PARAMETERS

--add-local-user USER:PASSWORD

Add a local user for authentication.
--main-team-local-user USER
Grant main team access to a local user.
--postgres-host HOST
PostgreSQL server hostname.
--postgres-user USER
PostgreSQL username.
--postgres-password PASSWORD
PostgreSQL password.
--external-url URL
Externally reachable URL of the Concourse web UI.
--work-dir PATH
Directory for worker to store container data.
--tsa-host HOST:PORT
TSA host for worker registration (default: 127.0.0.1:2222).
--runtime RUNTIME
Container runtime to use (guardian or containerd).
--help
Display help for the command.

COMMANDS

quickstart

Start an all-in-one Concourse instance with web and worker components.
web
Start the Concourse web node (ATC/TSA).
worker
Start a Concourse worker node.
migrate
Run database migrations.
generate-key
Generate encryption keys for Concourse components.
land-worker
Safely drain and stop a worker.
retire-worker
Remove a worker from the cluster.

CAVEATS

The quickstart command is intended for development and testing, not production. Production deployments require separate web and worker nodes with proper security configuration including TLS certificates and key management. Worker nodes need sufficient disk space and container runtime permissions.

HISTORY

Concourse was created at Pivotal (now VMware Tanzu) and first released in 2014. It was designed as a "pipeline-based" CI/CD system where everything is configured as code. Unlike traditional CI systems, Concourse has no plugins—all functionality comes from resources (versioned artifacts) and tasks (scripts in containers). The project was open-sourced and continues active development on GitHub.

SEE ALSO

fly(1), docker(1), podman(1), jenkins(1)

Copied to clipboard