Skip to content

docs: Woodpecker-default install docs + Data Infrastructure & Integration chapter (3.x)#3520

Open
tinswzy wants to merge 19 commits into
milvus-io:v3.0.xfrom
tinswzy:enhance_3.0_mqtype_docs
Open

docs: Woodpecker-default install docs + Data Infrastructure & Integration chapter (3.x)#3520
tinswzy wants to merge 19 commits into
milvus-io:v3.0.xfrom
tinswzy:enhance_3.0_mqtype_docs

Conversation

@tinswzy

@tinswzy tinswzy commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

What this does

Restructures the Milvus 3.x docs so a new open-source user gets Woodpecker
(the default message queue) on every install path, with other MQs / metadata /
object storage as clearly-scoped optional components.

Install pages

  • Docker / Docker Compose standalone: Woodpecker (embedded) default; the Compose
    page documents the 2.5.x→2.6.x default-MQ change and upgrade caveat.
  • Helm cluster: switched to Woodpecker service mode (verified on a local
    deploy — dedicated my-release-milvus-woodpecker StatefulSet); stale Pulsar
    references removed from the Operator/Helm pages.
  • Prerequisites / overview / Windows / RPM-DEB pages note Woodpecker as default.

New "Data Infrastructure & Integration" chapter

  • Overview, Metadata › etcd, Object Storage (support matrix), and a Message
    Queue (mqType) section: support matrix, Woodpecker (3 storage modes incl.
    cluster-only service mode), Pulsar (+ v2/v3), Kafka, RocksMQ — each with
    version compatibility and install/configure/uninstall steps.
  • use-woodpecker.md migrated to woodpecker.md; legacy "Manage Dependencies"
    subtree removed from the nav (detail config pages kept and linked).

Switch MQ Type

  • Restructured into an overview + Woodpecker-paired pages (RocksMQ / Pulsar /
    Kafka ↔ Woodpecker), both directions; Pulsar↔Kafka is out of scope.

Cleanup

  • Link text, version variables, glossary reference, and stale "default MQ"
    wording normalized.

Verified locally: JSON valid, all nav targets exist, no stale references, no nav
orphans. (Full site build runs in CI.)

tinswzy and others added 15 commits June 8, 2026 17:31
Signed-off-by: tinswzy <zhenyuan.wei@zilliz.com>
Clarify that the single-container Docker deployment runs Woodpecker
(local-filesystem WAL) by default, and add an Optional dependencies
section linking the message-queue, object-storage, and metadata options.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
….5→2.6 upgrade caveat

Describe the default three-container deployment with Woodpecker
(embedded, local-filesystem WAL), note the per-version default message
queue (2.5.x RocksMQ vs 2.6.x+ Woodpecker), add a 2.5.x->2.6.x upgrade
section that pins RocksMQ via mq.type, and add an Optional dependencies
section.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
… page

The default Operator sample now deploys Woodpecker, so drop the leftover
Pulsar mentions in the overview, dependency-creation note, and uninstall
note; remove the PulsarReady condition from the status example; and add
an Optional dependencies section pointing to the Operator dependency
configuration pages.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…& Integration chapter

Create mq_pulsar.md capturing how to install Milvus with Pulsar via Helm
(including the Kubernetes v1.25+ PodDisruptionBudget workaround), and add
a new top-level Data Infrastructure & Integration chapter with a Message
Queue (mqType) section hosting the Pulsar page in its final location.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…n up stale Pulsar content

Make the cluster install use Woodpecker service mode
(streaming.woodpecker.embedded=false), update the pod example to show the
dedicated my-release-milvus-woodpecker StatefulSet (verified on a real
v3.0-beta + milvusdb/woodpecker:latest deployment), fix the
streaming-node -> streamingnode workload name, and remove leftover Pulsar
content (pods, PodDisruptionBudget workaround, alternative recipe). Add
an Optional dependencies section and align the offline standalone
template with Woodpecker.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…andalone uses embedded)

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…l in prerequisite tables

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…overview

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…PM-DEB standalone pages

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Move adminGuide/use-woodpecker.md to woodpecker.md under the new Data
Infrastructure & Integration > mqType section, reframe Woodpecker as the
default message queue, document the three storage.type modes
(minio/local/service) with a support matrix, and add a verified
'Woodpecker service mode' deployment section (separate StatefulSet, 4
replicas, headless service, MinIO backend; distributed/cluster only).
Repoint all use-woodpecker.md links to woodpecker.md and update the nav.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…complete Pulsar, Kafka, and RocksMQ pages

