This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking.git
The following commit(s) were added to refs/heads/master by this push:
new 52d5b2573c Add doc of one-line quick start script for different
storage types (#12014)
52d5b2573c is described below
commit 52d5b2573cb1050602d50110d1f233511fef198b
Author: kezhenxu94 <kezhenx...@apache.org>
AuthorDate: Thu Mar 14 11:55:34 2024 +0800
Add doc of one-line quick start script for different storage types (#12014)
---
docker/docker-compose.yml | 5 +++++
docs/en/changes/changes.md | 1 +
docs/en/setup/backend/backend-docker.md | 19 +++++++++++++++++++
3 files changed, 25 insertions(+)
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
index a78e0ea590..32be66f1a8 100644
--- a/docker/docker-compose.yml
+++ b/docker/docker-compose.yml
@@ -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" ]
@@ -93,6 +95,9 @@ services:
profiles:
- "banyandb"
container_name: oap
+ depends_on:
+ banyandb:
+ condition: service_healthy
environment:
<<: *oap-env
SW_STORAGE: banyandb
diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
index 52e87ce3db..379208e42a 100644
--- a/docs/en/changes/changes.md
+++ b/docs/en/changes/changes.md
@@ -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)
diff --git a/docs/en/setup/backend/backend-docker.md
b/docs/en/setup/backend/backend-docker.md
index cc8bcaa7cb..b0dc88c925 100644
--- a/docs/en/setup/backend/backend-docker.md
+++ b/docs/en/setup/backend/backend-docker.md
@@ -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
