Merge pull request #1467 from SpiNNakerManchester/update-docker-config

Update docker config

Author: rowleya

SpiNNaker-allocserv/Dockerfile

@@ -15,7 +15,7 @@
 # Use Ubuntu
 FROM ubuntu:noble
 
-RUN apt update && apt install -y openjdk-21-jdk-headless maven git ping
+RUN apt update && apt install -y openjdk-21-jdk-headless maven git iputils-ping
 
 # Set the working directory in the container
 WORKDIR /app

SpiNNaker-allocserv/README.md

@@ -23,6 +23,5 @@ docker logs -f spalloc-spring-container
 ### Connecting to docker compose SQL server
 You can connect to the spalloc database with:
 ```
-docker exec -it spalloc-mysql-container /usr/bin/mysql -D spalloc -u <SPRING_DATASOURCE_USERNAME> -p
+docker exec -it spalloc-mysql-container /usr/bin/mysql -D spalloc -u spalloc -pspalloc
 ```
-replacing the value of ``<SPRING_DATASOURCE_USERNAME>`` with the username in the env file, and followed by entering the value of ``SPRING_DATASOURCE_PASSWORD`` when asked for a password.

SpiNNaker-allocserv/docker-compose.yml

@@ -16,19 +16,23 @@ services:
   spalloc-mysql-db:
     image: mysql:8.0
     container_name: spalloc-mysql-container
-    env_file: spalloc.env
+    environment:
+      SPRING_DATASOURCE_USERNAME: spalloc
+      SPRING_DATASOURCE_PASSWORD: spalloc
+      MYSQL_ROOT_PASSWORD: spalloc-root
     healthcheck:
-        test: ["CMD", "/usr/bin/mysql", "--database=spalloc_history", "--user=$$SPRING_DATASOURCE_USERNAME",  "--password=$$SPRING_DATASOURCE_PASSWORD", "--execute", "SHOW DATABASES;"]
-        interval: 2s
-        timeout: 2s
-        retries: 100
+      test: ["CMD", "/usr/bin/mysql", "--database=spalloc_history", "--user=spalloc",  "--password=spalloc", "--execute", "SHOW DATABASES;"]
+      interval: 2s
+      timeout: 2s
+      retries: 100
     ports:
       - "3306:3306"
     networks:
       - spalloc-mysql
     volumes:
       - spalloc-mysql-data:/var/lib/mysql
       - ./spalloc-mysql/init:/docker-entrypoint-initdb.d
+    restart: always
 
   spalloc:
     build:
@@ -45,10 +49,13 @@ services:
         condition: service_healthy
     env_file: spalloc.env
     environment:
+      SPRING_DATASOURCE_USERNAME: spalloc
+      SPRING_DATASOURCE_PASSWORD: spalloc
       SPRING_DATASOURCE_URL: jdbc:mysql://spalloc-mysql-container:3306/spalloc?autoReconnect=true&useSSL=false
       SPRING_HISTORICAL_DATASOURCE_URL: jdbc:mysql://spalloc-mysql-container:3306/spalloc_history?autoReconnect=true&useSSL=false
     volumes:
       - ./application.yml:/app/application.yml
+    restart: always
 
 networks:
   spalloc-mysql:

SpiNNaker-allocserv/spalloc.env.example

@@ -12,26 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Root password for the MYSQL instance
-MYSQL_ROOT_PASSWORD=
-
-# Username for the spalloc database
-SPRING_DATASOURCE_USERNAME=
-
-# Password for the spalloc database
-SPRING_DATASOURCE_PASSWORD=
-
 # OpenID client id from EBRAINS
-EBRAINS_OPENID_CLIENT_ID=
+EBRAINS_OPENID_CLIENT_ID=spalloc
 
 # OpenID client secret from EBRAINS
 EBRAINS_OPENID_CLIENT_SECRET=
 
 # The host that people will use to access spalloc
+# This is the host name of this machine as seen from outside
 SPRING_SERVER_HOST=
 
 # The API Key to access NMPI services (quota etc.)
 SPALLOC_NMPI_API_KEY=
 
 # The IP address that the proxy should use to speak to real machines
+# This is the IP address of the local machine on the SpiNNaker network (e.g. 10.11.192.X)
 SPALLOC_PROXY_LOCAL_HOST=

SpiNNaker-nmpiserv/Dockerfile

@@ -15,7 +15,15 @@
 # Use Ubuntu
 FROM ubuntu:noble
 
-RUN apt update && apt install -y openjdk-21-jdk-headless maven git libltdl7
+ARG DOCKER_GROUP_ID
+ENV DOCKER_GROUP_ID $DOCKER_GROUP_ID
+
+RUN apt update && apt install -y openjdk-21-jdk-headless maven git libltdl7 nginx
+
+COPY --chown=www-data nginx.conf /etc/nginx/nginx.conf
+
+RUN groupadd -g $DOCKER_GROUP_ID docker
+RUN usermod -a -G docker www-data
 
 # Set the working directory in the container
 WORKDIR /app
