Pulled up common embedded recipes to public repo

Author: klutz

Dockerfile

@@ -0,0 +1,61 @@
+# For a detailed description and guide on how best to use this Docker
+# image, please look at the README.  Note that this image is set up to
+# pull many of its requirements from an S3 bucket rather than the
+# public internet. Unless you want to build this Docker image
+# yourself, we'd recommend just using as-is with a docker pull.
+
+# The image extends from the 13coders/cpp17-base image (always an
+# identified version, never latest...), which contains GCC6 and Clang
+# (both for amd64) and additional tooling that helps in CI builds. The
+# purpose of this image is to add dependencies and tools that are
+# common to developing for ARM Cortex-M platforms.
+
+FROM 13coders/cpp17-base:1.1
+MAINTAINER Mike Ritchie <mike@13coders.com>
+LABEL description="Docker image for C++ dual-target ARM Cortex-M development"
+
+# These environment variables for the AWS command line need to be
+# passed to the docker build command. This is preferable to persisting
+# credentials in the Docker image. Note that these credentials will be
+# visible in your (host) shell history, so clear them down. Also use
+# an IAM role in AWS with highly constrained privileges - potentially
+# read-only access to the single S3 bucket containing the
+# dependencies.
+
+ARG AWS_ACCESS_KEY_ID
+ARG AWS_SECRET_ACCESS_KEY
+ARG AWS_DEFAULT_REGION
+ARG AWS_BUCKET
+
+# Additional configuration has to take place using root user.
+
+USER root
+
+# USB utilities are essential for diagnosing issues connecting to
+# embedded hardware over USB from the Docker container.
+
+RUN apt-get install -y usbutils
+
+# We add Jenkins to the plugdev group to allow access to USB
+# devices. This will still require that (preferably) a device is
+# mapped in to the run command with --device, or (less ideal) that the
+# container is run as --privileged
+
+RUN adduser jenkins plugdev
+
+# Version of GCC ARM Embedded that we need to fetch from S3 bucket.
+
+ARG v_gcc_arm=gcc-arm-none-eabi-7-2017-q4-major-linux.tar.bz2
+
+RUN aws s3 cp s3://${AWS_BUCKET}/${v_gcc_arm} .
+RUN mkdir -p /opt/tools/gcc-arm-none-eabi
+RUN tar xf ${v_gcc_arm} -C /opt/tools/gcc-arm-none-eabi --strip 1
+
+# Bail back out to Jenkins user for setting persistent environment
+# variable changes
+
+USER jenkins
+
+# Set the path to pick up the GNU ARM embedded tools we've added.
+
+ENV PATH "$PATH:/opt/tools/gcc-arm-none-eabi/bin"

README.md

@@ -0,0 +1,67 @@
+# A Docker image for Embedded C++17 CI builds
+
+This Docker container extends `13coders/cpp17-base`, [located in
+DockerHub](https://hub.docker.com/r/13coders/cpp17-base/) with tooling
+for ARM Cortex-M development. Please check the base image for more
+detailed documentation.
+
+## Features
+
+The base image contains a complete set of C++ tooling for amd64
+development, as well as extending from the official Jenkins
+image. Added components in this image are:
+
+| Component | Source | Version | Notes |
+| --- | ---| --- | --- |
+| [usbutils](https://packages.debian.org/stretch/usbutils) | apt-get | | Gives `lsusb` for debugging USB connection issues |
+| [GNU Arm Embedded](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm) | S3/binary | 7-2017-q4-major | Toolchain for Cortex-M/R development |
+
+In addition, this image adds the `jenkins` user to the `plugdev` group
+for connection to USB hardware for deployment/flash of binaries for
+on-device testing or profiling - or just as a reproducible
+version-controlled deployment for other manual test with hardware
+diagnostic tools and debuggers.
+
+It's expected that this image will in turn be extended for specific
+debug toolchains.
+
+## Running the CI server
+
+Please consult the `13coders/cpp17-base` documentation for a fuller
+description of the container launch.
+
+We'll note here that it's also generally necessary to pass USB devices
+into the container launch for any embedded USB hardware that you need
+to interact with. It is strongly preferred to do this rather than run
+the container as `--privileged`.
+
+On the host side, running the `lsusb` command would show the USB
+device we want to access in the container:
+
+```
+$ lsusb
+...
+Bus 001 Device 009: ID 1366:0101 XYZ PLC JTAG/SWD Debug Probe
+...
+```
+
+The bus and device are then identified to Docker when we launch the
+container with the `--device` argument shown below (see the base image
+documentation for an explanation of the other command-line arguments):
+
+```
+$ docker run \
+  -p 8080:8080 \
+  -p 50000:50000 \
+  -v /path/to/local/dir:/var/jenkins_home \
+  --cap-add SYS_PTRACE \
+  --device=/dev/bus/usb/001/009 \
+  13coders/cpp17-base
+
+```
+
+It's worth noting also that Docker containers are immutable after
+launch, and although unplugging and re-inserting USB cables for
+embedded hardware on the host side might result in `udev` picking up
+the reinserted device, the container will not see it. Leave embedded
+test hardware plugged in throughout the container run.