How to run the cluster in docker?

Install docker

• Windows: https://www.docker.com/products/docker-desktop/
• Linux: https://docs.docker.com/desktop/setup/install/linux/

Pull or build the agdb_server image

The image is based on Alpine Linux using musl libc. The image is made available on Docker Hub or GitHub packages:

If you want to build the image yourself run the following in the root of the checked out agdb repository:

docker build --pull -t agnesoft/agdb:dev -f agdb_server/containerfile .

Run the cluster

You will need the compose.yaml file from the sources at: https://github.com/agnesoft/agdb/blob/main/agdb_server/compose.yaml

# the -f path is where the file resides in the sources, you can change it to the actual location of the compose.yaml file
docker compose -f agdb_server/compose.yaml up --wait

This command runs the 3 nodes as a docker cluster using docker compose that contains valid cluster configuration. The volumes are provided for each node so that the data is persisted. It exposes the nodes at the ports 3000, 3001 and 3002.

Test that the cluster is up with curl

The following commands will hit each node and return the list of nodes, their status and which one is the leader. If the servers are connected and operating normally the returned list should be the same from each node.

curl -v localhost:3000/api/v1/cluster/status
curl -v localhost:3001/api/v1/cluster/status
curl -v localhost:3002/api/v1/cluster/status

Shutdown the cluster

The cluster can be shutdown either by stopping the containers or programmatically posting to the shutdown endpoints as logged in server admin:

# this will produce an admin API token, e.g. "bb2fc207-90d1-45dd-8110-3247c4753cd5"
token=$(curl -X POST -H 'Content-Type: application/json' localhost:3000/api/v1/user/login -d '{"username":"admin","password":"admin"}')
curl -X POST -H "Authorization: Bearer ${token}" localhost:3000/api/v1/admin/shutdown
 
token=$(curl -X POST -H 'Content-Type: application/json' localhost:3001/api/v1/user/login -d '{"username":"admin","password":"admin"}')
curl -X POST -H "Authorization: Bearer ${token}" localhost:3001/api/v1/admin/shutdown
 
token=$(curl -X POST -H 'Content-Type: application/json' localhost:3002/api/v1/user/login -d '{"username":"admin","password":"admin"}')
curl -X POST -H "Authorization: Bearer ${token}" localhost:3002/api/v1/admin/shutdown

While it is technically possible to use cluster login and avoid logins to each node separately it might be fragile and not work well in situations where the cluster is in the bad shapes with nodes not being available etc. Local login and shutdown are guaranteed to work regardless of the overall cluster status.