Integrate BanyanDB as storage solution (#126)

apache · Oct 10, 2023 · 1cadd6d · 1cadd6d
1 parent 74de2d7
commit 1cadd6d
Show file tree

Hide file tree

Showing 28 changed files with 402 additions and 74 deletions.
diff --git a/.github/workflows/e2e.ci.yaml b/.github/workflows/e2e.ci.yaml
@@ -27,12 +27,6 @@ on:
 env:
   SKIP_TEST: true
   ISTIO_VERSION: 1.7.1
-  OAP_TAG: cef4f6dcac5b14cd67f51a64ad08052bbc046653
-  OAP_REPO: ghcr.io/apache/skywalking/oap
-  UI_TAG: cef4f6dcac5b14cd67f51a64ad08052bbc046653
-  UI_REPO: ghcr.io/apache/skywalking/ui
-  SATELLITE_TAG: v64f1938e118e95b8d8f50756f666e4777ce6aca2
-  SATELLITE_REPO: ghcr.io/apache/skywalking-satellite/skywalking-satellite
 
 jobs:
   als:
@@ -42,17 +36,20 @@ jobs:
       matrix:
         images:
           - name: recent
-            oap-repo: ghcr.io/apache/skywalking/oap
-            oap-tag: cef4f6dcac5b14cd67f51a64ad08052bbc046653
-            ui-repo: ghcr.io/apache/skywalking/ui
-            ui-tag: cef4f6dcac5b14cd67f51a64ad08052bbc046653
+        test:
+          - name: Run Skywalking E2E Test (Elasticsearch as database)
+            config: test/e2e/e2e-elasticsearch.yaml
+          - name: Run Skywalking E2E Test (BanyanDB as database)
+            config: test/e2e/e2e-banyandb.yaml
+          - name: Run SWCK E2E Test
+            config: test/e2e/swck/e2e.yaml
     name: Istio+Envoy Access Log Service(${{ matrix.images.name }})
     env:
-      OAP_TAG: ${{ matrix.images.oap-tag }}
-      OAP_REPO: ${{ matrix.images.oap-repo }}
-      UI_TAG: ${{ matrix.images.ui-tag }}
-      UI_REPO: ${{ matrix.images.ui-repo }}
-      SATELLITE_TAG: v64f1938e118e95b8d8f50756f666e4777ce6aca2
+      OAP_TAG: 14fbd975be077082ed6fa604e05479dd9af0d995
+      OAP_REPO: ghcr.io/apache/skywalking/oap
+      UI_TAG: 14fbd975be077082ed6fa604e05479dd9af0d995
+      UI_REPO: ghcr.io/apache/skywalking/ui
+      SATELLITE_TAG: v35bfaff6352b4dc351a706772796a1f79b651c14
       SATELLITE_REPO: ghcr.io/apache/skywalking-satellite/skywalking-satellite
     steps:
       - uses: actions/checkout@v2
@@ -63,17 +60,13 @@ jobs:
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
       - name: Setup go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v4
         with:
-          go-version: '1.16'
-      - name: Run Skywalking E2E Test
+          go-version: '1.20'
+      - name: ${{ matrix.test.name }}
         uses: apache/skywalking-infra-e2e@45584853d6f660102c523b1e9cb5815d12ae55d3
         with:
-          e2e-file: $GITHUB_WORKSPACE/test/e2e/e2e.yaml
-      - name: Run SWCK E2E Test
-        uses: apache/skywalking-infra-e2e@afdf1cca0519d65bc480d8680b7a27f9b41fc421
-        with:
-          e2e-file: $GITHUB_WORKSPACE/test/e2e/swck/e2e.yaml
+          e2e-file: $GITHUB_WORKSPACE/${{ matrix.test.config }}
       - if: ${{ failure() }}
         run: |
           df -h

diff --git a/CHANGES.md b/CHANGES.md
@@ -2,6 +2,12 @@ Changes by Version
 ==================
 Release Notes.
 
+4.6.0
+------------------
+
+- Integrate BanyanDB as storage solution
+- Bump up swck to v0.8.0
+
 4.5.0
 ------------------
 

diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ There are required values that you must set explicitly when deploying SkyWalking
 | name | description | example |
 | ---- | ----------- | ------- |
 | `oap.image.tag` | the OAP docker image tag | `9.2.0` |
-| `oap.storageType` | the storage type of the OAP | `elasticsearch`, `postgresql`, etc. |
+| `oap.storageType` | the storage type of the OAP | `elasticsearch`, `postgresql`, `banyandb`, etc. |
 | `ui.image.tag` | the UI docker image tag | `9.2.0` |
 
 You can set these required values via command line (e.g. `--set oap.image.tag=9.2.0 --set oap.storageType=elasticsearch`),
@@ -66,6 +66,22 @@ 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=9.5.0 \
+  --set oap.storageType=banyandb \
+  --set ui.image.tag=9.5.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. 
@@ -136,6 +152,7 @@ elasticsearch:
     user: "xxx"         # [optional]
     password: "xxx"     # [optional]
 ```
+The same goes for PostgreSQL and BanyanDB.
 
 ## Install development version using ghcr.io Helm repository
 
@@ -161,9 +178,9 @@ This is needed **only** when you want to install source codes.
 helm install "${SKYWALKING_RELEASE_NAME}" ${REPO}/skywalking -n "${SKYWALKING_RELEASE_NAMESPACE}" 
 ```
 
-## Install a specific version of SkyWalking with an existing Elasticsearch
+## Install a specific version of SkyWalking with an existing database
 
-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}" \

