From 3d2b4ffd97abe57372da261668474ca1faf20f18 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Mon, 23 Feb 2026 11:53:40 -0800 Subject: [PATCH 1/6] local-preview-playbook --- local-preview-playbook.yml | 183 ++++++++++++++++++++++++++++++++++--- 1 file changed, 168 insertions(+), 15 deletions(-) diff --git a/local-preview-playbook.yml b/local-preview-playbook.yml index 7fdf7ca..5b47fa2 100644 --- a/local-preview-playbook.yml +++ b/local-preview-playbook.yml @@ -54,23 +54,176 @@ asciidoc: xrefstyle: short # CUSTOM ATTRIBUTES company: 'DataStax' + trust-center: 'IBM Trust Center' + trust-center-url: 'https://www.ibm.com/trust' + trust-center-link: '{trust-center-url}[{trust-center}]' + support-url: 'https://www.ibm.com/mysupport/s/' + dsbulk: 'DataStax Bulk Loader (DSBulk)' + dsbulk-short: 'DSBulk' + dsbulk-repo: 'https://github.com/datastax/dsbulk' + astra: 'Astra' + astra-db: 'Astra DB' + astra-ui: 'Astra Portal' + astra-url: 'https://astra.datastax.com' + astra-ui-link: '{astra-url}[{astra-ui}^]' + db-classic: 'Managed Cluster' + db-serverless: 'Serverless (non-vector)' + db-serverless-vector: 'Serverless (vector)' + scb: 'Secure Connect Bundle (SCB)' + scb-short: 'SCB' + scb-brief: 'Secure Connect Bundle' + devops-api: 'DevOps API' + devops-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$devops-api/index.html' + astra-cli: 'Astra CLI' + astra-stream: 'Astra Streaming' + starlight-kafka: 'Starlight for Kafka' + starlight-rabbitmq: 'Starlight for RabbitMQ' + astra-streaming-examples-repo: 'https://github.com/datastax/astra-streaming-examples' + sstable-sideloader: '{astra-db} Sideloader' + zdm: 'Zero Downtime Migration' + zdm-short: 'ZDM' + zdm-proxy: 'ZDM Proxy' + cass-migrator: 'Cassandra Data Migrator (CDM)' + cass-migrator-short: 'CDM' + hcd: 'Hyper-Converged Database (HCD)' + hcd-short: 'HCD' + dse: 'DataStax Enterprise (DSE)' + dse-short: 'DSE' + metrics-collector: 'DSE Metrics Collector' + mc: 'Mission Control' + opscenter: 'DSE OpsCenter' + studio: 'DataStax Studio' + cass-reg: 'Apache Cassandra(R)' + cass: 'Apache Cassandra' + cass-short: 'Cassandra' + cql: 'Cassandra Query Language (CQL)' + cql-shell: 'CQL shell' + cql-console: 'CQL console' + cql-service: 'CQL Service' + pulsar-reg: 'Apache Pulsar(TM)' + pulsar: 'Apache Pulsar' + pulsar-short: 'Pulsar' + spark-reg: 'Apache Spark(TM)' + spark: 'Apache Spark' + spark-short: 'Spark' + spark-connect: 'Spark Connect' + spark-connector: 'Apache Cassandra Spark Connector' + spark-connector-short: 'Spark Connector' + kafka-reg: 'Apache Kafka(R)' + kafka: 'Apache Kafka' + kafka-short: 'Kafka' + kafka-connect: 'Kafka Connect' + kafka-connector: 'DataStax Apache Kafka Connector' + kafka-connector-short: 'Kafka Connector' + solr-reg: 'Apache Solr(TM)' + solr: 'Apache Solr' + solr-short: 'Solr' + lucene-reg: 'Apache Lucene(TM)' + lucene: 'Apache Lucene' + lucene-short: 'Lucene' + hadoop-reg: 'Apache Hadoop(R)' + hadoop: 'Apache Hadoop' + hadoop-short: 'Hadoop' + airflow-reg: 'Apache Airflow(R)' + airflow: 'Apache Airflow' + airflow-short: 'Airflow' + maven-reg: 'Apache Maven(TM)' + maven: 'Apache Maven' + maven-short: 'Maven' + flink-reg: 'Apache Flink(R)' + flink: 'Apache Flink' + flink-short: 'Flink' + beam-reg: 'Apache Beam(R)' + beam: 'Apache Beam' + beam-short: 'Beam' + geode-reg: 'Apache Geode(TM)' + geode: 'Apache Geode' + geode-short: 'Geode' + hbase-reg: 'Apache HBase(R)' + hbase: 'Apache HBase' + hbase-short: 'HBase' + kudu-reg: 'Apache Kudu(TM)' + kudu: 'Apache Kudu' + kudu-short: 'Kudu' + phoenix-reg: 'Apache Phoenix(TM)' + phoenix: 'Apache Phoenix' + phoenix-short: 'Phoenix' + zookeeper-reg: 'Apache ZooKeeper(TM)' + zookeeper: 'Apache ZooKeeper' + zookeeper-short: 'ZooKeeper' + asf: 'Apache Software Foundation (ASF)' + asf-short: 'ASF' + tinkerpop-reg: 'Apache TinkerPop(TM)' + tinkerpop: 'Apache TinkerPop' + tinkerpop-short: 'TinkerPop' + cloudstack-reg: 'Apache CloudStack(R)' + cloudstack: 'Apache CloudStack' + cloudstack-short: 'CloudStack' + tomcat-reg: 'Apache Tomcat(R)' + tomcat: 'Apache Tomcat' + tomcat-short: 'Tomcat' + ajp: 'Apache JServ Protocol (AJP)' + ajp-short: 'AJP' + activemq-reg: 'Apache ActiveMQ(R)' + activemq: 'Apache ActiveMQ' + activemq-short: 'ActiveMQ' + tomee-reg: 'Apache TomEE(TM)' + tomee: 'Apache TomEE' + tomee-short: 'TomEE' + bookkeeper-reg: 'Apache BookKeeper(TM)' + bookkeeper: 'Apache BookKeeper' + bookkeeper-short: 'BookKeeper' + groovy-reg: 'Apache Groovy(TM)' + groovy: 'Apache Groovy' + groovy-short: 'Groovy' + cpp-driver-url: 'https://github.com/datastax/cpp-driver' + csharp-driver-url: 'https://github.com/datastax/csharp-driver' + gocql-astra-url: 'https://github.com/datastax/gocql-astra' + go-driver-url: 'https://github.com/apache/cassandra-gocql-driver' + cql-proxy-url: 'https://github.com/datastax/cql-proxy' + java-driver-url: 'https://github.com/apache/cassandra-java-driver' + nodejs-driver-url: 'https://github.com/datastax/nodejs-driver' + python-driver-url: 'https://github.com/datastax/python-driver' + scala-driver-url: 'https://github.com/apache/cassandra-spark-connector' + cass-driver-cpp-shield: 'image:https://img.shields.io/github/v/tag/datastax/cpp-driver?label=latest[alt="Latest cpp-driver release on GitHub",link="{cpp-driver-url}/tags"]' + cass-driver-csharp-shield: 'image:https://img.shields.io/nuget/v/CassandraCSharpDriver?label=latest[alt="Latest CassandraCSharpDriver release on NuGet",link="https://www.nuget.org/packages/CassandraCSharpDriver"]' + cass-driver-go-shield: 'image:https://img.shields.io/github/v/tag/apache/cassandra-gocql-driver?label=latest%20gocql[alt="Latest gocql release on GitHub",link="{go-driver-url}/tags"]' + cass-driver-java-shield: 'image:https://img.shields.io/github/v/tag/apache/cassandra-java-driver?label=latest[alt="Latest cassandra-java-driver release on GitHub",link="{java-driver-url}/tags"]' + cass-driver-nodejs-shield: 'image:https://img.shields.io/github/v/tag/datastax/nodejs-driver?label=latest[alt="Latest nodejs-driver release on GitHub",link="{nodejs-driver-url}/tags"]' + cass-driver-python-shield: 'image:https://img.shields.io/github/v/tag/datastax/python-driver?label=latest[alt="Latest python-driver release on GitHub",link="{python-driver-url}/tags"]' + cass-driver-scala-shield: 'image:https://img.shields.io/github/v/tag/apache/cassandra-spark-connector?label=latest[alt="Latest cassandra-spark-connector release on GitHub",link="{scala-driver-url}/releases"]' + data-api: 'Data API' + csharp-client-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$csharp-client' + py-client-api-ref-url-2x: 'xref:astra-api-docs:ROOT:attachment$python-client/astrapy' + ts-client-api-ref-url-2x: 'xref:astra-api-docs:ROOT:attachment$typescript-client' + java-client-api-ref-url-2x: 'xref:astra-api-docs:ROOT:attachment$java-client' + python-client-repo-url: 'https://github.com/datastax/astrapy' + typescript-client-repo-url: 'https://github.com/datastax/astra-db-ts' + typescript-client-examples-url: '{typescript-client-repo-url}/blob/v2.x/examples' + java-client-repo-url: 'https://github.com/datastax/astra-db-java' + csharp-client-repo-url: 'https://github.com/datastax/astra-db-csharp' + python-client-python-version: '3.8' + dataapi-java-client-shield: 'image:https://img.shields.io/maven-central/v/com.datastax.astra/astra-db-java.svg?label=latest[alt="Latest astra-db-java release on Maven Central",link="https://search.maven.org/artifact/com.datastax.astra/astra-db-java"]' + dataapi-python-client-shield: 'image:https://img.shields.io/github/v/tag/datastax/astrapy?label=latest[alt="Latest astrapy release on GitHub",link="{python-client-repo-url}/releases"]' + dataapi-typescript-client-shield: 'image:https://img.shields.io/github/v/tag/datastax/astra-db-ts?label=latest[alt="Latest astra-db-ts release on GitHub",link="{typescript-client-repo-url}/releases"]' + dataapi-csharp-client-shield: 'image:https://img.shields.io/github/v/tag/datastax/astra-db-csharp?label=latest[alt="Latest astra-db-csharp release on GitHub",link="{csharp-client-repo-url}/releases"]' + agent: 'DataStax Agent' + repair-service: 'Repair Service' + backup-service: 'Backup Service' + performance-service: 'Performance Service' + monitoring-service: 'OpsCenter Monitoring' + nodesync-service: 'NodeSync Service' + bestpractice-service: 'Best Practice Service' + capacity-service: 'Capacity Service' + lcm: 'Lifecycle Manager (LCM)' + lcm-short: 'LCM' + cr: 'custom resource (CR)' + cr-short: 'CR' + crd: 'custom resource definition (CRD)' + crd-short: 'CRD' + # Custom attributes only used in ragstack-ai astra_db: 'Astra DB' - astra_stream: 'Astra Streaming' astra_ui: 'Astra Portal' - astra_cli: 'Astra CLI' - astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master' - luna-streaming-examples-repo: 'https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main' - support_url: 'https://www.ibm.com/mysupport/s/' - glossary-url: 'https://docs.datastax.com/en/glossary/docs/index.html#' - emoji-tada: "🎉" - emoji-rocket: "🚀" - emoji-smile: "😀" - dse: 'DataStax Enterprise (DSE)' - cassandra: 'Apache Cassandra(R)' - classic: 'classic' - classic_cap: 'Classic' - serverless: 'serverless' - serverless_cap: 'Serverless' # Antora Atlas primary-site-url: https://docs.datastax.com/en primary-site-manifest-url: https://docs.datastax.com/en/site-manifest.json From cc2a596e8d30c599e094299693cdf19d749f0b33 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Mon, 23 Feb 2026 11:54:57 -0800 Subject: [PATCH 2/6] astra-streaming --- antora.yml | 2 +- modules/ROOT/pages/faqs.adoc | 2 +- .../installation/pages/getting-started.adoc | 36 +++++++++---------- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/antora.yml b/antora.yml index e6a162f..13e9618 100644 --- a/antora.yml +++ b/antora.yml @@ -16,4 +16,4 @@ asciidoc: pulsar: 'Apache Pulsar' pulsar-short: 'Pulsar' luna-streaming: 'Luna Streaming' - astra-streaming: 'Astra Streaming' \ No newline at end of file + astra-stream: 'Astra Streaming' \ No newline at end of file diff --git a/modules/ROOT/pages/faqs.adoc b/modules/ROOT/pages/faqs.adoc index 75013db..9a192b2 100644 --- a/modules/ROOT/pages/faqs.adoc +++ b/modules/ROOT/pages/faqs.adoc @@ -20,7 +20,7 @@ The following {pulsar-short} releases are supported: * {luna-streaming} 2.8.0 or later * {pulsar} 2.9.0 or later -* {astra-streaming} +* {astra-stream} == What are the {product} limitations? diff --git a/modules/installation/pages/getting-started.adoc b/modules/installation/pages/getting-started.adoc index dad7f81..dfe56e2 100644 --- a/modules/installation/pages/getting-started.adoc +++ b/modules/installation/pages/getting-started.adoc @@ -16,13 +16,13 @@ The deployment options you can use depend on your {pulsar-short} deployment. [tabs] ====== -{astra-streaming}:: +{astra-stream}:: + -- -When you enable {product} in {astra-streaming}, it is deployed as a protocol handler in the {pulsar-short} cluster. -Because {astra-streaming} manages the {pulsar-short} cluster for you, you cannot use the other {product} deployment options. +When you enable {product} in {astra-stream}, it is deployed as a protocol handler in the {pulsar-short} cluster. +Because {astra-stream} manages the {pulsar-short} cluster for you, you cannot use the other {product} deployment options. -The following steps explain how to enable the {product} protocol handler in an {astra-streaming} {pulsar-short} cluster, and then get the connection details for your RabbitMQ client. +The following steps explain how to enable the {product} protocol handler in an {astra-stream} {pulsar-short} cluster, and then get the connection details for your RabbitMQ client. . In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*. @@ -34,14 +34,14 @@ The following steps explain how to enable the {product} protocol handler in an { + [IMPORTANT] ==== -This action creates a configuration file and a `rabbitmq` namespace in your {astra-streaming} tenant automatically. +This action creates a configuration file and a `rabbitmq` namespace in your {astra-stream} tenant automatically. The `rabbitmq` namespace is required for the {product} extension to function properly. It is a permanent namespace that cannot be removed except by deleting the entire tenant and all of its data. ==== . Save the RabbitMQ connection details to a file named `rabbitmq.conf`. -The actual values depend on your {astra-streaming} tenant's configuration and cloud provider. +The actual values depend on your {astra-stream} tenant's configuration and cloud provider. + .rabbitmq.conf [source,conf,subs="+quotes,+attributes"] @@ -56,7 +56,7 @@ amqp_URI: {asterisk}{asterisk}{asterisk}{asterisk}{asterisk}{asterisk}@rabbitmq- + [TIP] ==== -In {astra-streaming}, if you click icon:download[name="Download"] or icon:clipboard[name="Copy"], then a {pulsar-short} token is included in the `password` field automatically. +In {astra-stream}, if you click icon:download[name="Download"] or icon:clipboard[name="Copy"], then a {pulsar-short} token is included in the `password` field automatically. You can also generate a token on your tenant's **Settings** tab. ==== + @@ -185,18 +185,18 @@ With a {pulsar-short} cluster between publishers and consumers, you can change t The following examples use Python and Java. The Java example uses Maven, but you can also use Gradle. For complete source code examples and examples for other languages, see the https://github.com/datastax/astra-streaming-examples[{company} streaming examples repository]. -These examples are written for {astra-streaming} but they can be adapted for {luna-streaming} or self-managed {pulsar-short} clusters by replacing the connection details with those for your cluster. +These examples are written for {astra-stream} but they can be adapted for {luna-streaming} or self-managed {pulsar-short} clusters by replacing the connection details with those for your cluster. [tabs] ====== -{astra-streaming}:: +{astra-stream}:: + -- [tabs] ==== Python client:: + -The following example uses a Python script to create a connection between RabbitMQ and your {astra-streaming} tenant. +The following example uses a Python script to create a connection between RabbitMQ and your {astra-stream} tenant. It also establishes a message queue named `queuename`, prints ten messages, and then closes the connection. + . Enable {product} and get the `rabbitmq.conf` connection details, as explained in <>. @@ -241,7 +241,7 @@ connection.close() ---- + . Optional: Change the values for `queue`, `routing_key`, and `body`. -`queuename` and `routingkey` become the names of {pulsar-short} topics in your {astra-streaming} tenant. +`queuename` and `routingkey` become the names of {pulsar-short} topics in your {astra-stream} tenant. The `body` is the content of each message that is sent. + . Save and run the `connect-test.py` script: @@ -269,14 +269,14 @@ started a channel sent one ---- + -. In {astra-streaming}, go to your tenant's **Namespaces and Topics** tab to inspect the activity in the `rabbitmq` namespace. +. In {astra-stream}, go to your tenant's **Namespaces and Topics** tab to inspect the activity in the `rabbitmq` namespace. + If you everything was configured correctly, then the `rabbitmq` namespace should have topics named `amq.default.__queuename` and `amq.default_routingkey` that were created by the Python script. -Additionally, the namespace's metrics should reflect that at least 10 messages were published and consumed by your {astra-streaming} {pulsar-short} topics. +Additionally, the namespace's metrics should reflect that at least 10 messages were published and consumed by your {astra-stream} {pulsar-short} topics. Java client:: + -The following example uses a Java program to create a connection between RabbitMQ and your {astra-streaming} tenant, and then it establishes a message queue and sends a message. +The following example uses a Java program to create a connection between RabbitMQ and your {astra-stream} tenant, and then it establishes a message queue and sends a message. + . Enable {product} and get the `rabbitmq.conf` connection details, as explained in <>. + @@ -343,7 +343,7 @@ public class App { ---- + . Optional: Replace `queuename` with another name for the queue that publishes and consumes messages. -This name is also used as the corresponding topic name in {astra-streaming}. +This name is also used as the corresponding topic name in {astra-stream}. If the topic doesn't exist, it is created automatically when the producer sends the first message. + . Add the following code to create a connection, channel, and queue that is used by both the producer and consumer: @@ -417,10 +417,10 @@ Sent 'Hello World!' Received 'Hello World!' ---- + -. In {astra-streaming}, go to your tenant's **Namespaces and Topics** tab to inspect the activity in the `rabbitmq` namespace. +. In {astra-stream}, go to your tenant's **Namespaces and Topics** tab to inspect the activity in the `rabbitmq` namespace. + If you everything was configured correctly, then the `rabbitmq` namespace should have a topic named `amq.default.__queuename` that was created by the Java program. -Additionally, the namespace's metrics should reflect that at least one message was published and consumed by your {astra-streaming} {pulsar-short} topic. +Additionally, the namespace's metrics should reflect that at least one message was published and consumed by your {astra-stream} {pulsar-short} topic. ==== -- @@ -565,7 +565,7 @@ public class App { ---- + . Optional: Replace `queuename` with another name for the queue that publishes and consumes messages. -This name is also used as the corresponding topic name in {astra-streaming}. +This name is also used as the corresponding topic name in {astra-stream}. If the topic doesn't exist,it is created automatically when the producer sends the first message. + . Add the producer code, which is a simple flow that sends a single message and awaits acknowledgment: From 20af30649761408fb61502245e9c91029e4ed007 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Mon, 23 Feb 2026 11:56:40 -0800 Subject: [PATCH 3/6] pulsar --- modules/operations/pages/protocol-handler.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/operations/pages/protocol-handler.adoc b/modules/operations/pages/protocol-handler.adoc index 3fa215e..525dacd 100644 --- a/modules/operations/pages/protocol-handler.adoc +++ b/modules/operations/pages/protocol-handler.adoc @@ -57,7 +57,7 @@ If the optional routing key is provided, then the exchange name and key are comb [IMPORTANT] ==== -This mapping requires that the AMQP VHost names contain only characters that are allowed in Pulsar tenant and namespace names: `a-z`, `A-Z`, `0-9`, `_`, `-`, `=`, `:`, and `.`. +This mapping requires that the AMQP VHost names contain only characters that are allowed in {pulsar-short} tenant and namespace names: `a-z`, `A-Z`, `0-9`, `_`, `-`, `=`, `:`, and `.`. ==== Full VHost names map directly to a {pulsar-short} tenant and namespace. From e8f518d89b5711b9029f97035075a4bc62d4b5ba Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Mon, 23 Feb 2026 11:58:49 -0800 Subject: [PATCH 4/6] github urls --- antora.yml | 4 +++- modules/ROOT/pages/faqs.adoc | 2 +- modules/ROOT/partials/run-as-protocol-handler-simple.adoc | 2 +- modules/ROOT/partials/run-as-proxy-extension.adoc | 2 +- modules/ROOT/partials/run-as-standalone.adoc | 2 +- modules/installation/pages/getting-started.adoc | 4 ++-- package.json | 2 +- 7 files changed, 10 insertions(+), 8 deletions(-) diff --git a/antora.yml b/antora.yml index 13e9618..ac57551 100644 --- a/antora.yml +++ b/antora.yml @@ -9,6 +9,7 @@ nav: asciidoc: attributes: product: 'Starlight for RabbitMQ' + product-repo: 'https://github.com/datastax/starlight-for-rabbitmq' astra-ui: 'Astra Portal' astra-url: 'https://astra.datastax.com' astra-ui-link: '{astra-url}[{astra-ui}^]' @@ -16,4 +17,5 @@ asciidoc: pulsar: 'Apache Pulsar' pulsar-short: 'Pulsar' luna-streaming: 'Luna Streaming' - astra-stream: 'Astra Streaming' \ No newline at end of file + astra-stream: 'Astra Streaming' + astra-streaming-examples-repo: 'https://github.com/datastax/astra-streaming-examples' \ No newline at end of file diff --git a/modules/ROOT/pages/faqs.adoc b/modules/ROOT/pages/faqs.adoc index 9a192b2..dff435f 100644 --- a/modules/ROOT/pages/faqs.adoc +++ b/modules/ROOT/pages/faqs.adoc @@ -28,7 +28,7 @@ See xref:ROOT:index.adoc#limitations[Limitations]. === Is {product} an open-source project? Where can I find the source code? -Yes, {product} is open source using the Apache 2.0 license. You can find the source code in the https://github.com/datastax/starlight-for-rabbitmq[{product} GitHub repository]. +Yes, {product} is open source using the Apache 2.0 license. You can find the source code in the {product-repo}[{product} GitHub repository]. === Does {product} support Kubernetes? diff --git a/modules/ROOT/partials/run-as-protocol-handler-simple.adoc b/modules/ROOT/partials/run-as-protocol-handler-simple.adoc index e7abc0e..4ddeec4 100644 --- a/modules/ROOT/partials/run-as-protocol-handler-simple.adoc +++ b/modules/ROOT/partials/run-as-protocol-handler-simple.adoc @@ -1,6 +1,6 @@ You can embed {product} directly into the {pulsar-short} brokers by loading it as a protocol handler. + -. Download the {product} `tar` file from the https://github.com/datastax/starlight-for-rabbitmq/releases[{product} GitHub repository]. +. Download the {product} `tar` file from the {product-repo}/releases[{product} GitHub repository]. + . Extract the files from the `tar`: + diff --git a/modules/ROOT/partials/run-as-proxy-extension.adoc b/modules/ROOT/partials/run-as-proxy-extension.adoc index d6c2f43..f691c87 100644 --- a/modules/ROOT/partials/run-as-proxy-extension.adoc +++ b/modules/ROOT/partials/run-as-proxy-extension.adoc @@ -1,6 +1,6 @@ You can embed {product} into the {pulsar-short} Proxy by loading it as a proxy extension. + -. Download the {product} `tar` file from the https://github.com/datastax/starlight-for-rabbitmq/releases[{product} GitHub repository]. +. Download the {product} `tar` file from the {product-repo}/releases[{product} GitHub repository]. + . Extract the files from the `tar`: + diff --git a/modules/ROOT/partials/run-as-standalone.adoc b/modules/ROOT/partials/run-as-standalone.adoc index 69748cc..d5c0eac 100644 --- a/modules/ROOT/partials/run-as-standalone.adoc +++ b/modules/ROOT/partials/run-as-standalone.adoc @@ -1,7 +1,7 @@ You can run {product} as a standalone Java application. The `jar` file for running {product} as a standalone Java application is available in the {product} `tar` file. + -. Download the {product} `tar` file from the https://github.com/datastax/starlight-for-rabbitmq/releases[{product} GitHub repository]. +. Download the {product} `tar` file from the {product-repo}/releases[{product} GitHub repository]. + . Extract the files from the `tar`: + diff --git a/modules/installation/pages/getting-started.adoc b/modules/installation/pages/getting-started.adoc index dfe56e2..f564a51 100644 --- a/modules/installation/pages/getting-started.adoc +++ b/modules/installation/pages/getting-started.adoc @@ -2,7 +2,7 @@ :navtitle: Installation :description: Use the {product} extension with {pulsar-reg}. -The https://github.com/datastax/starlight-for-rabbitmq[{product} extension] enables https://www.rabbitmq.com/[RabbitMQ] protocol support for https://pulsar.apache.org/[{pulsar-reg}]. +The {product-repo}[{product} extension] enables https://www.rabbitmq.com/[RabbitMQ] protocol support for https://pulsar.apache.org/[{pulsar-reg}]. The extension acts as a proxy between your RabbitMQ application and {pulsar-short} cluster. It implements the AMQP 0.9.1 protocol used by RabbitMQ clients and translates AMQP frames and concepts to {pulsar-short} concepts. @@ -184,7 +184,7 @@ With a {pulsar-short} cluster between publishers and consumers, you can change t The following examples use Python and Java. The Java example uses Maven, but you can also use Gradle. -For complete source code examples and examples for other languages, see the https://github.com/datastax/astra-streaming-examples[{company} streaming examples repository]. +For complete source code examples and examples for other languages, see the {astra-streaming-examples-repo}[{company} streaming examples repository]. These examples are written for {astra-stream} but they can be adapted for {luna-streaming} or self-managed {pulsar-short} clusters by replacing the connection details with those for your cluster. [tabs] diff --git a/package.json b/package.json index 01a8959..0f13015 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "homepage": "https://docs.datastax.com", "repository": { "type": "git", - "url": "https://github.com/datastax/starlight-for-rabbitmq-docs.git" + "url": "{product-repo}-docs.git" }, "scripts": { "tailwindcss": "tailwindcss build -c ${npm_config_tailwind_config_path} -i ${npm_config_css_path} -o ${npm_config_css_path} --minify", From b7adef5c754ff82f236a2b3ce8b1bc5eefe497ad Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Mon, 23 Feb 2026 12:01:25 -0800 Subject: [PATCH 5/6] zookeeper --- antora.yml | 4 +++- modules/ROOT/partials/run-as-standalone.adoc | 2 +- modules/configuration/pages/configuration.adoc | 2 +- modules/operations/pages/clustering.adoc | 2 +- modules/operations/pages/metadata-store.adoc | 6 +++--- 5 files changed, 9 insertions(+), 7 deletions(-) diff --git a/antora.yml b/antora.yml index ac57551..72a5717 100644 --- a/antora.yml +++ b/antora.yml @@ -18,4 +18,6 @@ asciidoc: pulsar-short: 'Pulsar' luna-streaming: 'Luna Streaming' astra-stream: 'Astra Streaming' - astra-streaming-examples-repo: 'https://github.com/datastax/astra-streaming-examples' \ No newline at end of file + astra-streaming-examples-repo: 'https://github.com/datastax/astra-streaming-examples' + zookeeper-reg: 'Apache ZooKeeper(TM)' + zookeeper-short: 'ZooKeeper' \ No newline at end of file diff --git a/modules/ROOT/partials/run-as-standalone.adoc b/modules/ROOT/partials/run-as-standalone.adoc index d5c0eac..29fd9e1 100644 --- a/modules/ROOT/partials/run-as-standalone.adoc +++ b/modules/ROOT/partials/run-as-standalone.adoc @@ -12,7 +12,7 @@ tar xvfz starlight-rabbitmq-**VERSION**-all.tar.gz + The path to the `jar` file is `/starlight-rabbitmq/target/starlight-rabbitmq-**VERSION**-jar-with-dependencies.jar`. + -. In a configuration file, set the URLs of the {pulsar-short} brokers and the Apache ZooKeeper(TM) configuration store. +. In a configuration file, set the URLs of the {pulsar-short} brokers and the {zookeeper-reg} configuration store. For example: + [source,conf] diff --git a/modules/configuration/pages/configuration.adoc b/modules/configuration/pages/configuration.adoc index d451ac5..e33724c 100644 --- a/modules/configuration/pages/configuration.adoc +++ b/modules/configuration/pages/configuration.adoc @@ -18,7 +18,7 @@ The way {product} reads the configuration file depends on how you are running {p |`configurationStoreServers` | -|Apache ZooKeeper(TM) configuration store connection string as a comma-separated list. +|{zookeeper-reg} configuration store connection string as a comma-separated list. |`amqpListeners` |`amqp://127.0.0.1:5672` diff --git a/modules/operations/pages/clustering.adoc b/modules/operations/pages/clustering.adoc index 1ab3066..de4d87e 100644 --- a/modules/operations/pages/clustering.adoc +++ b/modules/operations/pages/clustering.adoc @@ -2,7 +2,7 @@ Multiple {product} instances can be launched at the same time for scalability and high availability needs. The {product} instances are stateless and can be started and stopped at will. -They share their configuration in ZooKeeper so you can create, delete, bind, and unbind exchanges and queues on any {product} instance. +They share their configuration in {zookeeper-reg} so you can create, delete, bind, and unbind exchanges and queues on any {product} instance. The configuration is synchronized on the other {product} instances. Publishing messages can be done on any {product} instance. diff --git a/modules/operations/pages/metadata-store.adoc b/modules/operations/pages/metadata-store.adoc index 1026130..12e3368 100644 --- a/modules/operations/pages/metadata-store.adoc +++ b/modules/operations/pages/metadata-store.adoc @@ -1,6 +1,6 @@ = Consistent metadata store :navtitle: Metadata store -{product} uses Apache ZooKeeper(TM) to store the AMQP entities metadata consistently. -The existing ZooKeeper configuration store can be reused to store the {product} metadata. -{product} employs the `/starlight-rabbitmq` prefix to write its entries in ZooKeeper. \ No newline at end of file +{product} uses {zookeeper-reg} to store the AMQP entities metadata consistently. +The existing {zookeeper-short} configuration store can be reused to store the {product} metadata. +{product} employs the `/starlight-rabbitmq` prefix to write its entries in {zookeeper-short}. \ No newline at end of file From 801440cbdee7fe8e057349a2f4b858ab3a68f834 Mon Sep 17 00:00:00 2001 From: "April I. Murphy" <36110273+aimurphy@users.noreply.github.com> Date: Thu, 26 Feb 2026 07:06:35 -0800 Subject: [PATCH 6/6] Apply suggestion from @aimurphy --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 0f13015..01a8959 100644 --- a/package.json +++ b/package.json @@ -6,7 +6,7 @@ "homepage": "https://docs.datastax.com", "repository": { "type": "git", - "url": "{product-repo}-docs.git" + "url": "https://github.com/datastax/starlight-for-rabbitmq-docs.git" }, "scripts": { "tailwindcss": "tailwindcss build -c ${npm_config_tailwind_config_path} -i ${npm_config_css_path} -o ${npm_config_css_path} --minify",