Evergreen is a distributed continuous integration system built by MongoDB. It dynamically allocates hosts (via AWS, GCP, etc) to run tasks in parallel across many machines at once to decrease the total amount of time needed to complete a test workload.
Using Evergreen, we've significantly enhanced the productivity of our engineers.
Elastic Host Allocation
Use only the computing resources you need.
Easily navigate the state of your tests, logs, and commit history.
Run jobs on Linux (including PowerPC and ZSeries), Windows, OSX, Solaris, and BSD.
Spin up a copy of any machine in your test infrastructure for debugging.
See test results for your code changes before committing.
Stepback on Failure
Automatically run past commits to pinpoint the origin of a test failure
See the documentation for a full feature list!
Evergreen requires the configuration of a main server along with a cloud provider or static servers. Please refer to our tutorial for full installation instructions.
The Evergreen Agent and Command Line Tool are supported on Linux, OSX, Windows, and Solaris operating systems. However, the Evergreen API Server, UI Server, and Runner program are currently only supported and tested on Linux and OSX.
Our dependencies live in the
vendor subdirectory of the repo, and
are managed using glide. To
add a new dependency, add the package to
glide.yaml and the package
name and revision to
glide.lock, and run
glide install -s. To
refresh the entire
vendor tree, run
Building the Binaries
- ensure that your
GOPATHenvironment variable is set.
- check out a copy of the repo into your gopath. You can use:
go get github.com/evergreen-ci/evergreen. If you have an existing checkout of the evergreen repository that is not in
$GOPATH/src/github.com/evergreen-ci/move or create a symlink.
make vendorto set up the vendoring environment.
make buildto compile all server binaries for your local system.
make agent clito compile the agent and cli for your local platform.
make agents clisto compile and cross compile all agent and command line interface binaries.
make distto compile all server, commandline, and agent binaries and create a dist tarball with all artifacts.
distro: A platform type (e.g. Windows or OSX) plus large-scale architectural details. One of the targets that we produce executables for.
host: One of the machines used to run tasks on; typically an instance of a distro that does the actual work (see
task). Equivalently, any machine in our system other than MOTU.
revision: A revision SHA; e.g. ad8a1d4678122bada9d4479b114cf68d39c27724.
project: A branch in a given repository. e.g. master in the mongodb/mongo repository
revision). A version of a
buildvariant) = (
task: “compile”, “test”, or “push”. The kinds of things that we want to do on a
Running Evergreen Processes
A single configuration file drives most of how Evergreen works. Each Evergreen process must be supplied this settings file to run properly. For development, tweak the sample configuration file here.
All Evergreen programs accept a configuration file with the
How It Works
- A MongoDB server must be already running on the port specified in the configuration file.
- Both the API and UI server processes are started manually and listen for connections.
- All other processes are run by the runner process.
- For detailed instructions, please see the wiki.