Docker image for MyStorm development environment

ajlennon 2019-10-14 00:22:31 UTC #1

Hi all,

So I took the advice from @lawrie and @Folknology that helped me get going building for the BlackIce Mx / IceStorm examples and I put this into a Dockerfile which can be used to build a Docker container with (hopefully) all needed build dependencies.

This is archived here:

Building for Docker should be something like

$ docker build -t dynamicdevices/mystorm .

Running a container should be something like this. Note we're mapping the ACM9 device into the container.

$ docker run -t -i --device=/dev/ttyACM0 dynamicdevices/mystorm bash

That''ll get you a prompt inside the container.

Then for an example...

$ cd /usr/src/fpga/IceCore/Examples/blink
$ make upload

That works for me here with a BlackIce MX connected to the physical computer...

Or for SoC examples...

$ cd /usr/src/fpga/SaxonSoc/hardware/synthesis/blackicemx
$ cp makefile.sdram makefile
$ make generate
$ make prog

That works for me here too with a BlackIce MX connected to the physical computer...

Hopefully this helps people to have a "known good" environment to work within without too much faffing.

You can look at the individual steps in the Dockerfile here:

github.com

DynamicDevices/blackice-mx-container/blob/master/Dockerfile

#Download base image ubuntu 18.04
FROM ubuntu:18.04
 
# Update Software repository
RUN apt-get update

WORKDIR /usr/src/fpga

# Install and setup pre-requisites for IceCore Getting Started
# @see: https://github.com/folknology/IceCore/wiki/IceCore-Getting-Started

RUN DEBIAN_FRONTEND=noninteractive apt-get -y install build-essential clang bison flex libreadline-dev gawk tcl-dev \
    libffi-dev git mercurial graphviz xdot pkg-config python python3 libftdi-dev \
    qt5-default python3-dev libboost-all-dev cmake libeigen3-dev

# Downloading and installing IceStorm 
RUN git clone https://github.com/cliffordwolf/icestorm.git icestorm
RUN cd icestorm && make -j$(nproc) && make install

# Downloading and installing Arachne-pnr

This file has been truncated. show original

I'm in the middle of pushing my prebuilt image up to the Docker Hub so you can do a Docker pull on it.

It'll probably and up as dynamicdevices/mystorm somewhere in here

https://hub.docker.com/orgs/dynamicdevices/repositories

Hope this is of use.

Cheers,

Alex

Elminster 2019-10-14 08:53:19 UTC #2

Looks good. The only extra thing I ever do it make sure the container doesnt run as the root user, as in the past there were a few security issues where root in container gave you some unexpected root privs in the machien it was running it on. All fixed these days but i am paranoid.

ajlennon 2019-10-14 09:43:37 UTC #3

Great point. I hate that too. Was a bit surprised it defaulted to root like that. Will fix it up.

ajlennon 2019-10-14 09:46:22 UTC #4

The current image is pushed up here:

https://cloud.docker.com/u/dynamicdevices/repository/docker/dynamicdevices/mystorm

Elminster 2019-10-14 10:01:18 UTC #5

I have not had much docker time for last 12 months (been FPGA time) but if things havent changed I used to do it by doing some thing like.

ARG GOSU_VERSION=1.10

wget -O /usr/local/bin/gosu "https://github.com/tianon/gosu/releases/download/$GOSU_VERSION/gosu-$dpkgArch" \
        && chmod +x /usr/local/bin/gosu \

RUN useradd -ms /bin/bash <user>

in the dockerfile, where the wget is part of the apt-get pulling packages line

And in the entry point

exec gosu <put user here> "$1"

I probably missed something but gives you a starting point.

ajlennon 2019-10-14 13:48:44 UTC #6

OK so the latest image pushed up has a "build" user which is what you login as by default.