Skip to content

Commit 4e2863b

Browse files
authored
Merge pull request #165 from t0kubetsu/feat/docker-external-network
Add plum_net external network for Plum-Agent connectivity
2 parents 69fc79a + c622495 commit 4e2863b

2 files changed

Lines changed: 37 additions & 0 deletions

File tree

docker-compose.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ services:
2525
plum-meilisearch:
2626
condition: service_healthy
2727
restart: unless-stopped
28+
networks:
29+
- default
30+
- plum_net
2831

2932
plum-kvrocks:
3033
image: apache/kvrocks:latest
@@ -62,3 +65,7 @@ volumes:
6265
plum_uploads:
6366
kvrocks_data:
6467
meili_data:
68+
69+
networks:
70+
plum_net:
71+
external: true

documentation/installation.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,36 @@ docker compose down # stops containers, keeps volumes
130130
docker compose down -v # stops containers AND deletes all volumes
131131
```
132132

133+
### Connecting Plum-Agent
134+
135+
Plum-Agent runs as a separate Docker Compose stack. Because each stack gets its own isolated bridge network by default, the agent container cannot reach the Island `webapp` service unless they share an external network.
136+
137+
**One-time setup — create the shared network on the host:**
138+
139+
```bash
140+
docker network create plum_net
141+
```
142+
143+
This is already declared as an external network in Plum-Island's `docker-compose.yml`. The `webapp` service joins it automatically when the stack starts. Only `webapp` is exposed on `plum_net`; `kvrocks` and `meilisearch` remain on the internal stack network.
144+
145+
**In the Plum-Agent stack**, set the Island URL to the `plum-webapp` service name:
146+
147+
```bash
148+
PLUM_ISLAND=http://plum-webapp:5000
149+
```
150+
151+
Start both stacks (order does not matter):
152+
153+
```bash
154+
# Plum-Island directory
155+
docker compose up -d
156+
157+
# Plum-Agent directory
158+
docker compose up -d
159+
```
160+
161+
See the [Plum-Agent repository](https://github.com/D4-project/Plum-Agent) for agent installation and configuration.
162+
133163
## Runtime services
134164

135165
Plum Island expects:

0 commit comments

Comments
 (0)