gridappsd-docker

Requirements

• git
• Docker version 17.12 or higher
• Docker Compose (either docker compose or docker-compose)

Install Docker

See DOCKER_INSTALL.md for detailed installation instructions for:

• Ubuntu / Debian
• Fedora / RHEL / CentOS
• macOS
• Windows

Clone or download the repository

git clone https://github.com/GRIDAPPSD/gridappsd-docker
cd gridappsd-docker

Check Available Versions

To see available GridAPPS-D versions on Docker Hub:

./get-versions.sh           # Show release versions (v2023.07.0 format)
./get-versions.sh -a        # Show all tags including develop, latest
./get-versions.sh -n 20     # Show more results

Start the docker container services

./run.sh

The run.sh script does the following:

• Downloads the mysql dump file
• Downloads the blazegraph data
• Starts the docker containers
• Ingests the blazegraph data
• Starts GridAPPS-D automatically

run.sh Options

Option	Description
-d	Enable debug output
-n	No auto-start; drop into container shell instead
-p	Pull updated containers
-r [ip]	Use remote IP address for viz (uses external IP if not specified)
-t tag	Specify GridAPPS-D docker tag (e.g., -t v2023.07.0)

Examples

./run.sh                    # Start with auto-start (default)
./run.sh -n                 # Start and drop into container shell
./run.sh -t develop         # Use develop tag
./run.sh -t v2023.07.0      # Use specific version

Available Endpoints

Once running, GridAPPS-D is available at:

Service	URL/Address
Web UI	http://localhost:8080/
Blazegraph	http://localhost:8889/bigdata/
STOMP	tcp://localhost:61613
WebSocket	ws://localhost:61614
OpenWire	tcp://localhost:61616

Connecting to the Container

docker exec -it gridappsd /bin/bash

Viewing Logs

docker logs -f gridappsd

Stopping the containers

./stop.sh           # Stop containers
./stop.sh -c        # Stop and remove containers, dump files, and databases
./stop.sh -w        # Stop and remove containers and databases, keep dump files

Note: There is also a remove_all_containers.sh script, but be aware that it removes ALL Docker containers and unused networks on your system, not just GridAPPS-D. Use ./stop.sh -c to remove only GridAPPS-D containers.

Restarting the containers

./run.sh

Next Steps

• Add applications/services to the containers (see how https://github.com/GRIDAPPSD/gridappsd-sample-app)

---

docker-compose.d Directory

The docker-compose.d/ directory allows you to extend the base docker-compose configuration with additional services. Any .yml file in this directory is automatically included when running ./run.sh.

How It Works

1. The run.sh script scans docker-compose.d/ for files ending in .yml
2. Each .yml file is added to the docker-compose command with -f
3. Services defined in these files are started alongside the core GridAPPS-D services

Adding Optional Services

The directory contains .dist files as templates for optional services:

File	Description
docker-compose_pyvvo.yml.dist	PyVVO voltage optimization app
docker-compose_der-dispatch.yml.dist	DER dispatch service
docker-compose_solar-forecast.yml.dist	Solar forecasting service
docker-compose_grid-forecasting.yml.dist	Grid forecasting service
docker-compose_wsu-vvo.yml.dist	WSU VVO application
docker-compose_wsu-restoration.yml.cplex	WSU restoration (requires CPLEX)
docker-compose_timescaledb.yml.dst	TimescaleDB for time-series data

To enable an optional service:

# Copy and rename the template (remove .dist suffix)
cp docker-compose.d/docker-compose_pyvvo.yml.dist docker-compose.d/docker-compose_pyvvo.yml

# Edit as needed
nano docker-compose.d/docker-compose_pyvvo.yml

# Restart to include the new service
./stop.sh
./run.sh

Auto-Generated Files

The following files may be auto-generated by run.sh and are cleaned up by stop.sh -c:

• viz.yml - Created when using -r flag for remote viz configuration
• no-autostart.yml - Created when using -n flag to disable auto-start

Creating Custom Services

Create a new .yml file in docker-compose.d/:

services:
  my-custom-app:
    image: my-app:latest
    environment:
      GRIDAPPSD_URI: tcp://gridappsd:61613
    depends_on:
      - gridappsd

---

Advanced Usage

Using GridAPPS-D on a remote system with a local browser

./run.sh -r

Open your browser to http://remoteip:8080/

Using a specific version

# Check available versions
./get-versions.sh

# Run with a specific version
./run.sh -t v2023.07.0

Development mode (no auto-start)

./run.sh -n
# Inside the container:
./run-gridappsd.sh

Using GridAPPS-D