You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by ke...@apache.org on 2025/12/15 12:31:23 UTC
(skywalking-showcase) branch doc updated (49acd4a -> 81bbd63)
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a change to branch doc
in repository https://gitbox.apache.org/repos/asf/skywalking-showcase.git
discard 49acd4a fix(doc): fix the default storage description
new 81bbd63 fix(doc): fix the default storage description
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (49acd4a)
\
N -- N -- N refs/heads/doc (81bbd63)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/readme.md | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
(skywalking-showcase) 01/01: fix(doc): fix the default storage description
Posted by ke...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch doc
in repository https://gitbox.apache.org/repos/asf/skywalking-showcase.git
commit 81bbd6383d796773e50914d1baf7ee8e80ebc8c8
Author: kezhenxu94 <ke...@apache.org>
AuthorDate: Mon Dec 15 20:28:35 2025 +0800
fix(doc): fix the default storage description
---
docs/readme.md | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/docs/readme.md b/docs/readme.md
index 4ae9022..494a00e 100644
--- a/docs/readme.md
+++ b/docs/readme.md
@@ -63,10 +63,14 @@ environment variable with the same name, e.g.:
```shell
export ES_VERSION=7.14.0
-make <target>
+make <target> FEATURE_FLAGS=single-node,agent,elasticsearch
```
-or directly specifying in the `make` command, e.g.: `make <target> ES_VERSION=7.14.0`.
+or directly specifying in the `make` command, e.g.: `make <target> ES_VERSION=7.14.0 FEATURE_FLAGS=single-node,agent,elasticsearch`.
+
+**Note**: Since BanyanDB is the default storage, if you want to use Elasticsearch or PostgreSQL as storage, you need to
+explicitly include the `elasticsearch` or `postgresql` feature flag in `FEATURE_FLAGS` to switch the storage backend,
+and exclude the `banyandb` feature flag from the default feature flags.
Run `make help` to get more information.
@@ -90,9 +94,10 @@ Currently, the features supported are:
| `java-agent-injector` | Use the java agent injector to inject the Skywalking Java agent and deploy microservices with other SkyWalking agent enabled. | The microservices include agents for Java, NodeJS server, browser, Python. |
| `agent` | Deploy microservices with SkyWalking agent pre-installed. | In Kubernetes scenarios, please use `java-agent-injector` instead of this, if possible. |
| `cluster` | Deploy SkyWalking OAP in cluster mode, with 2 nodes, and SkyWalking UI. | Only one of `cluster` or `single-node` can be enabled. |
-| `single-node` | Deploy only one single node of SkyWalking OAP, and SkyWalking UI, ElasticSearch as storage. | Only one of `cluster` or `single-node` can be enabled. |
-| `elasticsearch` | Deploy ElasticSearch as storage, you may want to disable this if you want to use your own ElasticSearch deployments. | |
-| `postgresql` | Deploy PostgreSQL as storage, you may want to disable this if you want to use your own PostgreSQL deployments. | |
+| `single-node` | Deploy only one single node of SkyWalking OAP, and SkyWalking UI, BanyanDB as storage. | Only one of `cluster` or `single-node` can be enabled. |
+| `banyandb` | Deploy BanyanDB as storage, you may want to disable this if you want to use your own BanyanDB deployments. | This is the default storage for the showcase. |
+| `elasticsearch` | Deploy ElasticSearch as storage, you may want to disable this if you want to use your own ElasticSearch deployments. | Alternative storage option. BanyanDB is used by default. |
+| `postgresql` | Deploy PostgreSQL as storage, you may want to disable this if you want to use your own PostgreSQL deployments. | Alternative storage option. BanyanDB is used by default. |
| `so11y` | Enable SkyWalking self observability. | This is enabled by default for platform [Docker Compose](#docker-compose). |
| `vm-monitor` | Start 2 virtual machines and export their metrics to SkyWalking. | The "virtual machines" are mimicked by Docker containers or Pods. |
| `als` | Start microservices WITHOUT SkyWalking agent enabled, and configure SkyWalking to analyze the topology and metrics from their access logs. | Command `istioctl` is required to run this feature. The agentless microservices will be running at namespace `${NAMESPACE}-agentless` |