Skip to content

Commit

Permalink
Add Docker build
Browse files Browse the repository at this point in the history
  • Loading branch information
Levi-Armstrong committed Mar 7, 2024
1 parent 5639cbe commit c7fc6ac
Show file tree
Hide file tree
Showing 4 changed files with 130 additions and 0 deletions.
63 changes: 63 additions & 0 deletions .github/workflows/docker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Docker

on:
push:
branches:
- master
pull_request:
paths:
- 'docker/Dockerfile'
- '.github/workflows/docker.yml'
release:
types:
- released

jobs:
ci:
name: ${{ matrix.distro }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
distro: [focal, jammy]
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
PUSH_DOCKER_IMAGE: ${{ github.ref == 'refs/heads/master' || github.event_name == 'release' }}
permissions:
contents: read
packages: write
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Log in to the Container registry
uses: docker/login-action@v3
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

- name: Extract Docker meta-information
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
flavor: |
latest=false
prefix=
suffix=
tags: |
type=ref,event=branch,prefix=${{ matrix.distro }}-
type=raw,event=pr,prefix=${{ matrix.distro }}-,value=master
type=semver,pattern={{major}}.{{minor}},prefix=${{ matrix.distro }}-
- name: Build and push Docker image
uses: docker/build-push-action@v5
with:
context: .
file: docker/Dockerfile
build-args: TAG=${{ steps.meta.outputs.version }}
push: ${{ env.PUSH_DOCKER_IMAGE }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
25 changes: 25 additions & 0 deletions docker/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
ARG TAG
FROM ghcr.io/tesseract-robotics/tesseract:${TAG}

SHELL ["/bin/bash", "-c"]

ENV DEBIAN_FRONTEND noninteractive

USER root

# Bind mount the source directory so as not to unnecessarily copy source code into the docker image
ARG WORKSPACE_DIR=/opt/tesseract_planning
RUN --mount=type=bind,target=${WORKSPACE_DIR}/src/trajopt \
cd ${WORKSPACE_DIR} \
&& vcs import src < src/trajopt/dependencies.repos --shallow \
&& rosdep install \
--from-paths ${WORKSPACE_DIR}/src \
-iry

# Build the repository
# Bind mount the source directory so as not to unnecessarily copy source code into the docker image
RUN --mount=type=bind,target=${WORKSPACE_DIR}/src/trajopt \
source /opt/tesseract/install/setup.bash \
&& cd ${WORKSPACE_DIR} \
&& colcon build --cmake-args -DCMAKE_BUILD_TYPE=Release \
&& rm -rf build log
28 changes: 28 additions & 0 deletions docker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# TrajOpt Docker

## Create the Docker image
### Download
Download a pre-built Docker image for this bridge from the container registry:

```
docker login ghcr.io
docker pull ghcr.io/tesseract-robotics/trajopt_deploy:<tag>
```

### Build
Build the Docker image using `docker-compose`:

```commandLine
cd docker
docker compose build
```

## Run the docker image
Run the Docker image using `docker-compose`:

```commandLine
cd docker
CURRENT_UID=$(id -u):$(id -g) docker compose up
```

> Note: by default the docker image runs as a non-root user, so the environment variable `CURRENT_UID` must be supplied as shown above
14 changes: 14 additions & 0 deletions docker/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
version: '3'
services:
tesseract:
build:
context: ..
dockerfile: docker/Dockerfile
args:
- TAG=focal-0.20
container_name: tesseract_planning
image: ghcr.io/tesseract-robotics/trajopt_deploy:focal-0.20
stdin_open: true
tty: true
network_mode: host
user: ${CURRENT_UID} # CURRENT_UID=$(id -u):$(id -g)

0 comments on commit c7fc6ac

Please sign in to comment.