Build both CI and main images in one dockerfile. Updated README.md

dockerfiles/CI-Dockerfile

@@ -0,0 +1,43 @@
+### Note: This DockerFile is adapted from: https://github.com/CircleCI-Public/example-images/openjdk
+# This is a chipyard setup for CI, no toolchains are initialized
+
+FROM ubuntu:18.04
+ARG CHIPYARD_HASH
+
+MAINTAINER https://groups.google.com/forum/#!forum/chipyard
+
+# Install dependencies for ubuntu-req.sh
+RUN apt-get update && \
+    apt-get upgrade -y && \
+    apt-get install -y \
+               curl \
+               git \
+               sudo
+
+# Stopping docker keyboard-config from disrupting ubuntu-req.sh
+RUN sudo DEBIAN_FRONTEND=noninteractive apt-get install -y keyboard-configuration && \
+   sudo DEBIAN_FRONTEND=noninteractive apt-get install -y console-setup
+
+# Adds a new user called riscvuser
+RUN groupadd --gid 3434 riscvuser \
+    && useradd --uid 3434 --gid riscvuser --shell /bin/bash --create-home riscvuser \
+    && echo 'riscvuser ALL=NOPASSWD: ALL' >> /etc/sudoers.d/50-riscvuser \
+    && echo 'Defaults    env_keep += "DEBIAN_FRONTEND"' >> /etc/sudoers.d/env_keep
+
+WORKDIR /home/riscvuser
+USER riscvuser
+
+# Update PATH for RISCV toolchain (note: hardcoded for CircleCI)
+ENV RISCV="/home/riscvuser/riscv-tools-install"
+ENV LD_LIBRARY_PATH="$RISCV/lib"
+ENV PATH="$RISCV/bin:$PATH"
+
+# Install Chipyard and run ubuntu-req.sh to install necessary dependencies
+RUN git clone https://github.com/ucb-bar/chipyard.git && \
+        cd chipyard && \
+        git checkout $CHIPYARD_HASH && \
+        ./scripts/ubuntu-req.sh 1>/dev/null
+
+# END IMAGE CUSTOMIZATIONS
+
+CMD ["/bin/sh"]

dockerfiles/Dockerfile

@@ -0,0 +1,69 @@
+### Note: This DockerFile is adapted from https://github.com/ucb-bar/chipyard/blob/master/.circleci/images/Dockerfile which was adapted from: https://github.com/CircleCI-Public/example-images/openjdk
+# This is a full chipyard setup
+
+# BUILD BASE FOR CI
+
+FROM ubuntu:18.04 as base
+ARG CHIPYARD_HASH
+
+MAINTAINER https://groups.google.com/forum/#!forum/chipyard
+
+# Install dependencies for ubuntu-req.sh
+RUN apt-get update && \
+    apt-get upgrade -y && \
+    apt-get install -y \
+               curl \
+               git \
+               sudo
+
+# Stopping docker keyboard-config from disrupting ubuntu-req.sh
+RUN sudo DEBIAN_FRONTEND=noninteractive apt-get install -y keyboard-configuration && \
+   sudo DEBIAN_FRONTEND=noninteractive apt-get install -y console-setup
+
+# Adds a new user called riscvuser
+RUN groupadd --gid 3434 riscvuser \
+    && useradd --uid 3434 --gid riscvuser --shell /bin/bash --create-home riscvuser \
+    && echo 'riscvuser ALL=NOPASSWD: ALL' >> /etc/sudoers.d/50-riscvuser \
+    && echo 'Defaults    env_keep += "DEBIAN_FRONTEND"' >> /etc/sudoers.d/env_keep
+
+WORKDIR /home/riscvuser
+USER riscvuser
+
+# Update PATH for RISCV toolchain (note: hardcoded for CircleCI)
+ENV RISCV="/home/riscvuser/riscv-tools-install"
+ENV LD_LIBRARY_PATH="$RISCV/lib"
+ENV PATH="$RISCV/bin:$PATH"
+
+# Install Chipyard and run ubuntu-req.sh to install necessary dependencies
+RUN git clone https://github.com/ucb-bar/chipyard.git && \
+        cd chipyard && \
+        git checkout $CHIPYARD_HASH && \
+        ./scripts/ubuntu-req.sh 1>/dev/null
+
+
+# BUILD IMAGE WITH TOOLCHAINS
+
+# Use above build as base
+FROM base as base-with-tools
+
+# Init submodules
+RUN cd chipyard && \
+        export MAKEFLAGS=-"j $(nproc)" && \
+        ./scripts/init-submodules-no-riscv-tools.sh 1>/dev/null
+
+# Install riscv-tools
+RUN cd chipyard && \
+        export MAKEFLAGS=-"j $(nproc)" && \
+        ./scripts/build-toolchains.sh riscv-tools 1>/dev/null
+
+# Install esp-tools
+ RUN cd chipyard && \
+        export MAKEFLAGS=-"j $(nproc)" && \
+        ./scripts/build-toolchains.sh esp-tools 1>/dev/null
+
+# Run script to set environment variables on entry
+ENTRYPOINT ["chipyard/scripts/entrypoint.sh"]
+
+# END IMAGE CUSTOMIZATIONS
+
+CMD ["/bin/sh"]

dockerfiles/README.md

@@ -0,0 +1,20 @@
+General
+-------
+This DockerFile contains the necessary steps to build a Docker container that can run
+projects with riscv-tools, chisel3, firrtl, and verilator. When run up to the base stage, it installs the necessary
+apt-get packages and sets the environment variables needed in CircleCI. When run up to the base-with-tools stage, it initializes and installs the necessary toolchains for running simulations and testing projects.
+
+Build and Deploy the Container
+------------------------------
+
+    sudo docker build --target base -f Dockerfile . # to build the image for the CI
+    sudo docker build --target base-with-tools -f Dockerfile . # to build the full image
+    sudo docker tag <IMAGE_ID> <PATH_NAME>:tag . # to tag the image after the build (ex. 0.0.3)
+    sudo docker login # login into the account to push to
+    sudo docker push <PATH_NAME>:tag # to push to repo with tag
+    sudo docker run -it <IMAGE_ID> bash # to run an interactive version of the container
+
+Path Names
+----------
+Older docker images (when this Dockerfile was in `riscv-boom/riscv-boom`) can be found in the <PATH_NAME> `riscvboom/riscvboom-images`.
+Current up-to-date images are located in <PATH_NAME> `ucbbar/chipyard-image`