You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/readme.md
+10-5Lines changed: 10 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,10 +63,14 @@ environment variable with the same name, e.g.:
63
63
64
64
```shell
65
65
export ES_VERSION=7.14.0
66
-
make <target>
66
+
make <target> FEATURE_FLAGS=single-node,agent,elasticsearch
67
67
```
68
68
69
-
or directly specifying in the `make` command, e.g.: `make <target> ES_VERSION=7.14.0`.
69
+
or directly specifying in the `make` command, e.g.: `make <target> ES_VERSION=7.14.0 FEATURE_FLAGS=single-node,agent,elasticsearch`.
70
+
71
+
**Note**: Since BanyanDB is the default storage, if you want to use Elasticsearch or PostgreSQL as storage, you need to
72
+
explicitly include the `elasticsearch` or `postgresql` feature flag in `FEATURE_FLAGS` to switch the storage backend,
73
+
and exclude the `banyandb` feature flag from the default feature flags.
70
74
71
75
Run `make help` to get more information.
72
76
@@ -90,9 +94,10 @@ Currently, the features supported are:
90
94
|`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. |
91
95
|`agent`| Deploy microservices with SkyWalking agent pre-installed. | In Kubernetes scenarios, please use `java-agent-injector` instead of this, if possible. |
92
96
|`cluster`| Deploy SkyWalking OAP in cluster mode, with 2 nodes, and SkyWalking UI. | Only one of `cluster` or `single-node` can be enabled. |
93
-
|`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. |
94
-
|`elasticsearch`| Deploy ElasticSearch as storage, you may want to disable this if you want to use your own ElasticSearch deployments. ||
95
-
|`postgresql`| Deploy PostgreSQL as storage, you may want to disable this if you want to use your own PostgreSQL deployments. ||
97
+
|`single-node`| Deploy only one single node of SkyWalking OAP, and SkyWalking UI. | Only one of `cluster` or `single-node` can be enabled. |
98
+
|`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. |
99
+
|`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. |
100
+
|`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. |
96
101
|`so11y`| Enable SkyWalking self observability. | This is enabled by default for platform [Docker Compose](#docker-compose). |
97
102
|`vm-monitor`| Start 2 virtual machines and export their metrics to SkyWalking. | The "virtual machines" are mimicked by Docker containers or Pods. |
98
103
|`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`|
0 commit comments