diff --git a/chart/adapter/Chart.yaml b/chart/adapter/Chart.yaml
@@ -16,7 +16,7 @@
 apiVersion: v2
 name: skywalking-helm-swck-adapter
 home: https://github.com/apache/skywalking-swck/tree/master/adapter
-version: 0.7.0
+version: 0.8.0
 description: Provide custom metrics coming from SkyWalking OAP cluster for autoscaling by Kubernetes HPA
 icon: https://raw.githubusercontent.com/apache/skywalking-kubernetes/master/logo/sw-logo-for-chart.jpg
 sources:

diff --git a/chart/adapter/README.md b/chart/adapter/README.md
@@ -45,7 +45,7 @@ The following table lists the configurable parameters of the adapter chart and t
 | `.serviceAccountName`              | The service account name of adapter                                       | `skywalking-custom-metrics-apiserver` |
 | `.image.repository` | Adapter container image name                | `docker.io/apache/skywalking-swck` |
 | `.image.pullPolicy`               | Adapter container image pull policy                              | `IfNotPresent`                  |
-| `.image.tag`             | Adapter container image tag                    | `v0.7.0` |
+| `.image.tag`             | Adapter container image tag                    | `v0.8.0` |
 | `.service.port`                           | The port for the adapter service                                 | `6.1.0`                              |
 | `.oap.service.name`          | The service name of OAP                                 | `skywalking-system-oap`  |
 | `.oap.service.namespace`                | The service namespace of OAP                          | `skywalking-system`             |

diff --git a/chart/adapter/values.yaml b/chart/adapter/values.yaml
@@ -23,7 +23,7 @@ serviceAccountName: skywalking-custom-metrics-apiserver
 image:
   repository: docker.io/apache/skywalking-swck
   pullPolicy: IfNotPresent
-  tag: "v0.7.0"
+  tag: "v0.8.0"
 service:
   port: 6443
 oap:

diff --git a/chart/operator/Chart.yaml b/chart/operator/Chart.yaml
@@ -16,7 +16,7 @@
 apiVersion: v2
 name: skywalking-helm-swck-operator
 home: https://github.com/apache/skywalking-swck/tree/master/operator
-version: 0.7.0
+version: 0.8.0
 description: Provision and maintain SkyWalking backend components
 icon: https://raw.githubusercontent.com/apache/skywalking-kubernetes/master/logo/sw-logo-for-chart.jpg
 sources:

