You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by ha...@apache.org on 2026/08/24 08:28:31 UTC

(skywalking-banyandb) branch main updated: feat: advertise BanyanDB API version 0.11 (#1303)

This is an automated email from the ASF dual-hosted git repository.

hanahmily pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-banyandb.git


The following commit(s) were added to refs/heads/main by this push:
     new 3b83e18fb feat: advertise BanyanDB API version 0.11 (#1303)
3b83e18fb is described below

commit 3b83e18fb0481d02e44eaa5df137fcf7b000754b
Author: Gao Hongtao <ha...@gmail.com>
AuthorDate: Mon Aug 24 16:28:25 2026 +0800

    feat: advertise BanyanDB API version 0.11 (#1303)
---
 CHANGES.md                                         |  3 +++
 api/proto/banyandb/version.go                      |  4 ++--
 .../liaison/grpc/api_version_test.go               | 25 +++++++++++++---------
 banyand/queue/pub/chunked_sync_test.go             |  2 ++
 banyand/queue/pub/message_to_request_test.go       |  2 ++
 docs/operation/upgrade.md                          | 16 ++++++++++++++
 test/e2e-v2/cases/fodc/oap.yaml                    |  2 +-
 .../process/istio/banyandb/values-banyandb.yaml    |  1 +
 test/e2e-v2/script/docker-compose/base-compose.yml |  2 +-
 9 files changed, 43 insertions(+), 14 deletions(-)

diff --git a/CHANGES.md b/CHANGES.md
index c6e675900..11bee928e 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -5,6 +5,9 @@ Release Notes.
 ## 0.11.0
 
 ### Features
+- **Breaking Change**: Upgrade the API version to 0.11 for the schema revision fields and `SchemaBarrierService`
+  operations added in this release. External clients and internal node communication must use API 0.11; mixed BanyanDB
+  0.10 and 0.11 clusters are not supported.
 - Add batch-write phase metrics for client-held-open time, post-seal admission time, and admission deadlines, plus per-part liaison-wqueue-to-data-node file-sync latency for measure, stream, and trace.
 - Add bounded trace plugin overhead metrics: chain decision batches by result, per-plugin execution count and duration, batch trace-count distribution, and per-plugin fail-open bypasses by reason. The configured `plugin_name` distinguishes links in a multi-plugin chain; segment, shard, and schema labels remain absent. The catalog works with `pipeline_traces_evaluated` for per-plugin time/calls per trace, latency percentiles, timeout/circuit-open rates, and link-health monitoring. The Pha [...]
 - Add trace **finalization sampling** (`PIPELINE_EVENT_FINALIZE`), a best-effort background backstop for the in-merge trace retention filter. A single node-wide, concurrency-1 scanner periodically sweeps cooled segments (`segEnd < now − finalize_grace`, reopening idle-closed segments via `SelectSegments(reopenClosed=true)`) and force-merges each shard's un-finalized parts through the group's registered sampler chain, reusing the hot merge path (`mergeParts` + per-sidx `Merge` + the shard [...]
diff --git a/api/proto/banyandb/version.go b/api/proto/banyandb/version.go
index 4ce532be3..18451925e 100644
--- a/api/proto/banyandb/version.go
+++ b/api/proto/banyandb/version.go
@@ -18,8 +18,8 @@
 // Package apiversion contains the version of the API.
 package apiversion
 
-// Version is the version of the API.
-const Version = "0.10"
+// Version is the API version used by external clients and internal node communication.
+const Version = "0.11"
 
 // Revision is the revision of the API. Building with -ldflags -X.
 var revision string
diff --git a/api/proto/banyandb/version.go b/banyand/liaison/grpc/api_version_test.go
similarity index 57%
copy from api/proto/banyandb/version.go
copy to banyand/liaison/grpc/api_version_test.go
index 4ce532be3..609506b92 100644
--- a/api/proto/banyandb/version.go
+++ b/banyand/liaison/grpc/api_version_test.go
@@ -11,20 +11,25 @@
 // Unless required by applicable law or agreed to in writing,
 // software distributed under the License is distributed on an
 // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied.  See the License for the
+// KIND, either express or implied. See the License for the
 // specific language governing permissions and limitations
 // under the License.
 
-// Package apiversion contains the version of the API.
-package apiversion
+package grpc
 
-// Version is the version of the API.
-const Version = "0.10"
+import (
+	"context"
+	"testing"
 
-// Revision is the revision of the API. Building with -ldflags -X.
-var revision string
+	commonv1 "github.com/apache/skywalking-banyandb/api/proto/banyandb/common/v1"
+)
 
-// GetRevision returns the revision of the API.
-func GetRevision() string {
-	return revision
+func TestGetAPIVersion(t *testing.T) {
+	response, err := (&apiVersionService{}).GetAPIVersion(context.Background(), &commonv1.GetAPIVersionRequest{})
+	if err != nil {
+		t.Fatalf("GetAPIVersion returned an error: %v", err)
+	}
+	if response.GetVersion().GetVersion() != "0.11" {
+		t.Fatalf("expected public API version 0.11, got %s", response.GetVersion().GetVersion())
+	}
 }
diff --git a/banyand/queue/pub/chunked_sync_test.go b/banyand/queue/pub/chunked_sync_test.go
index b5f8e9cb1..ee9cea1d1 100644
--- a/banyand/queue/pub/chunked_sync_test.go
+++ b/banyand/queue/pub/chunked_sync_test.go
@@ -31,6 +31,7 @@ import (
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
 
+	apiversion "github.com/apache/skywalking-banyandb/api/proto/banyandb"
 	clusterv1 "github.com/apache/skywalking-banyandb/api/proto/banyandb/cluster/v1"
 	"github.com/apache/skywalking-banyandb/banyand/queue"
 	"github.com/apache/skywalking-banyandb/pkg/bytes"
@@ -336,6 +337,7 @@ var _ = ginkgo.Describe("Chunked Sync Retry Mechanism", func() {
 			// Find where part 2 appears in chunks
 			var part2FirstChunkIdx, part2LastChunkIdx int = -1, -1
 			for idx, chunk := range receivedChunks {
+				gomega.Expect(chunk.GetVersionInfo().GetApiVersion()).To(gomega.Equal(apiversion.Version))
 				if chunk.GetCompletion() != nil {
 					continue
 				}
diff --git a/banyand/queue/pub/message_to_request_test.go b/banyand/queue/pub/message_to_request_test.go
index 2ab1586f9..eb7dd0bff 100644
--- a/banyand/queue/pub/message_to_request_test.go
+++ b/banyand/queue/pub/message_to_request_test.go
@@ -23,6 +23,7 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/apache/skywalking-banyandb/api/data"
+	apiversion "github.com/apache/skywalking-banyandb/api/proto/banyandb"
 	commonv1 "github.com/apache/skywalking-banyandb/api/proto/banyandb/common/v1"
 	streamv1 "github.com/apache/skywalking-banyandb/api/proto/banyandb/stream/v1"
 	"github.com/apache/skywalking-banyandb/pkg/bus"
@@ -43,6 +44,7 @@ func TestMessageToRequestGroup(t *testing.T) {
 		require.NoError(t, err)
 		require.Equal(t, "stream-group", r.GetGroup())
 		require.NotNil(t, r.GetBody())
+		require.Equal(t, apiversion.Version, r.GetVersionInfo().GetApiVersion())
 	})
 
 	t.Run("byte payload carries explicit group", func(t *testing.T) {
diff --git a/docs/operation/upgrade.md b/docs/operation/upgrade.md
index 3b3a6e724..dff997afe 100644
--- a/docs/operation/upgrade.md
+++ b/docs/operation/upgrade.md
@@ -59,6 +59,22 @@ If you don't have enough resource to perform a rolling upgrade or you have a lar
 
 This section describes breaking changes and important behavioral changes when upgrading to BanyanDB 0.11.0.
 
+### API version 0.11
+
+BanyanDB 0.11 uses API version `0.11` for external clients and internal node communication. A cluster containing both
+BanyanDB 0.10 and 0.11 nodes is not supported.
+
+Use a maintenance window for this upgrade:
+
+1. Stop writes and all other BanyanDB API clients.
+2. Stop all BanyanDB 0.10 nodes.
+3. Upgrade and start all BanyanDB nodes at 0.11.
+4. Upgrade API clients to require version 0.11, then start them.
+5. Verify schema initialization and ingestion before restoring normal traffic.
+
+**Rollback.** Stop all clients and BanyanDB nodes before restoring the previous versions. Do not run a mixed 0.10/0.11
+BanyanDB cluster during rollback.
+
 ### Vectorized query paths enabled by default (breaking for rolling upgrades)
 
 The vectorized **stream** and **trace** query paths are now enabled by default, joining **measure** (default-on since 0.10). `--stream-vectorized-enabled`, `--trace-vectorized-enabled` and `--measure-vectorized-enabled` all default to `true`.
diff --git a/test/e2e-v2/cases/fodc/oap.yaml b/test/e2e-v2/cases/fodc/oap.yaml
index a11e55fb6..6fde3cdfd 100644
--- a/test/e2e-v2/cases/fodc/oap.yaml
+++ b/test/e2e-v2/cases/fodc/oap.yaml
@@ -61,7 +61,7 @@ spec:
             - name: SW_STORAGE_BANYANDB_TARGETS
               value: "liaison:17912"
             - name: SW_STORAGE_BANYANDB_COMPATIBLE_SERVER_API_VERSIONS
-              value: "0.10"
+              value: "0.11"
             - name: SW_HEALTH_CHECKER
               value: default
             - name: SW_TELEMETRY
diff --git a/test/e2e-v2/cases/rover/process/istio/banyandb/values-banyandb.yaml b/test/e2e-v2/cases/rover/process/istio/banyandb/values-banyandb.yaml
index 9aa27c329..98ec8af4f 100644
--- a/test/e2e-v2/cases/rover/process/istio/banyandb/values-banyandb.yaml
+++ b/test/e2e-v2/cases/rover/process/istio/banyandb/values-banyandb.yaml
@@ -27,3 +27,4 @@ oap:
   storageType: banyandb
   env:
     SW_STORAGE_BANYANDB_TARGETS: "banyandb:17912"
+    SW_STORAGE_BANYANDB_COMPATIBLE_SERVER_API_VERSIONS: "0.11"
diff --git a/test/e2e-v2/script/docker-compose/base-compose.yml b/test/e2e-v2/script/docker-compose/base-compose.yml
index 00064c219..70c43e7e5 100644
--- a/test/e2e-v2/script/docker-compose/base-compose.yml
+++ b/test/e2e-v2/script/docker-compose/base-compose.yml
@@ -56,7 +56,7 @@ services:
       file: ../../../docker/base-compose.yml
       service: oap
     environment:
-      SW_STORAGE_BANYANDB_COMPATIBLE_SERVER_API_VERSIONS: "0.10"
+      SW_STORAGE_BANYANDB_COMPATIBLE_SERVER_API_VERSIONS: "0.11"
     networks:
       - e2e
     volumes: