From a0ddfb919e5fd5f262dd7cbc552d2c8f1e9e3b48 Mon Sep 17 00:00:00 2001 From: Sajith Sasidharan Date: Tue, 23 Jan 2024 12:20:06 -0600 Subject: [PATCH] Update README --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d9476ecc..bab773e6 100644 --- a/README.md +++ b/README.md @@ -72,21 +72,37 @@ $ sudo sh elastic-search-setup.sh ### Running with Docker Compose (recommended) -A `docker-compose.yaml` is provided for bringing up run -sdx-controller, bapm-server, and a MongoDB instance used by -sdx-controller. From the project root directory, do: +A `compose.yaml` is provided for bringing up SDX Controller and a +MongoDB instance, and a separate `compose.bapm.yml` is provided for +bringing up bapm-server and a single-node ElasticSearch instance. + +To start/stop SDX Controller, from the project root directory, do: ```console $ source .env $ docker compose up --build +$ docker compose down ``` Navigate to http://localhost:8080/SDX-Controller/1.0.0/ui/ for testing the API. The OpenAPI/Swagger definition should be available at http://localhost:8080/SDX-Controller/1.0.0/openapi.json. -Use `docker compose down` to shut down the services. +Similarly, to start/stop BAPM Server, do: + +``` +$ source .env +$ docker compose -f compose.bapm.yml up --build +$ docker compose -f compose.bapm.yml down +``` +To start/stop all the services together: + +``` +$ source .env +$ docker compose -f compose.yml -f compose.bapm.yml up --build +$ docker compose -f compose.yml -f compose.bapm.yml down +``` #### Building the container images