diff --git a/chart/operator/README.md b/chart/operator/README.md
@@ -44,7 +44,7 @@ The following table lists the configurable parameters of the operator chart and
 | `.serviceAccountName`        | The service account name of operator                                                                                         | `skywalking-swck-controller-manager` |
 | `.image.repository`          | Operator container image name                                                                                                | `docker.io/apache/skywalking-swck`   |
 | `.image.pullPolicy`          | Operator container image pull policy                                                                                         | `IfNotPresent`                       |
-| `.image.tag`                 | Operator container image tag                                                                                                 | `v0.7.0`                             |
+| `.image.tag`                 | Operator container image tag                                                                                                 | `v0.8.0`                             |
 | `.metrics.service.port`      | The port for the operator metrics service                                                                                    | `8443`                               |
 | `.webhook.service.port`      | The port for the operator web hook service                                                                                   | `9443`                               |
 | `.resources.limits.cpu`      | The limits of cpu in the operator                                                                                            | `200m`                               |

diff --git a/chart/operator/templates/crds.yaml b/chart/operator/templates/crds.yaml
@@ -19,7 +19,7 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     cert-manager.io/inject-ca-from: {{ .Release.Namespace }}/{{ include "operator.fullname" . | trunc (int (sub 63 (len "-serving-cert"))) | printf "%s-serving-cert" }} 
-    controller-gen.kubebuilder.io/version: v0.7.0
+    controller-gen.kubebuilder.io/version: v0.8.0
   name: fetchers.operator.skywalking.apache.org
 spec:
   conversion:
@@ -131,7 +131,7 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     cert-manager.io/inject-ca-from: {{ .Release.Namespace }}/{{ include "operator.fullname" . | trunc (int (sub 63 (len "-serving-cert"))) | printf "%s-serving-cert" }} 
-    controller-gen.kubebuilder.io/version: v0.7.0
+    controller-gen.kubebuilder.io/version: v0.8.0
   name: javaagents.operator.skywalking.apache.org
 spec:
   conversion:
@@ -237,7 +237,7 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     cert-manager.io/inject-ca-from: {{ .Release.Namespace }}/{{ include "operator.fullname" . | trunc (int (sub 63 (len "-serving-cert"))) | printf "%s-serving-cert" }} 
-    controller-gen.kubebuilder.io/version: v0.7.0
+    controller-gen.kubebuilder.io/version: v0.8.0
   name: oapserverconfigs.operator.skywalking.apache.org
 spec:
   conversion:
@@ -453,7 +453,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.7.0
+    controller-gen.kubebuilder.io/version: v0.8.0
   creationTimestamp: null
   name: oapserverdynamicconfigs.operator.skywalking.apache.org
 spec:
@@ -550,7 +550,7 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     cert-manager.io/inject-ca-from: {{ .Release.Namespace }}/{{ include "operator.fullname" . | trunc (int (sub 63 (len "-serving-cert"))) | printf "%s-serving-cert" }} 
-    controller-gen.kubebuilder.io/version: v0.7.0
+    controller-gen.kubebuilder.io/version: v0.8.0
   name: oapservers.operator.skywalking.apache.org
 spec:
   conversion:
@@ -1118,7 +1118,7 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     cert-manager.io/inject-ca-from: {{ .Release.Namespace }}/{{ include "operator.fullname" . | trunc (int (sub 63 (len "-serving-cert"))) | printf "%s-serving-cert" }} 
-    controller-gen.kubebuilder.io/version: v0.7.0
+    controller-gen.kubebuilder.io/version: v0.8.0
   name: satellites.operator.skywalking.apache.org
 spec:
   conversion:
@@ -1463,7 +1463,7 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     cert-manager.io/inject-ca-from: {{ .Release.Namespace }}/{{ include "operator.fullname" . | trunc (int (sub 63 (len "-serving-cert"))) | printf "%s-serving-cert" }} 
-    controller-gen.kubebuilder.io/version: v0.7.0
+    controller-gen.kubebuilder.io/version: v0.8.0
   name: storages.operator.skywalking.apache.org
 spec:
   conversion:
