You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by "merlimat (via GitHub)" <gi...@apache.org> on 2026/06/18 01:18:17 UTC

[PR] Make Oxia the recommended metadata store in the Pulsar 5.0 docs [pulsar-site]

merlimat opened a new pull request, #1169:
URL: https://github.com/apache/pulsar-site/pull/1169

   ## What
   
   Makes **Oxia** the primary/recommended metadata store across the next (5.0) docs, with **ZooKeeper** retained as a fully-supported secondary option. Released `versioned_docs` are unchanged.
   
   ## Changes
   
   - **Metadata store & architecture** — `administration-metadata-store` and `concepts-architecture-overview` lead with Oxia; backends reordered (Oxia → ZooKeeper → etcd → RocksDB → memory); configuration-store prose generalized to be backend-neutral.
   - **`administration-zk-bk` renamed → "Metadata store & BookKeeper"**, leading with an Oxia section; the ZooKeeper deployment steps are kept as the in-tarball alternative. (Doc id unchanged, so existing links/anchors still resolve.)
   - **Deployment guides** — bare-metal, multi-cluster, Helm (documents the `components.oxia` toggle), and AWS lead with Oxia and link to the Oxia docs.
   - **Container quickstarts** — docker-compose and `docker run` now run **Oxia standalone** (`oxia/oxia`, `oxia://oxia:6648/default`, `oxia health` healthcheck) with persistent Docker volumes, instead of ZooKeeper.
   - **Supporting docs** — proxy, bookkeeper `metadataServiceUri`, functions worker, upgrade, and monitoring show Oxia-first configuration.
   - **Homepage** — the "How Pulsar Works" card is now Metadata Store / Oxia.
   - **Diagrams** — redrew the four architecture diagrams that showed ZooKeeper (system architecture, basic setup, broker/bookie, service discovery) as SVGs with Oxia. The original PNGs are kept because they are still referenced by older `versioned_docs`.
   
   ## Notes
   
   - The local standalone default stays RocksDB (unchanged).
   - For Oxia cluster deployment, the docs link to https://oxia-db.github.io/ rather than duplicating it.
   - `docusaurus build` (current version) passes.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Make Oxia the recommended metadata store in the Pulsar 5.0 docs [pulsar-site]

Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari merged PR #1169:
URL: https://github.com/apache/pulsar-site/pull/1169


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Make Oxia the recommended metadata store in the Pulsar 5.0 docs [pulsar-site]

Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1169:
URL: https://github.com/apache/pulsar-site/pull/1169#discussion_r3436756243


##########
docs/deploy-bare-metal-multi-cluster.md:
##########
@@ -267,17 +275,24 @@ designed to use multiple devices:
 
 ## Step 4: Deploy brokers
 
