This directory contains a basic build system for creating docker images of the _referenceOS_ on which NGraph-Cpp builds and unit tests are run. The purpose is to provide reference builds for _Continuous Integration_ used in developing and testing NGraph-Cpp.
This directory contains a basic build system for creating docker images of the _reference-OS_ on which NGraph-Cpp builds and unit tests are run. The purpose is to provide reference builds for _Continuous Integration_ used in developing and testing NGraph-Cpp.
The `Makefile` provides targets for:
* Building the reference OS into a docker image
* Building NGraph-Cpp and running unit tests in this cloned repo, mounted into the docker image of the reference OS
* Starting a shell in the _reference OS_ docker image, with the cloned repo available for manual builds and unit testing
* Building the _reference-OS_ into a docker image
* Building NGraph-Cpp and running unit tests in this cloned repo, mounted into the docker image of the _reference-OS_
* Starting an interactive shell in the _reference-OS_ docker image, with the cloned repo available for manual builds and unit testing
The _make targets_ are designed to handle all aspects of building the _reference-OS_ docker image, running NGraph-Cpp builds and unit testing in it, and opening up a session in the docker image for interactive use. You should not need to issue any manual commands (unless you want to). In addition the `Dockerfile.ngraph_cpp_cpu` provides a description of how the _reference-OS_ is built, should you want to build your own server or docker image.
## Prerequisites
In order to use the make targets, you will need to do the following:
* Have docker installed on your computer with the docker daemon running
*If your computer (running docker) sits behind a firewall, you will need to have the docker daemon properly configured to use proxies to get through the firewall, so that public docker registries and git repositories can be accessed
*You should _not_ run `make check_cpu` from a directory in an NFS filesystem, if that NFS filesystem uses _root squash_ (see **Notes** section below)
- Instead, run `make check_cpu` from a cloned repo in a local filesystem
* Have docker installed on your computer with the docker daemon running.
*These scripts assume that you are able to run the `docker` command without using `sudo`. You will need to add your account to the `docker` group so this is possible.
*If your computer (running docker) sits behind a firewall, you will need to have the docker daemon properly configured to use proxies to get through the firewall, so that public docker registries and git repositories can be accessed.
* You should _not_ run `make check_cpu` from a directory in an NFS filesystem, if that NFS filesystem uses _root squash_ (see **Notes** section below). Instead, run `make check_cpu` from a cloned repo in a local filesystem.
## Make Targets
The following targets allow you to perform basic operations for building the _reference OS_ docker image, building NGraph-Cpp, running unit tests, and starting a shell in the _reference OS_ docker image.
The _make targets_ are designed to provide easy commands to run actions using the docker image. All _make targets_ should be issued on the host OS, and _not_ in a docker image.
* In general, you simply need to run the command **`make check_cpu`**. This first makes the `build_ngraph_cpp_cpu` target as a dependency. Then it makes the `check_cpu` target, which will build NGraph-Cpp and run unit testing. Please keep in mind that `make check_cpu` does not work when your working directory is in an NFS filesystem that uses `root squash` (see **Notes** section below).
* You can also run the command **`make shell`** to start an interactive bash shell inside the docker image. While this is not required for normal builds and unit testing, it allows you to run interactively within the docker image with the cloned repo mounted. Again, `build_ngraph_cpp_cpu` is made first as a dependency. Please keep in mind that `make shell` does not work when your working directory is in an NFS filesystem that uses `root squash` (see **Notes** section below).
* Running the command **`make build_ngraph_cpp_cpu`** is also available, if you simply want to build the docker image. This target does work properly when your working directory is in an NFS filesystem.
Note that all operations performed inside the the docker image are run as **root**. This has unfornate side effects if you run a make target that does operations inside the docker image, while your working directory is in an NFS filesystem that uses _root squash_ (see **Notes** below).
The available _make targets_ are:
### `make build_ngraph_cpp_cpu`
#### `make build_ngraph_cpp_cpu`
Build a docker image of the _reference OS_ used to build NGraph-Cpp and run unit tests
Build a docker image of the _reference-OS_ used to build NGraph-Cpp and run unit tests.
### `make check_cpu`
#### `make check_cpu`
Build NGraph-Cpp in the _reference OS_ docker image. The results are built in this cloned repo by mounting it into the docker image. This target will set up a cmake BUILD directory and the top level of the cloned repo, run cmake and make, and finally run unit tests in the docker image.
Build NGraph-Cpp in the _reference-OS_ docker image. The results are built in the cloned repo by mounting it into the docker image. This target will set up a cmake BUILD directory at the top level of the cloned repo, run _cmake_ and _make_ in it, and finally run unit tests - all while in the docker image.
### `make shell`
#### `make shell`
This target will start a bash shell in the _reference OS_ docker image, with a mount to the cloned repo available in the docker image.
This target will start an interactive bash shell in the _reference-OS_ docker image, with a mount to the cloned repo available in the docker image.
## Helper Scripts
These helper scripts are included for use in the `Makefile` and Jenkins jobs. **Generally, these scripts should _not_ be called directly.**
These helper scripts are included for use in the `Makefile` and automated (Jenkins) jobs. **These scripts should _not_ be called directly unless you understand what they do.**
### `chown_files.sh`
...
...
@@ -45,15 +57,15 @@ Used in the `Makefile` to change the ownership of files while running _inside th
### `docker_cleanup.sh`
A helper script for Jenkins jobs to clean up old docker images.
A helper script for Jenkins jobs to clean up old exited docker containers and `ngraph_*`docker images.
## Notes
* The top-level `Makefile` in this cloned repo can be used outside of docker. This directory is only for building and running unit tests for NGraph-Cpp in the _reference OS_ docker image.
* The top-level `Makefile` in this cloned repo can be used to build and unit-test NGraph-Cpp _outside_ of docker. This directory is only for building and running unit tests for NGraph-Cpp in the _reference-OS_ docker image.
* The `_cpu`in the targets refers to the docker image being built such that testing is in a _cpu-only_ environment. Later, _gpu_ and other environments may be added. This convention was chosen to stay consistent with the _NervanaSystems ngraph_ project on Github.
* The `_cpu`suffix in the targets refers to the docker image being built such that testing is in a _cpu-only_ environment. At a later date, _gpu_ and other environments may be added. This convention was chosen to stay consistent with the _NervanaSystems ngraph_ project on Github.
* Due to limitations in how docker mounts work, `make check_cpu` will fail
if you try to run it from an NFS-mounted directory which has _root squash_ enabled. The cause results from the process in the docker container running as root. When a file or directory is created by root in the mounted directory tree, from within the container, the NFS-mount (in the host OS) does not allow a root-created file, leading to a permissions error. This is dependent on whether the host OS performs "root squash" when mounting NFS filesystems. The fix to this is easy: run `make check_cpu` from a local filesystem.
* Due to limitations in how docker mounts work, `make check_cpu`and `make shell`will fail
if you try to run them while in a working directory that is in an NFS-mount that has _root squash_ enabled. The cause results from the process in the docker container running as root. When a file or directory is created by root in the mounted directory tree, from within the docker image, the NFS-mount (in the host OS) does not allow a root-created file, leading to a permissions error. This is dependent on whether the host OS performs "root squash" when mounting NFS filesystems. The fix to this is easy: run `make check_cpu` and `make shell` from a local filesystem.
* These make targets have been tested on Ubuntu 14.04 and Ubuntu 16.04 with docker installed and the docker daemon properly configured. Some adjustments may be needed to run these on other OSes.