@@ -1721,7 +1721,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.7.0
+    controller-gen.kubebuilder.io/version: v0.8.0
   creationTimestamp: null
   name: swagents.operator.skywalking.apache.org
 spec:
@@ -1981,7 +1981,7 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     cert-manager.io/inject-ca-from: {{ .Release.Namespace }}/{{ include "operator.fullname" . | trunc (int (sub 63 (len "-serving-cert"))) | printf "%s-serving-cert" }} 
-    controller-gen.kubebuilder.io/version: v0.7.0
+    controller-gen.kubebuilder.io/version: v0.8.0
   name: uis.operator.skywalking.apache.org
 spec:
   conversion:

diff --git a/chart/operator/values.yaml b/chart/operator/values.yaml
@@ -23,7 +23,7 @@ serviceAccountName: skywalking-swck-controller-manager
 image:
   repository: docker.io/apache/skywalking-swck
   pullPolicy: IfNotPresent
-  tag: "v0.7.0"
+  tag: "v0.8.0"
 securityContext:
   allowPrivilegeEscalation: false
 metrics:

diff --git a/chart/skywalking/Chart.yaml b/chart/skywalking/Chart.yaml
@@ -38,3 +38,7 @@ dependencies:
     version: 12.1.2
     repository: https://raw.githubusercontent.com/bitnami/charts/archive-full-index/bitnami
     condition: postgresql.enabled
+  - name: skywalking-banyandb-helm
+    version: 0.1.0
+    repository: oci://registry-1.docker.io/apache
+    condition: banyandb.enabled
diff --git a/chart/skywalking/templates/_helpers.tpl b/chart/skywalking/templates/_helpers.tpl
@@ -115,6 +115,15 @@ Create the name of the service account to use for the satellite cluster
         echo "Waiting for postgresql..."
         sleep 3
       done
+{{- else if eq .Values.oap.storageType "banyandb" -}}
+{{- $banyandbHost := "banyandb-http" -}}
+{{- if not .Values.banyandb.enabled -}}
+{{- $banyandbHost = .Values.banyandb.config.httpHost -}}
+{{- end }}
+- name: wait-for-banyandb
+  image: curlimages/curl
+  imagePullPolicy: IfNotPresent
+  command: ['sh', '-c', 'for i in $(seq 1 60); do curl {{ $banyandbHost }}:{{ .Values.banyandb.config.httpPort }}/api/healthz && exit 0 || sleep 5; done; exit 1']
 {{- end }}
 {{- end -}}
 
@@ -150,5 +159,14 @@ Create the name of the service account to use for the satellite cluster
   value: "{{ .Values.postgresql.auth.username }}"
 - name: SW_DATA_SOURCE_PASSWORD
   value: "{{ .Values.postgresql.auth.password }}"
+{{- else if eq .Values.oap.storageType "banyandb" }}
+{{- $banyandbHost := "banyandb-grpc" -}}
+{{- if not .Values.banyandb.enabled -}}
+{{- $banyandbHost = .Values.banyandb.config.grpcHost -}}
+{{- end }}
+- name: SW_STORAGE_BANYANDB_HOST
+  value: "{{ $banyandbHost }}"
+- name: SW_STORAGE_BANYANDB_PORT
+  value: "{{ .Values.banyandb.config.grpcPort }}"
 {{- end }}
 {{- end -}}
diff --git a/chart/skywalking/values.yaml b/chart/skywalking/values.yaml
@@ -444,6 +444,14 @@ postgresql:
     persistence:
       enabled: false
 
+banyandb:
+  enabled: false
+  config:
+    grpcHost: banyandb-grpc
+    httpHost: banyandb-http
+    grpcPort: 17912
+    httpPort: 17913
+
 satellite:
   name: satellite
   replicas: 1