Skip to content

Latest commit

 

History

History
113 lines (77 loc) · 5.03 KB

setup.md

File metadata and controls

113 lines (77 loc) · 5.03 KB
Raw

Build and Install

Here're the steps to get Genny up and running locally:

  1. Install the development tools for your OS.

    • Ubuntu 18.04: sudo apt install build-essential
    • Red Hat/CentOS 7/Amazon Linux 2: sudo yum groupinstall "Development Tools"
    • Arch: apk add bash clang gcc musl-dev linux-headers
    • macOS: xcode-select --install
    • Windows: https://visualstudio.microsoft.com/

  2. Make sure you have a C++17 compatible compiler and Python 3.7 or newer. The ones from mongodbtoolchain v3 are safe bets if you're unsure. (mongodbtoolchain is internal to MongoDB).

  3. Make sure you have libmongocrypt installed

  4. ./run-genny install [--linux-distro ubuntu1804/rhel7/amazon2/arch]

    This command downloads Genny's toolchain, compiles Genny, creates its virtualenv, and installs Genny to dist/. You can rerun this command at any time to rebuild Genny. If your OS isn't the supported, please let us know in #workload-generation slack or on GitHub.

    Note that the --linux-distro argument is not needed on macOS.

    You can also specify --build-system make if you prefer to build using make rather than ninja. Building using make may make some IDEs happier.

    If you get python errors, ensure you have a modern version of python3. On a Mac, run brew install python3 (assuming you have homebrew installed) and then restart your shell.

Errors Mentioning zstd and libmongocrypt

There is currently a leak in Genny's toolchain requiring zstd and libmongocrypt to be installed. If the ./run-genny install phase above errors mentioning these, you may need to install them separately.

On macOS, you can brew install zstd and brew install mongodb/brew/libmongocrypt. On Ubuntu, you can apt-install zstd, but will need to manually install libmongocrypt using the instructions in its source repo. If choosing to build from source, make sure you run make install to install globally after cmaking the project.

After installing these dependencies, re-running the ./run-genny install phase above should work.

macOS Unable to get local issuer certificate

If you are on macOS and you see python errors such as when trying ./run-genny install that contain ssl.SSLCertVerificationError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate this is likely a problem with the python requests library. Here is a StackOverflow answer which addresses the problem.

IDEs and Whatnot

We follow CMake and C++17 best-practices, so anything that doesn't work via "normal means" is probably a bug.

We support using CLion and any conventional editors or IDEs (VSCode, emacs, vim, etc.). Before doing anything cute (see CONTRIBUTING.md), please do due-diligence to ensure it's not going to make common editing environments go wonky.

If you're using CLion, make sure to set CMake options (in settings/preferences) so it can find the toolchain.

The cmake command is printed when run-genny install runs, you can copy and paste the options into Clion. The options should look something like this:

-G some-build-system \
-DCMAKE_PREFIX_PATH=/data/mci/gennytoolchain/installed/x64-osx-shared \
-DCMAKE_TOOLCHAIN_FILE=/data/mci/gennytoolchain/scripts/buildsystems/vcpkg.cmake \
-DVCPKG_TARGET_TRIPLET=x64-osx-static

See the following images:

CLion ToolChain Settings

toolchain

CLion CMake Settings

CMake

If you run ./run-genny install -b make it should set up everything for you. You just need to set the "Generation Path" to your build directory.

Automatically Running Poplar before genny_core launch in CLion

Create a file called poplar.sh with the following contents:

#!/bin/bash
pkill -9 curator # Be careful if there are more curator processes that should be kept. 
DATE_SUFFIX=$(date +%s)
mv  build/CedarMetrics  build/CedarMetrics-${DATE_SUFFIX} 2>/dev/null
mv build/WorkloadOutput-${DATE_SUFFIX} 2>/dev/null

# curator is installed by cmake.
build/curator/curator poplar grpc &

sleep 1

Next create an external tool for poplar in CLion:

poplar

Note: the Working directory value is required.

Finally the external poplar tool to the CLion 'Before Launch' list:

Debug