Skip to content

Commit

Permalink
Add doc of one-line quick start script for different storage types (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
kezhenxu94 committed Mar 14, 2024
1 parent d894acd commit 52d5b25
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docker/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ services:
- demo
expose:
- 17912
ports:
- 17913:17913
command: standalone --stream-root-path /tmp/stream-data --measure-root-path /tmp/measure-data
healthcheck:
test: [ "CMD", "sh", "-c", "nc -nz 127.0.0.1 17912" ]
Expand Down Expand Up @@ -93,6 +95,9 @@ services:
profiles:
- "banyandb"
container_name: oap
depends_on:
banyandb:
condition: service_healthy
environment:
<<: *oap-env
SW_STORAGE: banyandb
Expand Down
1 change: 1 addition & 0 deletions docs/en/changes/changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,5 +123,6 @@
* Fix query-protocol.md, make it consistent with the GraphQL query protocol.
* Add `SWIP-5 Support ClickHouse Monitoring`.
* Remove `OpenTelemetry Exporter` support from meter doc, as this has been flagged as unmaintained on OTEL upstream.
* Add doc of one-line quick start script for different storage types.

All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/202?closed=1)
19 changes: 19 additions & 0 deletions docs/en/setup/backend/backend-docker.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# How to use the Docker images

## Start the storage, OAP and UI with docker-compose

As a quick start, you can use our one-line script to start ElasticSearch or
BanyanDB as the storage, OAP server and UI, please make sure you have installed
Docker.

```shell
bash <(curl -sSL https://skywalking.apache.org/quickstart-docker.sh)
```

You will be prompted to choose the storage type, and then the script will start
the backend cluster with the selected storage.

To tear down the cluster, run the following command:

```shell
docker compose --project-name=skywalking-quickstart down
```

## Start a `standalone` container with `H2` storage

```shell
Expand Down

0 comments on commit 52d5b25

Please sign in to comment.