[Feature] Add BanyanDB CRD & Controllers by SzyWilliam · Pull Request #70 · apache/skywalking-swck

SzyWilliam · 2022-07-29T03:34:25Z

Original Issue

apache/skywalking#9396

What changes brought in this PR

In this PR, I add CRD for BanyanDB.

Use StatefulSet as BanyanDB's underlying controller, so that we can benefit from its stable network identifiers or storage, plus future extensions.
Use Service as BanyanDB's networking identifier for internal access & communication.
Use LocalPV as BanyanDB's default storage choice.

wu-sheng · 2022-07-29T04:09:57Z

I can't see an e2e to verify this.
SWCK should be verified whether it really could deploy.

operator/apis/operator/v1alpha1/banyandb_types.go

dashanji · 2022-07-29T04:47:30Z

@wu-sheng @lujiajing1126 This is a draft pr for the osapp project. The student @SzyWilliam should still be coding, but I'm not familiar with some features of Banyandb, so could you please confirm whether the Spec field can meet all the current banyandb requirements?

wu-sheng · 2022-07-29T05:32:11Z

Then this PR should be labeled aa draft or use issue or discussion panel to talk.
PR could trigger mail notifications for reviewers.

wu-sheng · 2022-07-29T05:32:34Z

BTW, I think you ping a wrong people.

operator/apis/operator/v1alpha1/banyandb_types.go

hanahmily · 2022-07-29T10:21:45Z

operator/apis/operator/v1alpha1/banyandb_types.go

+
+	// BanyanDB Storage
+	// +kubebuilder:validation:Optional
+	Storage corev1.PersistentVolumeClaim `json:"storage,omitempty"`


It should be an array. BanyanDB support placing files into separate storage.

hanahmily · 2022-07-29T10:22:54Z

operator/apis/operator/v1alpha1/banyandb_types.go

+	State BanyanDBState `json:"state,omitempty"`
+	// Represents the latest available observations of the underlying statefulset's current state.
+	// +kubebuilder:validation:Optional
+	Conditions []appsv1.StatefulSetCondition `json:"conditions,omitempty"`


Deployment is good to me.

operator/apis/operator/v1alpha1/banyandb_types.go

hanahmily · 2022-07-29T10:42:16Z

operator/apis/operator/v1alpha1/banyandb_types.go

+
+const (
+	Ready BanyanDBState = iota
+	Reconciling


Could you elaborate on Reconciling? Add more comments to all states.

I've deleted this field.

lujiajing1126 · 2022-07-29T05:50:41Z

operator/apis/operator/v1alpha1/banyandb_types.go

+	Storage corev1.PersistentVolumeClaim `json:"storage,omitempty"`
+}
+
+type BanyanDBState int8


string is much better for readability and inspection

I've deleted this BanyanDBState

lujiajing1126 · 2022-07-29T05:57:47Z

operator/apis/operator/v1alpha1/banyandb_types.go

+
+	// BanyanDB Storage
+	// +kubebuilder:validation:Optional
+	Storage corev1.PersistentVolumeClaim `json:"storage,omitempty"`


We only need *corev1.PersistentVolumeClaimSpec here?

Have to support multi-storages, the type could be []corev1.PersistentVolumeClaim

lujiajing1126 · 2022-07-29T12:14:05Z

@wu-sheng @lujiajing1126 This is a draft pr for the osapp project. The student @SzyWilliam should still be coding, but I'm not familiar with some features of Banyandb, so could you please confirm whether the Spec field can meet all the current banyandb requirements?

As I understand, since the current version of BanyanDB only has a single node, Deployment can meet our requirement.

The operator for VictoriaMetrics and its VMSingle CRD can be a good reference for us.

operator/apis/operator/v1alpha1/banyandb_types.go

SzyWilliam · 2022-07-29T12:23:02Z

As I understand, since the current version of BanyanDB only has a single node, Deployment can meet our requirement.
@lujiajing1126 Thanks for your reply! If we consider future extensions, a StatefulSet will be great for a BanyanDB cluster since it provides bindings on pv & network identifier. Why don't we use StatefulSet now?

lujiajing1126 · 2022-07-29T12:53:50Z

@lujiajing1126 Thanks for your reply! If we consider future extensions, a StatefulSet will be great for a BanyanDB cluster since it provides bindings on pv & network identifier. Why don't we use StatefulSet now?

