website: Added notes on using Docker to build and run
In the Building documentation, a section has been added outlining how a
Docker image may be obtained, and used, to run gem5.
Change-Id: Ic9ff026e47e21bb0aa1e11a32fc3df753affb991
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5-website/+/28867
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Maintainer: Jason Lowe-Power <power.jg@gmail.com>
Tested-by: Jason Lowe-Power <power.jg@gmail.com>
diff --git a/_pages/documentation/general_docs/building/index.md b/_pages/documentation/general_docs/building/index.md
index adbde07..d172338 100644
--- a/_pages/documentation/general_docs/building/index.md
+++ b/_pages/documentation/general_docs/building/index.md
@@ -32,6 +32,8 @@
libraries. It is a necessary dependency if you wish to use the SystemC
implementation.
+### Setup on Ubuntu
+
If compiling gem5 on Debian, Ubuntu, or related Linux distributions, you may
install all these dependencies using APT:
@@ -41,6 +43,44 @@
python-dev python libboost-all-dev
```
+### Docker
+
+For users struggling to setup an environment to build and run gem5, we provide
+the following Docker Images:
+
+Ubuntu 18.04 with all optional dependencies:
+[gcr.io/gem5-test/ubuntu-18.04_all-dependencies](
+https://gcr.io/gem5-test/ubuntu-18.04_all-dependencies).
+
+Ubuntu 18.04 with the minimum set of dependencies:
+[gcr.io/gem5-test/ubuntu-18.04_min-dependencies](
+https://gcr.io/gem5-test/ubuntu-18.04_min-dependencies).
+
+To obtain a docker image:
+
+```
+docker pull <image>
+```
+
+E.g., for Ubuntu 18.04 with all optional dependencies:
+
+```
+docker pull gcr.io/gem5-test/ubuntu-18.04_all-dependencies
+```
+
+Then, to work within this enviornment, we suggest using the following:
+
+```
+docker run -u $UID:$GID --volume <gem5 directory>:/gem5 --rm -it <image>
+```
+
+Where `<gem5 directory>` is the full path of the gem5 in your file system, and
+`<image>` is the image pulled (e.g.,
+`gcr.io/gem5-test/ubuntu-18.04_all-dependencies`).
+
+From this environment, you will be able to build and run gem5 from the `/gem5`
+directory.
+
## Getting the code
```
