feat: docker environments for gsw (#42)

Author: K3das

.github/workflows/publish-docker.yml

@@ -0,0 +1,49 @@
+name: Build and publish Docker image
+
+on:
+  push:
+    branches:
+      - 'main'
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      attestations: write
+      id-token: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+      - name: Log in to the Container registry
+        uses: docker/login-action@184bdaa0721073962dff0199f1fb9940f07167d1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+      - name: Build and push Docker image
+        id: push
+        uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83
+        with:
+          context: .
+          file: cmd/Containerfile
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+      
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v3
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true

README.md

@@ -12,6 +12,60 @@ You can always run the GSW service by doing a `./gsw_service` after building. Fo
 ### Compatibility
 Some machines do not have a /dev/shm directory. The directory used for shared memory can be changed with the flag `-shm (DIRECTORY_NAME)`. For example, `go run cmd/mem_view/mem_view.go -shm /someDirectory/RAMDrive`.
 
+## Docker
+It may be easier to run the GSW in a docker container. This might be better for compatibility and easier for people on Windows hosts (as docker desktop will natively use a WLS 2 backend).
+
+A dockerfile for GSW is provided in `./cmd/Containerfile` and can be built and run with:
+```shell
+$ docker build -t launch-gsw -f ./cmd/Containerfile .
+```
+
+And the container could be started with:
+```shell
+$ docker run --name gsw-service \
+    -p 11020:11020/udp \
+    -p 13020:13020/udp \
+    -p 12005:12005/udp \
+    -p 12006:12006/udp \
+    -p 12002:12002/udp \
+    launch-gsw
+```
+
+### `docker-compose`
+
+For simplicity, a `docker-compose` file is provided for building and running GSW, Grafana, and InfluxDB:
+```shell
+$ docker compose up --build
+```
+
+#### Accessing Grafana
+
+Grafana should be exposed at <http://localhost:3000>. 
+The default compose file has anonymous access enabled where the default user only has viewer permissions. 
+If you need to change dashboards or datasources, set `GF_AUTH_ANONYMOUS_ORG_ROLE=Admin` in `compose.yaml` before starting the container.
+
+#### Accessing InfluxDB
+
+You can access the InfluxDB CLI using `docker compose exec -it influxdb influx`. 
+For example, to export all receiver telemetry as a CSV, run:
+```shell
+$ docker compose exec influxdb influx \
+    -database "gsw" \
+    -format csv \
+    -execute "SELECT * FROM receiver"
+```
+
+### Attaching to the container
+
+If you need to run any of the apps in `cmd/`, you can get a shell into the container using:
+```shell
+$ docker exec -it gsw-service sh
+```
+
+(if you're using docker compose this will be `docker compose exec -it gsw sh`)
+
+All binaries are in PATH as the names of their folders in `cmd/`.
+
 ## Unit Tests
 There are several unit tests that can be run. You can do a `go test ./...` from the root project directory to execute all tests. It is also recommended to run with the -cover
 flag to get coverage statements.
@@ -46,7 +100,7 @@ Once set up, the grafana_live application can be run from the root directory (wi
 Make sure the GSW service is running before starting the application.
 
 In case the setup utility does not work, live data streaming can be set up manually as follows:
-1. Import a new dashboard into Grafana using the JSON file located at `data/grafana/Backplane-Live.json`. The dashboard can have any name and UID.
+1. Import a new dashboard into Grafana using the JSON file located at `data/grafana/dashboards/Backplane-Live.json`. The dashboard can have any name and UID.
 2. Create a service account at the following URL: [http://localhost:3000/org/serviceaccounts/create](http://localhost:3000/org/serviceaccounts/create) (replace `http://localhost:3000` if you are using a different host).
 The service account can have any display name but must be given the Admin role ([More information about creating service accounts](https://grafana.com/docs/grafana/latest/administration/service-accounts/)).
 3. Click "Add service account token" and then "Generate token". The token can have any display name. Don't set an expiration date unless you want the token to become invalid after that date. 

cmd/Containerfile

@@ -0,0 +1,46 @@
+FROM golang:1.25-alpine AS build
+
+RUN apk add --update --no-cache build-base
+
+WORKDIR /go/src/app
+
+COPY go.mod .
+COPY go.sum .
+
+RUN --mount=type=cache,id=gsw_mod,target=/go/pkg/mod \
+    go mod download
+
+COPY . .
+
+RUN --mount=type=cache,id=gsw_mod,target=/go/pkg/mod \
+    --mount=type=cache,id=gsw_build,target=/root/.cache/go-build \
+    CGO_ENABLED=1 GOOS=linux go build \
+    -trimpath \
+    -o /build-output/bin/gsw_service \
+    -v \
+    ./cmd/gsw_service.go
+
+RUN --mount=type=cache,id=gsw_mod,target=/go/pkg/mod \
+    --mount=type=cache,id=gsw_build,target=/root/.cache/go-build \
+    for binary in grafana_live live_setup mem_view pipeline_benchmark telem_view udp_command; do \
+        CGO_ENABLED=1 GOOS=linux go build \
+        -trimpath \
+        -o /build-output/bin/$binary \
+        -v \
+        ./cmd/$binary/; \
+    done
+
+FROM alpine
+
+RUN addgroup -S appgroup && adduser -S appuser -G appgroup
+
+COPY data /opt/app/data
+COPY --from=build /build-output/bin/ /usr/bin/
+
+WORKDIR /opt/app
+
+USER appuser
+
+ENV GSW_LOGGER_OUTPUT_PATHS=stdout
+
+ENTRYPOINT [ "gsw_service" ]

cmd/gsw_service.go

@@ -123,6 +123,8 @@ func readConfig() (*viper.Viper, int) {
 	flag.Parse()
 	config.SetConfigName(*configFilepath)
 	config.SetConfigType("yaml")
+	config.SetEnvPrefix("GSW")
+	config.AutomaticEnv()
 	config.AddConfigPath("data/config/")
 	err := config.ReadInConfig()
 

cmd/live_setup/live_setup.go

@@ -16,7 +16,7 @@ import (
 	"strings"
 )
 
-const DashboardJsonFile = "data/grafana/Backplane-Live.json"
+const DashboardJsonFile = "data/grafana/dashboards/Backplane-Live.json"
 
 // Prompts the user for the Grafana username, password, and URL.
 // Returns a URL to Grafana containing the username and password info for basic auth.

compose.yaml

@@ -0,0 +1,48 @@
+services:
+  gsw:
+    build:
+      context: .
+      dockerfile: cmd/Containerfile
+    depends_on:
+      influxdb:
+        condition: service_started
+      grafana:
+        condition: service_started
+    environment:
+      - GSW_DATABASE_HOST_NAME=influxdb
+    ports:
+      - 11020:11020/udp
+      - 13020:13020/udp
+      - 12005:12005/udp
+      - 12006:12006/udp
+      - 12002:12002/udp
+
+  grafana:
+    build:
+      context: data/grafana
+      dockerfile: Containerfile
+    ports:
+      - "127.0.0.1:3000:3000/tcp"
+    depends_on:
+      influxdb:
+        condition: service_started
+    environment:
+      - GSW_GRAFANA_INFLUXDB_URL=http://influxdb:8086
+      - GSW_GRAFANA_INFLUXDB_USER=root
+      - GSW_GRAFANA_INFLUXDB_PASSWORD=root
+      - GF_AUTH_ANONYMOUS_ENABLED=true
+      - GF_AUTH_ANONYMOUS_ORG_ROLE=Viewer
+      - GF_AUTH_BASIC_ENABLED=false
+    volumes:
+      - grafana-data:/var/lib/grafana
+  influxdb:
+    image: influxdb:1.11-alpine
+    volumes:
+      - influxdb-data:/var/lib/influxdb
+    environment:
+      - INFLUXDB_UDP_ENABLED=true
+      - INFLUXDB_UDP_DATABASE=gsw
+
+volumes:
+  grafana-data:
+  influxdb-data:

data/grafana/Containerfile

@@ -0,0 +1,18 @@
+FROM alpine AS build-dashboards
+
+RUN apk add --update --no-cache jq
+
+WORKDIR /dashboards
+
+COPY dashboards/ .
+RUN mkdir processed
+
+RUN for dashboard in *.json; do \
+        jq 'walk(if type == "object" and .datasource.type == "influxdb" and (.datasource | has("uid")) then .datasource.uid = "gsw-influxdb" else . end)' "$dashboard" > "processed/$dashboard"; \
+    done
+
+FROM grafana/grafana:12.1
+
+COPY --from=build-dashboards /dashboards/processed /etc/grafana/provisioning/gsw-dashboards
+COPY provisioning/datasources /etc/grafana/provisioning/datasources
+COPY provisioning/gsw-dashboard-provider.yaml /etc/grafana/provisioning/dashboards/gsw-dashboard-provider.yaml