Actually, I'm neutral about the choice. I would just say Deployment is definitely much simpler and thus has lower cost. The cluster version is on our roadmap but with very few details. It is not possible for us now to cover all what we need in the future.

hanahmily · 2022-07-29T13:20:07Z

Deployment is better here. The cluster mode will know each node's roles, we don't leverage statefulset to get stable and ordered network endpoints and pv.

SzyWilliam · 2022-09-07T06:15:46Z

@dashanji @hanahmily @lujiajing1126 Hi, I've completed a minimal working BanyanDB CRD&Controller for SWCK. It passes e2e tests. Please take a look at this, thanks!
There are still some advanced features to be added, like TLS config for banyandb. I plan to add these features in future PRs.

SzyWilliam · 2022-09-20T07:19:18Z

@dashanji Thanks for your reviews! I've completed the full banyandb crd & controller implementation with corresponding e2e tests. @wu-sheng @hanahmily @lujiajing1126 Please take a look at it~🫰

hanahmily

You have to expose the HTTP port and add a new HTTP-based service.

The HTTP service should support the ingress to route traffic to it.

operator/pkg/operator/manifests/banyandb/templates/deployment.yaml

hanahmily · 2022-09-20T07:18:40Z

operator/pkg/operator/manifests/banyandb/templates/cluster_role.yaml

+# specific language governing permissions and limitations
+# under the License.
+
+kind: ClusterRole


Why do we need this role since the server doesn't touch the API server?

Done. I have removed ClusterRole & ClusterRoleBinding

operator/apis/operator/v1alpha1/banyandb_types.go

…ng-swck into banyandb_crd

SzyWilliam · 2022-09-21T05:54:16Z

@hanahmily Thanks for the reviews! I've exposed HTTP port and added an ingress resource to route HTTP requests, PTAL. I have a question: according to banyandb github page, we do not support http server for now. Does banyandb support HTTP server now? If so, how I can query data using HTTP?

hanahmily · 2022-09-21T06:27:28Z

we do not support http server for now. Does banyandb support HTTP server now?

We supported the HTTP server in the main branch. It will be released in v0.2.0.

If so, how I can query data using HTTP?

bydbctl will take it. The primitive commands will be released in v0.2.0 with the HTTP server.

And you could access the HTTP endpoint directly. The API specifications are at https://github.com/apache/skywalking-banyandb/blob/main/api/proto/openapi

hanahmily

Please add a new service to serve HTTP/17913

operator/apis/operator/v1alpha1/banyandb_types.go

operator/pkg/operator/manifests/banyandb/templates/service.yaml

operator/pkg/operator/manifests/banyandb/templates/ingress.yaml

SzyWilliam · 2022-09-21T06:57:06Z

@hanahmily Thanks for the reply and providing framework on Service. I'll use separate gRPC Service and HTTP service. I plan to use bydbctl to verify banyandb data storage in E2E Tests after 0.2.0 release, so I'll just add a todo for now.

SzyWilliam · 2022-09-22T09:39:28Z

I've made changes on code:

separate grpc & http into two service resources, expose 17912/17913 respectively.
remove unused ports 2121 6060.
@hanahmily Please take a look at it again, thanks!

hanahmily

LGTM @SzyWilliam @dashanji Great job!

wu-sheng · 2022-09-23T01:15:33Z

It is great to see this PR is getting ready after months of work. Congrats.

dashanji

LGTM!

wu-sheng · 2022-09-23T04:31:42Z

@lujiajing1126 We need your confirmation here. Please recheck.

lujiajing1126 · 2022-09-23T05:39:08Z

operator/controllers/operator/banyandb_controller.go

