MongoDB Toolchain Installation

The MongoDB toolchain contains all the compilers and tools required to
build and test MongoDB. This document will get you up and running with
the toolchain.

Automatic Installation / Update

You can automatically install / update the correct toolchain by
downloading our installer script that automates the manual
installation.

$ curl -o toolchain_installer.sh http://mongodbtoolchain.build.10gen.cc/installer.sh

Once it is downloaded verify the contents of the script manually, it
does need sudo access if /opt/mongodbtoolchain does not exist on
your system and so it is prudent to make sure you got the script you
expected.

After verifying the contents you can execute the install with:

$ bash toolchain_installer.sh

Manual Installation

Manual installation of the toolchain is not recommended but the
toolchain common installer does not cover all cases so it may be
necessary at times. This section will walk you through this process.

Downloading the Toolchain

Click the link below that matches your platform to download the
appropriate toolchain.

If your platform is not listed you can construct a URL for any
platform we support by constructing a URL using the pattern:

http://mongodbtoolchain.build.10gen.cc/toolchain/$platform/$arch/latest
 Example for Ubuntu 16.04 x86_64
http://mongodbtoolchain.build.10gen.cc/toolchain/ubuntu1604/x86_64/latest

You can also download the toolchain with curl as below performing
the replacement as described above:

 example platform and arch combination for Ubuntu 18.04
$ platform=ubuntu1804; arch=x86_64
$ curl -L -o mongodbtoolchain.tar.gz -L http://mongodbtoolchain.build.10gen.cc/toolchain/$platform/$arch/latest

Installing the Toolchain

To install the MongoDB Toolchain you need to create the prerequisite
directories. You can do so with the following command:

$ mkdir -p /opt/mongodbtoolchain/revisions

Once you've downloaded the toolchain, retrieve the downloaded revision
from it and extract it with the following commands (assuming the local
tarball is named mongodbtoolchain.tar.gz):

$ REVISION=$(tar --list -f mongodbtoolchain.tar.gz | head -1 | sed 's/\/$//')
$ tar -C /opt/mongodbtoolchain/revisions -xzvf mongodbtoolchain.tar.gz $REVISION

Then you need to run the install script to setup the requisite symlinks. The
following commands runs the install script:

$ /opt/mongodbtoolchain/revisions/$REVISION/scripts/install.sh

This will create the appropriate symlinks so SCons can consume the toolchain. It
will create the directory structure as follows:

/opt/mongodbtoolchain
├── revisions
│   └── 94dac13bc8c0b50beff286acac77adeb2e81761e
├── v2
│   ├── bin
│   ├── cert.pem
│   ├── certs
│   ├── ct_log_list.cnf
│   ├── ct_log_list.cnf.dist
│   ├── include
│   ├── lib
│   ├── lib32
│   ├── lib64
│   ├── libexec
│   ├── misc
│   ├── openssl.cnf
│   ├── openssl.cnf.dist
│   ├── private
│   ├── share
│   └── x86_64-mongodb-linux
└── v3
    ├── bin
    ├── cert.pem
    ├── certs
    ├── ct_log_list.cnf
    ├── ct_log_list.cnf.dist
    ├── include
    ├── lib
    ├── lib32
    ├── lib64
    ├── libexec
    ├── misc
    ├── openssl.cnf
    ├── openssl.cnf.dist
    ├── private
    ├── share
    └── x86_64-mongodb-linux

A Note about using Toolchain Python

Starting with Toolchain version 3, we no longer pre-install the
Server's Python packages in the toolchain. It caused many confusing
dependency clashes whenever a team wanted a more up to date version of
a Python package as it would sometimes not install or conflict with
something already in the toolchain.

The reason this matters to most engineers at MongoDB is under these
newer toolchains when doing a pip install the binaries that pip
generates do not land in /opt/mongodbtoolchain/v3/bin and therefore
are not likely to be in the $PATH. Some buildscripts like
pylinters.py expect these Python tools to be found in the $PATH
and therefore fail when they cannot find these programs.

Ideally to solve this problem you can use a virtualenv. We have
instructions for how to work with MongoDB and
virtualenvs.

If you choose not to use virtualenvs and want to use the toolchain
Python as your primary Python, you will need to run the install script
from above after running any pip install. It will generate links in
/opt/mongodbtoolchain/v3/bin to the pip-installed programs. However,
modifying your toolchain installation this way is not recommended, as
you will lose all of your Python packages whenever doing an upgrade.