-Once you set up ZooKeeper, initialize cluster metadata, and spin up BookKeeper bookies, you can deploy brokers.
+Once you set up the metadata store, initialize cluster metadata, and spin up BookKeeper bookies, you can deploy brokers.
 
 ### Broker configuration
 
 You can configure brokers using the [`conf/broker.conf`](reference-configuration.md#broker) configuration file.
 
-The most important element of broker configuration is ensuring that each broker is aware of its local ZooKeeper quorum as well as the configuration store quorum. Make sure that you set the [`metadataStoreUrl`](reference-configuration.md#broker) parameter to reflect the local quorum and the [`configurationMetadataStoreUrl`](reference-configuration.md#broker) parameter to reflect the configuration store quorum (although you need to specify only those ZooKeeper servers located in the same cluster).
+The most important element of broker configuration is ensuring that each broker is aware of its local metadata store as well as the configuration store. Make sure that you set the [`metadataStoreUrl`](reference-configuration.md#broker) parameter to reflect the local metadata store and the [`configurationMetadataStoreUrl`](reference-configuration.md#broker) parameter to reflect the configuration store.
 
 You also need to specify the name of the [cluster](reference-terminology.md#cluster) to which the broker belongs using the [`clusterName`](reference-configuration.md#broker-clusterName) parameter. In addition, you need to match the broker and web service ports provided when you initialize the metadata (especially when you use a different port from default) of the cluster.
 
-The following is an example configuration:
+With Oxia (recommended), point both parameters at your Oxia URL:
+
+```properties
+metadataStoreUrl=oxia://oxia-1.example.com:6648/pulsar
+configurationMetadataStoreUrl=oxia://oxia-1.example.com:6648/pulsar

Review Comment:
   Since `configurationMetadataStoreUrl` is optional, it can be omitted. `bookkeeperMetadataServiceUri` is required.
   ```suggestion
   bookkeeperMetadataServiceUri=oxia://oxia-1.example.com:6648/bookkeeper
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Make Oxia the recommended metadata store in the Pulsar 5.0 docs [pulsar-site]

Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1169:
URL: https://github.com/apache/pulsar-site/pull/1169#discussion_r3436750049


##########
docs/deploy-bare-metal.md:
##########
@@ -460,7 +476,16 @@ Broker configuration is split across two files:
 
 #### Metadata store and cluster settings
 
-You can configure brokers using the `conf/broker.conf` configuration file. The most important element of broker configuration is ensuring that each broker is aware of the ZooKeeper cluster that you have deployed. Ensure that the [`metadataStoreUrl`](reference-configuration.md#broker) and [`configurationMetadataStoreUrl`](reference-configuration.md#broker) parameters are correct. In this case, since you only have 1 cluster and no configuration store setup, the `configurationMetadataStoreUrl` point to the same `metadataStoreUrl`.
+You can configure brokers using the `conf/broker.conf` configuration file. The most important element of broker configuration is ensuring that each broker is aware of the metadata store that you have deployed. Ensure that the [`metadataStoreUrl`](reference-configuration.md#broker) and [`configurationMetadataStoreUrl`](reference-configuration.md#broker) parameters are correct. In this case, since you only have 1 cluster and no configuration store setup, the `configurationMetadataStoreUrl` point to the same `metadataStoreUrl`.
+
+With Oxia (recommended):
+
+```properties
+metadataStoreUrl=oxia://oxia-1.example.com:6648/pulsar
+configurationMetadataStoreUrl=oxia://oxia-1.example.com:6648/pulsar

Review Comment:
   Since `configurationMetadataStoreUrl` is optional, it can be omitted. `bookkeeperMetadataServiceUri` is required.
   ```suggestion
   bookkeeperMetadataServiceUri=oxia://oxia-1.example.com:6648/bookkeeper
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Make Oxia the recommended metadata store in the Pulsar 5.0 docs [pulsar-site]

Posted by "lhotari (via GitHub)" <gi...@apache.org>.
lhotari commented on code in PR #1169:
URL: https://github.com/apache/pulsar-site/pull/1169#discussion_r3436807712


##########
docs/bookkeeper-metadata-serviceuri.md:
##########
@@ -67,7 +67,12 @@ it ends up internally as:
 
 ### **3\. Metadata Service URI (Preferred)**
 
-From our **OSS Pulsar 4.x tests**, the **correct and working setup** is:
+For new clusters, [Oxia is the recommended metadata store](administration-metadata-store.md). Point BookKeeper at Oxia with:
+
+| metadataServiceUri\=metadata-store:oxia://oxia-1.example.com:6648/pulsar |

Review Comment:
   Wouldn't a separate root be recommended? Yuwei implemented the Apache Pulsar Helmchart in a way where the root is `/bookkeeper`.
   ```suggestion
   | metadataServiceUri\=metadata-store:oxia://oxia-1.example.com:6648/bookkeeper |
   ```
   It could be useful to document that the format is slightly different than Pulsar's `metadataStoreUrl` format. The `metadata-store:` prefix is required for Bookkeeper / Bookkeeper client.
   In Pulsar, the `bookkeeperMetadataServiceUri` value should match the value of Bookkeeper configurations `metadataServiceUri`.
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Make Oxia the recommended metadata store in the Pulsar 5.0 docs [pulsar-site]

Posted by "merlimat (via GitHub)" <gi...@apache.org>.
merlimat commented on PR #1169:
URL: https://github.com/apache/pulsar-site/pull/1169#issuecomment-4745328088

   I did the fixes. PTAL again


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org