Docker images for OpenRAM

Installing Docker

There are a number of ways to install Docker. Pick your favorite.

• On Mac from docker.com with .app: https://docs.docker.com/docker-for-mac/install/

• On Windows from docker.com: https://docs.docker.com/docker-for-windows/install/

• On Ubuntu: https://docs.docker.com/install/linux/docker-ce/ubuntu/

NOTE: If you plan to use a VPN, do NOT use the Docker Toolbox for Mac or the docker from Macports as these require a network socket that breaks when you install some VPN software. To understand the difference, check out this page.

Running Docker

Terminal only

• To run, mount your home directory, mount proprietary CAD tools installed in $HOME/bsoe/software:

 docker run -it -e LOCAL_USER=$USER -e LOCAL_HOME=$HOME -v $HOME:${HOME} -v $HOME/bsoe/software:/software vlsida/openram-ubuntu:latest

This is available in the script run-openram-ubuntu.sh. Remove the -v software option to not mount that.

• To run as a generic user (with no saved home directory):

 docker run -it vlsida/openram-ubuntu:latest

With X11 Graphics

On Mac

1. Download and install XQuartz
2. Enable "Allow connections from network clients" in the Preferences...Security menu.
3. Restart XQuartz for settings to take effect.
4. An example startup script is run-openram-ubuntu-osx-x11.sh.

On PC

1. Download and install VcXsrv
2. Start VcXsrv with the "Disable access control" option checked
3. Optionally save the configuration for later use.
4. An example powershell startup script is run-openram-ubuntu.ps1.

Updating the image

If there are updates to the image, you can pull a new one from the hub with:

docker pull vlsida/openram-ubuntu:latest

This is not automatically done, so if you have a problem, make sure you are up-to-date.

Building your own image

You can run the build script to build a local image:

./build.sh

If you want to change things, modify the openram-ubuntu/Dockerfile and let me know what should be fixed.

Licenses

If you need licenses, you must set up the campus Cisco Anyconnect VPN on your host computer (i.e. laptop, not the docker image) to campus:

https://its.ucsc.edu/vpn/installation.html

One option that works quite well is to use OpenConnect, the open source alternative to Cisco Anyconnect. You can run this with:

openconnect vpn.ucsc.edu -u [cruzid]

Double check that you are NOT using the Docker Toolbox. If any environment variables are set when you run

env | grep DOCKER

then you are and your VPN may break the connection to the docker VM.