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

Improve the guide on setting up SkyWalking with BanyanDB #152

Merged
merged 3 commits into from
Jun 22, 2024
Merged

Improve the guide on setting up SkyWalking with BanyanDB #152

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f6099b2
Improve the guide on setting up SkyWalking with BanyanDB
ButterBright Jun 22, 2024
3518287
Polish document
ButterBright Jun 22, 2024
5303065
Include link to full parameter list in BanyanDB Helm chart repository
ButterBright Jun 22, 2024
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
58 changes: 30 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ There are required values that you must set explicitly when deploying SkyWalking

| name | description | example |
| ---- | ----------- | ------- |
| `oap.image.tag` | the OAP docker image tag | `10.0.0` |
| `oap.image.tag` | the OAP docker image tag | `10.0.1` |
| `oap.storageType` | the storage type of the OAP | `elasticsearch`, `postgresql`, `banyandb`, etc. |
| `ui.image.tag` | the UI docker image tag | `10.0.0` |
| `ui.image.tag` | the UI docker image tag | `10.0.1` |

You can set these required values via command line (e.g. `--set oap.image.tag=10.0.0 --set oap.storageType=elasticsearch`),
You can set these required values via command line (e.g. `--set oap.image.tag=10.0.1 --set oap.storageType=elasticsearch`),
or edit them in a separate file(e.g. [`values.yaml`](chart/skywalking/values.yaml), [`values-my-es.yaml`](chart/skywalking/values-my-es.yaml))
and use `-f <filename>` or `--values=<filename>` to set them.

Expand All @@ -30,7 +30,7 @@ and use `-f <filename>` or `--values=<filename>` to set them.
Let's set some variables for convenient use later.

```shell
export SKYWALKING_RELEASE_VERSION=4.3.0 # change the release version according to your need
export SKYWALKING_RELEASE_VERSION=4.6.0 # change the release version according to your need
export SKYWALKING_RELEASE_NAME=skywalking # change the release name according to your scenario
export SKYWALKING_RELEASE_NAMESPACE=default # change the namespace to where you want to install SkyWalking
```
Expand All @@ -42,11 +42,28 @@ helm install "${SKYWALKING_RELEASE_NAME}" \
oci://registry-1.docker.io/apache/skywalking-helm \
--version "${SKYWALKING_RELEASE_VERSION}" \
-n "${SKYWALKING_RELEASE_NAMESPACE}" \
--set oap.image.tag=10.0.0 \
--set oap.image.tag=10.0.1 \
--set oap.storageType=elasticsearch \
--set ui.image.tag=10.0.0
--set ui.image.tag=10.0.1
```

To use BanyanDB as storage solution, you can try

```shell
helm install "${SKYWALKING_RELEASE_NAME}" \
oci://registry-1.docker.io/apache/skywalking-helm \
--version "${SKYWALKING_RELEASE_VERSION}" \
-n "${SKYWALKING_RELEASE_NAMESPACE}" \
--set oap.image.tag=10.0.1 \
--set oap.storageType=banyandb \
--set ui.image.tag=10.0.1 \
--set elasticsearch.enabled=false \
--set banyandb.enabled=true \
--set banyandb.image.tag=0.6.1
```

BanyanDB can be configured through various parameters. A comprehensive list of these parameters can be found in the configuration section of the SkyWalking BanyanDB Helm chart repository [https://github.com/apache/skywalking-banyandb-helm?tab=readme-ov-file#configuration]. These parameters allow you to customize aspects such as replication, resource allocation, persistence, and more to suit your specific deployment needs. Remember to prepend 'banyandb.' to all parameter names when applying the settings. For example, `banyandb.image.tag` can be used to specify the version of BanyanDB.

## Install released version using Apache Jfrog Helm repository (<= 4.3.0)

```shell
Expand All @@ -66,22 +83,6 @@ helm repo add elastic https://helm.elastic.co
helm dep up ${REPO}/skywalking
```

To use banyandb as storage solution, you can try

```shell
export REPO=chart
git clone https://github.com/apache/skywalking-helm
cd skywalking-helm
helm install "${SKYWALKING_RELEASE_NAME}" \
${REPO}/skywalking \
-n "${SKYWALKING_RELEASE_NAMESPACE}" \
--set oap.image.tag=10.0.0 \
--set oap.storageType=banyandb \
--set ui.image.tag=10.0.0 \
--set elasticsearch.enabled=false \
--set banyandb.enabled=true
```

## Install development version of SWCK Adapter using master branch

This is needed **only** when you want to install [SWCK Adapter](https://github.com/apache/skywalking-swck/tree/master/adapter) from master branch.
Expand Down Expand Up @@ -127,13 +128,13 @@ specify those configurations, they may take no effect.

here are some examples.

- Deploy SkyWalking 10.0.0
- Deploy SkyWalking 10.0.1

```shell script
helm install "${SKYWALKING_RELEASE_NAME}" ${REPO}/skywalking -n "${SKYWALKING_RELEASE_NAMESPACE}" \
--set oap.image.tag=10.0.0 \
--set oap.image.tag=10.0.1 \
--set oap.storageType=elasticsearch \
--set ui.image.tag=10.0.0
--set ui.image.tag=10.0.1
```

Because ElasticSearch recommends to use the corresponding Helm Chart version of the ElasticSearch version,
Expand All @@ -152,6 +153,7 @@ elasticsearch:
user: "xxx" # [optional]
password: "xxx" # [optional]
```

The same goes for PostgreSQL and BanyanDB.

## Install development version using ghcr.io Helm repository
Expand All @@ -165,9 +167,9 @@ helm -n istio-system install skywalking \
oci://ghcr.io/apache/skywalking-helm/skywalking-helm \
--version "0.0.0-b670c41d94a82ddefcf466d54bab5c492d88d772" \
-n "${SKYWALKING_RELEASE_NAMESPACE}" \
--set oap.image.tag=10.0.0 \
--set oap.image.tag=10.0.1 \
--set oap.storageType=elasticsearch \
--set ui.image.tag=10.0.0
--set ui.image.tag=10.0.1
```

## Install development version using source codes
Expand All @@ -180,7 +182,7 @@ helm install "${SKYWALKING_RELEASE_NAME}" ${REPO}/skywalking -n "${SKYWALKING_RE

## Install a specific version of SkyWalking with an existing database

If you want to use a specific version of elasticsearch as storage solution, for instance, modify the connection information to the existing elasticsearch cluster in file [`values-my-es.yaml`](chart/skywalking/values-my-es.yaml).
If you want to use a specific version of ElasticSearch as storage solution, for instance, modify the connection information to the existing ElasticSearch cluster in file [`values-my-es.yaml`](chart/skywalking/values-my-es.yaml).

```shell script
helm install "${SKYWALKING_RELEASE_NAME}" ${REPO}/skywalking -n "${SKYWALKING_RELEASE_NAMESPACE}" \
Expand Down
Loading