Skip to content

Complete user and operator documentation for BanyanDB 0.10.0 #13777

@hanahmily

Description

@hanahmily

Summary

Finish the user and operator documentation for BanyanDB 0.10.0, aligned with the major changes shipped since 0.9.0. Goal: operators and integrators can adopt 0.10 without relying only on CHANGES.md or generated API reference.

Scope

Document what changed, how to configure and operate it, and breaking / migration notes where applicable. Prefer updates to existing guides (docs/ in skywalking-banyandb, published with the project) over duplicating protobuf field lists.

Major 0.10.0 themes to cover

  • MCP — setup, security, and when to use it
  • Distributed measure aggregation — map on data nodes, reduce on liaison; behavior and tuning at a high level
  • Property sorted queries — API and BydbQL
  • Writes with specifications — stream/trace (and related TopN / spec handling); criteria tags no longer required in projection
  • Liaison sync + series metadata — what it means for ops; dump / smeta where users inspect on-disk data
  • Snapshot minimum-age retention — semantics and configuration
  • Group deletion — API and bydbctl (--force, --dry-run, --data-only) and task/status flow
  • Streamserver-generated element_id when omitted; element-ID-based query deduplication
  • Cluster / node discovery — default none, relative config paths
  • FODC / KTM (eBPF I/O) — overview and operator pointers
  • Schema property + property repair on by default — role of schema metadata, repair defaults, and related flags (e.g. has-meta-role) where user-facing
  • Storage / indexingBloom filters removed for dictionary-encoded tags; shared snapshot coordination for trace + sidx (concept-level)
  • Breaking changesproperty on-disk path includes <group> under property/data/; Windows no longer shipped for release binaries/images (clarify vs. “build yourself”)

Acceptance criteria

  • Installation / versions doc reflects API 0.10 and compatibility expectations (e.g. OAP version hints where applicable).
  • Upgrade / migration section exists for the property path layout change.
  • Items above are covered in the appropriate Installation, Interacting, Operation, or Concept pages, with cross-links—not only in CHANGES.md.
  • Breaking items are called out in a short “Upgrading to 0.10” (or equivalent) section.

Metadata

Metadata

Assignees

No one assigned

    Labels

    databaseBanyanDB - SkyWalking native database

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions