Building Traffic Control

The build steps for Traffic Control components are all pretty much the same, despite that they are written in a variety of different languages and frameworks. This is accomplished by using Docker.


Currently, both listed methods of building Traffic Control components will produce *.rpm files, meaning that the support of these components is limited to RedHat-based distributions - and none of them are currently tested (or guaranteed to work) outside of Rocky Linux 8 and CentOS 7, specifically.

Downloading Traffic Control

If any local work on Traffic Monitor, Traffic Router Golang, Grove or Traffic Ops is to be done, it is highly recommended that the Traffic Control repository be downloaded inside the $GOPATH directory. Specifically, the best location is $GOPATH/src/ Cloning the repository outside of this location will require either linking the actual directory to that point, or moving/copying it there.

See also

The Golang project’s GOPATH wiki page

Build Using pkg

This is the easiest way to build all the components of Traffic Control; all requirements are automatically loaded into the image used to build each component. The pkg command can be found at the root of the Traffic Control repository.



./pkg [options] [projects]



Build RPMs targeting CentOS 7.

Changed in version ATCv6.0.0: Previously, -7 was implicit if not given. As of ATC version 6.0.0, this is no longer the case, and -8 is implicit instead.


Build RPMs targeting Rocky Linux 8 (default).

Changed in version ATCv6.0.0: Previously, -7 was implicit if not given. As of ATC version 6.0.0, this is no longer the case, and -8 is implicit instead.


Build all projects, including optional ones.


Build builder Docker images before building projects.


Disable compiler optimizations for debugging.


Use FILE instead of the default Docker-Compose file (./infrastructure/docker/build/docker-compose.yml).


Print help message and exit.

New in version ATCv6.1.0.


List available projects.


This lists only the projects that are built by default if none are specified, not all projects that can be built. See Issue #6272.


Don’t write logs to files - respects output levels on STDERR/STDOUT as set by -q/-v.


Build from the optional list. Same as passing -f with the option-argument ./infrastructure/docker/build/docker-compose-opt.yml.


Pull builder Docker images, do not build them (default).


Quiet mode. Suppresses output (default).


Simple output filenames - e.g. traffic_ops.rpm instead of traffic_ops-6.1.0-11637.ec9ff6a6.el8.x86_64.rpm.

New in version ATCv6.1.0.


Skip building “source RPMs”.

New in version ATCv6.1.0.


Verbose mode. Lists all build output.

New in version ATCv6.1.0.

If present, projects should be one or more project names. When no specific project or project list is given the default projects will be built. Valid projects:

  • ats[2]

  • docs[3]

  • fakeorigin_build[2]

  • grove_build[3]

  • grovetccfg_build[3]

  • source[3]

  • traffic_monitor_build[3]

  • traffic_ops_build[3]

  • cache-config_build[3]

  • traffic_portal_build[3]

  • traffic_router_build[3]

  • traffic_stats_build[3]

  • weasel[3]

Output component-version.rpm files, build logs and source tarballs will be output to the dist/ directory at the root of the Traffic Control repository directory.

Build Using docker-compose

If the pkg script fails, docker-compose can still be used to build the projects directly. The compose file can be found at infrastructure/docker/build/docker-compose.yml under the repository’s root directory. It can be passed directly to docker-compose, either from the infrastructure/docker/build/ directory or by explicitly passing a path to the infrastructure/docker/build/docker-compose.yml file via -f. It is recommended that between builds docker-compose down -v is run to prevent caching of old build steps. The service names are the same as the project names described above in Usage, and similar to the pkg script, the build results, logs and source tarballs may all be found in the dist directory after completion.


Calling docker-compose in the way described above will build _all_ projects, not just the default projects.

Build the RPMs Natively

A developer may end up building the RPMs several times to test or debug code changes, so it can be desirable to build the RPMs quickly for this purpose. Natively building the RPMs has the lowest build time of any building method.

Install the Dependencies

Table 76 Build dependencies for Traffic Control

OS/Package Manager

Common dependencies

Traffic Monitor

Traffic Ops

Traffic Portal

Traffic Router

Traffic Stats


Grove TC Config (grovetccfg)


macOS[4] (homebrew)

  • rpm

  • go

  • go

  • npm

  • grunt-cli

  • maven

  • go

  • go

  • go

  • python3

RockyLinux[5], Red Hat, Fedora, CentOS (yum)

  • git

  • rpm-build

  • rsync

  • epel-release

  • npm

  • nodejs-grunt-cli

  • java-11-openjdk

  • maven

  • python3-devel

  • gcc

  • make

Arch Linux, Manjaro (pacman)

  • git

  • rpm-tools

  • diff

  • go

  • go

  • npm

  • grunt-cli

  • jdk11-openjdk

  • maven

  • go

  • go

  • go

  • python-pip

  • python-sphinx

  • make

Windows (cygwin)[6]

  • git

  • rpm-build

  • rsync

  • curl

Windows (chocolatey)[6]

  • golang

  • golang

  • nodejs

  • openjdk11

  • maven

  • golang

  • golang

  • golang

  • python

  • pip

  • make

After installing the packages using your platform’s package manager,

Run build/ directly

In a terminal, navigate to the root directory of the repository. You can run build/ with no arguments to build all components.

#92 build/ with no arguments

This is the equivalent of running

#93 build/ with all components
build/ tarball traffic_monitor traffic_ops traffic_portal traffic_router traffic_stats grove grove/grovetccfg docs

If any component fails to build, no further component builds will be attempted.

By default, the RPMs will be built targeting Rocky Linux 8. CentOS 7 is also a supported build target. You can choose which RHEL version to build for (8, 7, etc.) by setting the RHEL_VERSION environment variable:

#94 Building RPMs that target CentOS 7 without the build host needing to be CentOS 7


Although there are no known issues with natively-built RPMs, the official, supported method of building the RPMs is by using pkg or docker-compose. Use natively-built RPMs at your own risk.

Building Individual Components

Each Traffic Control component can be individually built, and the instructions for doing so may be found in their respective component’s development documentation.

Building This Documentation

See instructions for building the documentation.