+		overlay.AvailableReplicas = deployment.Status.AvailableReplicas
+	}
+	if apiequal.Semantic.DeepDerivative(overlay, banyanDB.Status) {
+		log.Info("Status keeps the same as before")


I think we have to return here to avoid unexpected reconciliation? @dashanji

Make sense. We could return here to avoid update the same resources. Thanks for the catching, and the other controllers have the same questions. Could you please update them together ? @SzyWilliam

SzyWilliam · 2022-09-24T01:56:09Z

@lujiajing1126 Thanks for the careful review! I've made changes on code, please take a look again.

lujiajing1126

LGTM. Thanks for your contribution!

wu-sheng requested a review from hanahmily July 29, 2022 04:09

lujiajing1126 requested changes Jul 29, 2022

View reviewed changes

operator/apis/operator/v1alpha1/banyandb_types.go Show resolved Hide resolved

operator/apis/operator/v1alpha1/banyandb_types.go Show resolved Hide resolved

SzyWilliam marked this pull request as draft July 29, 2022 05:33

hanahmily requested changes Jul 29, 2022

View reviewed changes

lujiajing1126 requested changes Jul 29, 2022

View reviewed changes

lujiajing1126 reviewed Jul 29, 2022

View reviewed changes

operator/apis/operator/v1alpha1/banyandb_types.go Show resolved Hide resolved

SzyWilliam added 2 commits August 17, 2022 11:38

add banyandb crd

79fe373

add template and controller

28852fa

SzyWilliam force-pushed the banyandb_crd branch from ee6444c to 28852fa Compare August 17, 2022 03:40

SzyWilliam added 3 commits August 25, 2022 10:09

add update status logic in reconciler

5a56b53

add banyandb crd

c1a0114

merge master

9c83573

SzyWilliam force-pushed the banyandb_crd branch from 808b080 to 9c83573 Compare August 25, 2022 04:54

SzyWilliam added 3 commits September 6, 2022 10:57

add e2e tests

628f687

revise e2e tests

f5e326c

add banyandb CI

4b324c1

SzyWilliam force-pushed the banyandb_crd branch 2 times, most recently from 329d794 to 4b324c1 Compare September 7, 2022 03:08

SzyWilliam added 2 commits September 7, 2022 11:09

merge master

7b8cc6c

make generate

63edf5c

SzyWilliam marked this pull request as ready for review September 7, 2022 06:08

SzyWilliam requested review from hanahmily and lujiajing1126 and removed request for hanahmily and lujiajing1126 September 20, 2022 07:14

hanahmily requested changes Sep 20, 2022

View reviewed changes

hanahmily and others added 3 commits September 20, 2022 15:25

Merge branch 'master' into banyandb_crd

153a585

delete clusterrole & add ingress

f31fa97

Merge branch 'banyandb_crd' of https://github.com/SzyWilliam/skywalki…

45652f7

…ng-swck into banyandb_crd

SzyWilliam dismissed dashanji’s stale review via 45652f7 September 21, 2022 05:50

hanahmily requested changes Sep 21, 2022

View reviewed changes

seperate grpc & http service

518d8a1

hanahmily previously approved these changes Sep 23, 2022

View reviewed changes

wu-sheng requested a review from dashanji September 23, 2022 01:15

dashanji previously approved these changes Sep 23, 2022

View reviewed changes

lujiajing1126 requested changes Sep 23, 2022

View reviewed changes

return directly when status is the same

fbd2742

SzyWilliam dismissed stale reviews from dashanji and hanahmily via fbd2742 September 24, 2022 01:55

lujiajing1126 approved these changes Sep 24, 2022

View reviewed changes

wu-sheng merged commit d125f2e into apache:master Sep 24, 2022

dashanji mentioned this pull request Nov 17, 2022

[Feature] [SWCK] Add doc for BanyanDB CRD and Controller apache/skywalking#9981

Open

3 tasks

Comments

Conversation

SzyWilliam commented Jul 29, 2022

Original Issue

What changes brought in this PR

Uh oh!

wu-sheng commented Jul 29, 2022

Uh oh!

Uh oh!

Uh oh!

dashanji commented Jul 29, 2022 • edited by Superskyyy Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wu-sheng commented Jul 29, 2022

Uh oh!

wu-sheng commented Jul 29, 2022

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lujiajing1126 commented Jul 29, 2022

Uh oh!

Uh oh!

SzyWilliam commented Jul 29, 2022

Uh oh!

lujiajing1126 commented Jul 29, 2022

Uh oh!

hanahmily commented Jul 29, 2022

Uh oh!

SzyWilliam commented Sep 7, 2022

Uh oh!

SzyWilliam commented Sep 20, 2022

Uh oh!

hanahmily left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

SzyWilliam commented Sep 21, 2022

Uh oh!

hanahmily commented Sep 21, 2022

Uh oh!

hanahmily left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SzyWilliam commented Sep 21, 2022

Uh oh!

SzyWilliam commented Sep 22, 2022

Uh oh!

hanahmily left a comment

dashanji commented Jul 29, 2022 •

edited by Superskyyy

Loading

lujiajing1126 Sep 23, 2022 •

edited

Loading