@@ -29,5 +37,7 @@ RUN mvn -f JavaSpiNNaker -DskipTests=true -pl SpiNNaker-nmpiserv -am package
 # Get the binary into place
 RUN cp JavaSpiNNaker/SpiNNaker-nmpiserv/target/SpiNNakerNMPI.war .
 
+COPY --chmod=0755 startup.sh /app/startup.sh
+
 # Specify the command to start things
-CMD [ "java", "-Djava.net.preferIPv4Stack=true", "-Djava.awt.headless=true", "-jar", "SpiNNakerNMPI.war", "--spring.config.location=/app/nmpi.properties", "-" , "--server.port=9090" ]
+CMD [ "/app/startup.sh" ]

SpiNNaker-nmpiserv/README.md

@@ -7,16 +7,15 @@ This is a [Spring Boot](https://spring.io/projects/spring-boot) web application.
 ## Usage
 This folder contains configuration which can be used to set up a docker compose instance of the service.  To use this, do the following:
 
- 1. Copy files ``application.properties.example``, ``Dockerfile``, ``docker-compose.yml``. ``nginx.conf`` and ``execute_pynn.bash`` to your deployment folder.
- 2. Rename ``application.properties.example`` to ``application.properties``
- 3. Update ``application.properties`` with valid values for your environment, particularly replacing items in angle brackets.
- 4. Update ``docker-compose.yml`` with valid values for your environment,
- particularly replacing items in angle brackets.
- 4. Run ``docker compose build`` to build the docker environment
- 5. Run ``docker compose start -d`` to start the services
+ 1. Copy files ``nmpi.properties.example``, ``Dockerfile``, ``docker-compose.yml``, ``nginx.conf``, ``startup.sh``, ``env.example`` and ``execute_pynn.bash`` to your deployment folder.
+ 2. Rename ``nmpi.properties.example`` to ``nmpi.properties``
+ 3. Rename ``env.example`` to ``.env``
+ 4. Update ``.env`` with valid values for your environment
+ 5. Run ``docker compose build`` to build the docker environment
+ 6. Run ``docker compose up -d`` to start the services
 
 ### Viewing logs
-You can view the logs of the spalloc server with:
+You can view the logs of the NMPI service with:
 ```
-docker logs -f nmpi-host
+docker compose logs -f nmpi
 ```

SpiNNaker-nmpiserv/docker-compose.yml

@@ -17,25 +17,20 @@ services:
     build:
       context: .
       dockerfile: Dockerfile
+      args:
+        DOCKER_GROUP_ID: ${DOCKER_GROUP_ID}
     container_name: nmpi-host
+    env_file: .env
     ports:
       - "9090:9090"
     networks:
       - nmpi-network
     volumes:
       - ./nmpi.properties:/app/nmpi.properties
       - ./execute_pynn.bash:/app/execute_pynn.bash
-      - <DATA_PATH>:/mnt/data/
-
-  nginx:
-    image: nginx
-    container_name: nmpi-nginx
-    networks:
-      - nmpi-network
-    volumes:
-      - <DOCKER_SOCK_PATH>/docker.sock:/docker.sock
-      - ./nginx.conf:/etc/nginx/nginx.conf
+      - /var/run/docker.sock:/var/run/docker.sock
+      - ${DATA_PATH}:/mnt/data/
 
 networks:
   nmpi-network:
-    name: nmpi-network
+    name: nmpi-network

SpiNNaker-nmpiserv/docker_image/Dockerfile

@@ -34,7 +34,7 @@ RUN apt-get update --yes && \
     gcc \
     lsof \
     gcc-arm-none-eabi \
-    openjdk-17-jdk \
+    openjdk-21-jdk \
     maven \
     ffmpeg \
     curl \

SpiNNaker-nmpiserv/env.example

@@ -0,0 +1,35 @@
+# Copyright (c) 2025 The University of Manchester
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# OpenID client id from EBRAINS
+EBRAINS_OPENID_CLIENT_ID=spalloc
+
+# OpenID client secret from EBRAINS
+EBRAINS_OPENID_CLIENT_SECRET=
+
+# The host that people will use to access the NMPI server
+# This is the host name of this machine as seen from outside
+NMPI_SERVER_HOST=
+
+# The API Key to access NMPI services
+NMPI_API_KEY=
+
+# The IP address or URL that should use to speak to the spalloc server
+SPALLOC_SERVER_URL=
+
+# The path to where complete data files should be stored
+DATA_PATH=
+
+# The Group ID of the docker user (found from "getent group docker")
+DOCKER_GROUP_ID=

SpiNNaker-nmpiserv/nginx.conf

@@ -70,7 +70,7 @@ http {
         # Virtual Host Configs
         ##
         upstream docker {
-            server unix:/docker.sock;
+            server unix:/var/run/docker.sock;
         }
 
         server {
@@ -81,4 +81,4 @@ http {
                 proxy_pass http://docker/;
             }
         }
-}
+}