Merge pull request srl-labs#343 from vrnetlab/topomachine-container-image

Build (with) topomachine container in CI

Author: mzagozen

.github/workflows/test.yml

@@ -53,6 +53,28 @@ jobs:
         if: always()
         run: make -C vr-bgp docker-test-clean
 
+  test-topomachine:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Build topomachine
+        run: |
+          make topology-machine
+
+      - name: Test topomachine
+        run: |
+          make topology-machine-test
+
+      - name: Save topomachine logs
+        if: always()
+        run: |
+          make -C topology-machine docker-test-save-logs
+
+      - name: Clean test topomachine containers
+        if: always()
+        run: make -C topology-machine docker-test-clean
+
   test-vr:
     runs-on: ["self-hosted"]
     container:

.gitlab-ci.yml

@@ -49,6 +49,9 @@ vr-xcon:
 vr-bgp:
   <<: *build-template
 
+topology-machine:
+  extends: .build
+
 csr:
   <<: *build-template
 

Makefile

@@ -1,5 +1,5 @@
 IMAGES_DIR=
-VRS = vr-xcon vr-bgp csr nxos nxos9kv routeros sros veos vmx vsr1000 vqfx vrp xrv xrv9k
+VRS = vr-xcon vr-bgp topology-machine csr nxos nxos9kv routeros sros veos vmx vsr1000 vqfx vrp xrv xrv9k
 VRS_PUSH = $(VRS:=-push)
 VRS_TEST = $(VRS:=-test)
 

topology-machine/Dockerfile

@@ -1,4 +1,4 @@
-FROM debian:bullseye
+FROM debian:bookworm
 MAINTAINER Kristian Larsson <[email protected]>
 
 ENV DEBIAN_FRONTEND=noninteractive
@@ -8,21 +8,21 @@ RUN apt-get update -qy \
  && apt-get install -y \
     python3-jinja2 \
     python3-yaml \
-    apt-transport-https \
-    ca-certificates \
     curl \
-    gnupg2 \
-    software-properties-common \
- && curl -fsSL https://download.docker.com/linux/debian/gpg | apt-key add - \
- && add-apt-repository \
-   "deb [arch=amd64] https://download.docker.com/linux/debian \
-   $(lsb_release -cs) \
-   stable" \
- && apt-get update -qy \
+# Install git & make so that we can use topomachine in CI to check for uncommitted topology and scripts changes
+    git \
+    make \
+ && install -m 0755 -d /etc/apt/keyrings \
+ && curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc \
+ && chmod a+r /etc/apt/keyrings/docker.asc \
+ && echo \
+  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
+  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null \
+ && apt-get update \
  && apt-get -y install docker-ce \
  && rm -rf /var/lib/apt/lists/*
 
-ADD topomachine /
-ADD *example* /
+ADD topomachine /usr/local/bin
 
-ENTRYPOINT ["/topomachine"]
+WORKDIR /data
+ENTRYPOINT ["/usr/local/bin/topomachine"]

topology-machine/Makefile

@@ -5,3 +5,29 @@ all:
 
 docker-push:
 	docker push $(REGISTRY)topomachine
+
+ifeq ($(PNS),)
+PNS:=$(shell whoami | sed 's/[^[:alnum:]._-]\+/_/g')
+endif
+CNT_PREFIX?=$(PNS)-topomachine
+VOLUME_NAME?=$(CNT_PREFIX)-data
+
+docker-test:
+# Do the (awkward) volume-copy dance to make sure we can run this test in GitLab
+# CI where the test script runs in a container with the hosts
+# /var/run/docker.sock mounted - sibling container.
+	-docker rm -f $(CNT_PREFIX)
+	-docker volume rm $(VOLUME_NAME)
+	docker volume create $(VOLUME_NAME)
+	docker create -v $(VOLUME_NAME):/data --name $(CNT_PREFIX) busybox
+	for f in example*; do docker cp $$f $(CNT_PREFIX):/data; done
+	docker rm $(CNT_PREFIX)
+	docker run -v $(VOLUME_NAME):/data --rm $(REGISTRY)topomachine --build example-hltopo.json
+	docker run -v $(VOLUME_NAME):/data --rm $(REGISTRY)topomachine --run example-lltopo.json --dry-run
+	docker run -v $(VOLUME_NAME):/data --rm $(REGISTRY)topomachine --template example-lltopo.json example.template
+
+docker-test-clean:
+	docker volume rm $(VOLUME_NAME)
+
+docker-test-save-logs:
+# nothing to do

topology-machine/README.md

@@ -177,16 +177,21 @@ The topomachine docker container can be used to generate the low level topology
 topology (--run), and to generate custom output using a jinja2 template 
 (--template).
 
+The topomachine binary is placed in `/usr/local/bin/topomachine` and is also set
+as an *ENTRYPOINT* for the container. The *WORKDIR* is set to `/data` so you can
+bind mount a host directory to `/data` and use `docker run ...` as a drop-in
+replacement for the topomachine command.
+
 For example:
 
 generate the low level topology:
 ```
-$ docker run -t -v $(pwd):/data topomachine --build /data/example-hltopo.json > example-lltopo.json
+$ docker run -t -v $(pwd):/data topomachine --build example-hltopo.json > example-lltopo.json
 ```
 
 generate the docker run commands:
 ```
-$ docker run -v $(pwd):/data topomachine --run /data/example-lltopo.json --dry-run
+$ docker run -v $(pwd):/data topomachine --run example-lltopo.json --dry-run
 The following commands would be executed:
 docker run --privileged -d --name ams-core-1 vrnetlab/vr-xrv:5.1.1.54U --foo bar 1
 docker run --privileged -d --name ams-core-2 vrnetlab/vr-xrv:5.1.1.54U --foo bar 1
@@ -204,14 +209,15 @@ docker run --rm --privileged -d --name vr-xcon --link ams-core-1:ams-core-1 --li
 docker run --privileged -d --name vr-xcon-hub-ams-mgmt --link ams-core-1:ams-core-1 --link ams-core-2:ams-core-2 --link ams-edge-1:ams-edge-1 --link fra-core-1:fra-core-1 --link fra-core-2:fra-core-2 --link fra-edge-1:fra-edge-1 --link kul-core-1:kul-core-1 --link par-core-1:par-core-1 --link par-core-2:par-core-2 --link par-edge-1:par-edge-1 --link png-edge-1:png-edge-1 --link sgp-core-1:sgp-core-1 vrnetlab/vr-xcon --hub ams-core-1/7 ams-core-2/7 ams-edge-1/3
 ```
 
-start the topology:
+To start the topology, topomachine needs access to the docker socket. Add the
+`-v /var/run/docker.sock:/var/run/docker.sock` option to the `docker run ...`:
 ```
-$ docker run -v $(pwd):/data -v /var/run/docker.sock:/var/run/docker.sock topomachine --run /data/example-lltopo.json
+$ docker run -v $(pwd):/data -v /var/run/docker.sock:/var/run/docker.sock topomachine --run example-lltopo.json
 ```
 
 generate custom output using a jinja2 template:
 ```
-$ docker run -t -v $(pwd):/data topomachine --template /data/example-lltopo.json /data/example.template
+$ docker run -t -v $(pwd):/data topomachine --template example-lltopo.json example.template
 infrastructure {
     base-config fra-edge-1 {
         numeric-id 101;