Add a Message Queue overview (support matrix across Woodpecker/Pulsar/
Kafka/RocksMQ x standalone/cluster), and expand the per-MQ pages into
self-contained guides with version compatibility and install/configure/
uninstall steps: Pulsar and Kafka for Milvus cluster via Helm and Milvus
Operator, RocksMQ for standalone via Docker. Each page links Woodpecker
as the default and notes the 2.5.x->2.6.x upgrade behavior.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…t storage pages; remove the old Manage Dependencies subtree

Add the chapter overview, a concise Metadata > etcd page (version + Helm
image override), and an Object Storage page (supported-store matrix plus
the stricter S3 Conditional-Write requirement when running embedded
Woodpecker). Re-parent the Pulsar v2/v3 pages under mqType > Pulsar and
remove the legacy Manage Dependencies nav subtree; the detailed deploy_*
and *_operator config pages remain and are linked from the new pages.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the deployment-organized switch docs (standalone / cluster-helm /
cluster-operator) with an Overview plus three Woodpecker-paired pages —
RocksMQ, Pulsar, and Kafka each <-> Woodpecker — covering both directions,
Helm and Operator where applicable (WP->Pulsar/Kafka noted as Operator-
unsupported). Pulsar<->Kafka is explicitly out of scope. Repoint inbound
links and rebuild the Switch MQ Type nav.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ording, glossary repoint

Normalize '[Use Woodpecker]' link text to '[Woodpecker]', replace
hardcoded v2.6.0 with the release-version variable in woodpecker.md,
update the Switch-MQ link text on the Pulsar/Kafka pages, soften stale
'X is the default message storage' wording on the legacy config pages,
and repoint the glossary Manage Dependencies reference to the new Data
Infrastructure & Integration overview.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@sre-ci-robot

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: tinswzy

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

tinswzy and others added 4 commits June 12, 2026 14:04
…elm repo, demo script

- woodpecker.md batch-insert demo: add missing 'import time'; fix client
  URI port 27017 -> 19530 (proxy serves 19530; 27017 is only a local
  port-forward); correct the maxFlushRetries inline comment.
- install_cluster-helm.md: fix broken cross-ref anchor (milvus-io#3-Connect-to-Milvus)
  and the #Optional-dependencies anchor case; repoint Kafka/RocksMQ optional-
  dependency links to mq_kafka.md / mq_rocksmq.md.
- install_standalone-docker(.compose).md: repoint Pulsar/Kafka/RocksMQ
  optional-dependency links to the new mq_*.md pages.
- switch-pulsar/kafka-woodpecker.md: fix helm repo milvus/milvus -> zilliztech/milvus.
- switch-rocksmq-woodpecker.md: docker-compose -> docker compose (v2).
- deploy_pulsar.md: soften stale 'standalone default is RocksMQ' and fix comment.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
A review subagent inadvertently weakened 'Woodpecker (default)' to
'(recommended)' and pre-empted the version-framing wording; restore the
approved text. Version-framing (2.6.x vs 3.x) is handled deliberately
in a follow-up.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…lvus 3.x framing, update operator MQ priority

- mq_pulsar.md / mq_kafka.md: use chart-native externalPulsar.enabled /
  externalKafka.enabled (+ explicit pulsarv3.enabled / woodpecker.enabled)
  so the install commands actually select the intended MQ instead of
  silently falling back to the chart-default Pulsar; soften 'cluster only'
  to 'primarily distributed' to match the support matrix.
- Standardize the Woodpecker-default wording on 'Milvus 3.x' across the
  mqType chapter (kept the 2.5->2.6 upgrade notes, v2.6.14, and Pulsar v2/v3).
- message_storage_operator.md: note Woodpecker as the default and add it to
  the MQ priority list (Operator supports embedded Woodpecker).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- mq_rocksmq: use start→edit→restart so the RocksMQ override survives
  run_embed's first-start user.yaml rewrite; note it targets a new instance
- woodpecker: standalone-local example follows the Woodpecker default
  (no clobbered user.yaml); add the WP-service quorum note
- install_cluster-helm: note the WP service needs a quorum of 3 (default 4)
- install_standalone-docker-compose: correct the WP WAL backend wording
  to MinIO / object storage (compose standalone runs WP embedded over MinIO)

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants