Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docker compose readme #255

Merged
merged 2 commits into from
Mar 14, 2023
Merged

update docker compose readme #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b9864f
update docker compose readme
Mar 13, 2023
836b27f
add platform docs
Mar 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,8 @@ You can create a Docker image named `io.stargate/jsonapi` using:
./mvnw clean package -Dquarkus.container-image.build=true
```

> NOTE: Include the property `-Dquarkus.docker.buildx.platform=linux/amd64,linux/arm64` if you want to build for multiple platforms.

Or, if you want to create a native-runnable Docker image named `io.stargate/jsonapi-native` using:
```shell script
./mvnw clean package -Pnative -Dquarkus.native.container-build=true
Expand Down
9 changes: 6 additions & 3 deletions docker-compose/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,17 @@ This directory provides two ways to start the JSON API and Stargate coordinator
## Stargate JSON API with 3-node DSE 6.8 cluster

> **PREREQUISITES:** Please build the latest JSONAPI docker image first by running:
>
> ```bash
> ./mvnw clean package -Dquarkus.container-image.build=true -DskipTests
> ```
>
> You can control the platform using the `-Dquarkus.docker.buildx.platform=linux/amd64,linux/arm64` property.

You can start a simple Stargate configuration with the following command:

```
docker compose up -d
docker-compose up -d
ivansenic marked this conversation as resolved.
Show resolved Hide resolved
```

This brings up the configuration described in the `docker-compose.yml` file. The configuration includes health criteria for each container that is used to ensure the containers come up in the correct order.
Expand All @@ -30,13 +33,13 @@ Whether you use the shell script or start `docker compose` directly, you can rem
This alternate configuration runs the Stargate coordinator node in developer mode, so that no separate Cassandra cluster is required. This can be run with the command:

```
docker compose -f docker-compose-dev-mode.yml up -d
docker-compose -f docker-compose-dev-mode.yml up -d
```

To stop the configuration, use the command:

```
docker compose -f docker-compose-dev-mode.yml down
docker-compose -f docker-compose-dev-mode.yml down
```

This configuration is useful for development and testing since it initializes more quickly, but is not recommended for production deployments. This configuration also has a convenience script: `start_dse_68_dev_mode.sh`.
Expand Down