From 380086d44d9b002e7d04d6db9f9aba00f304be30 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 28 Jul 2026 06:41:36 -0700 Subject: [PATCH 1/6] modules for image paths --- modules/components/pages/admin-console-tutorial.adoc | 8 ++++---- modules/components/pages/pulsar-sql.adoc | 4 ++-- .../install-upgrade/pages/production-cluster-sizing.adoc | 2 +- modules/operations/pages/functions.adoc | 8 ++++---- modules/operations/pages/troubleshooting.adoc | 4 ++-- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/modules/components/pages/admin-console-tutorial.adoc b/modules/components/pages/admin-console-tutorial.adoc index 6a6e48a..2d7a468 100644 --- a/modules/components/pages/admin-console-tutorial.adoc +++ b/modules/components/pages/admin-console-tutorial.adoc @@ -9,7 +9,7 @@ In the *{pulsar-short} Admin Console*, you can use {pulsar-short} clients to sen If you installed the Admin console with the xref:install-upgrade:quickstart-helm-installs.adoc[{company} {pulsar-short} Helm chart], access the Admin console via the `pulsar-adminconsole` external load balancer endpoint in your cloud provider: -image::GCP-all-pods.png[GCP Pods] +image::components:GCP-all-pods.png[GCP Pods] Log in with username `admin`. @@ -22,11 +22,11 @@ To try out your service, use the built-in WebSocket test clients on the {pulsar- To see currently available namespaces, go to *Namespaces*, or select the button in the upper right corner. -image::luna-streaming-select-namespace.png[Select Namespace] +image::components:luna-streaming-select-namespace.png[Select Namespace] Messages published to namespaces are automatically replicated to all node(s) in the cluster. -image::luna-streaming-admin-console.png[{product} Admin Console] +image::components:luna-streaming-admin-console.png[{product} Admin Console] For interactive code samples, go to *Code Samples*. @@ -42,7 +42,7 @@ This action creates a connection from the {pulsar-short} Admin Console that's ru Scroll down to the Consume tab. In this simple example, which verifies that the service is running properly, add a `hello world` message and click Send. For example: -image::test-message.png[Send a message using a test client] +image::components:test-message.png[Send a message using a test client] In doing so, you published a message to your server, and in the Test Client you're listening to your own topic. diff --git a/modules/components/pages/pulsar-sql.adoc b/modules/components/pages/pulsar-sql.adoc index 8fedf88..f84b3a9 100644 --- a/modules/components/pages/pulsar-sql.adoc +++ b/modules/components/pages/pulsar-sql.adoc @@ -60,13 +60,13 @@ kubectl port-forward -n datastax-pulsar service/pulsar-broker 8080:8080 . In a browser, navigate to \http://localhost:8081. You will be greeted by Trino's login. + -image::trino-sql-login.png[Trino SQL login] +image::components:trino-sql-login.png[Trino SQL login] . There is no authentication enabled, so input whatever user name you prefer and select **Log In**. You will be greeted by a blank dashboard. This confirms Trino is up and running. + -image::trino-sql-dashboard.png[Trino SQL dashboard] +image::components:trino-sql-dashboard.png[Trino SQL dashboard] [#create-topic] == Fill a topic with the data-generator source diff --git a/modules/install-upgrade/pages/production-cluster-sizing.adoc b/modules/install-upgrade/pages/production-cluster-sizing.adoc index 486b3c1..f272264 100644 --- a/modules/install-upgrade/pages/production-cluster-sizing.adoc +++ b/modules/install-upgrade/pages/production-cluster-sizing.adoc @@ -61,7 +61,7 @@ Scale the workers based on overall usage (both CPU and memory). * xref:luna-streaming:components:heartbeat-vm.adoc[{pulsar-short} Heartbeat] - This is an optional component that monitors the health of {pulsar-short} cluster and emits metrics about the cluster that are helpful for observing and debugging issues. * Prometheus/Grafana/Alert manager stack - This is the default observability stack for a cluster. The {company} {pulsar-short} Helm chart includes pre-made dashboards in Grafana and pre-wires all the metrics scraping. -image::pulsar-components.png[] +image::install-upgrade:pulsar-components.png[] [#message-retention] == Message retention diff --git a/modules/operations/pages/functions.adoc b/modules/operations/pages/functions.adoc index 899f55c..4ab31c3 100644 --- a/modules/operations/pages/functions.adoc +++ b/modules/operations/pages/functions.adoc @@ -187,7 +187,7 @@ If the {pulsar-short} Admin Console is deployed, you can also add and manage the In this example, we chose `exclamation_function.py`. Choose the file you want to pull the function from and which function you want to use within that file. + -image:admin-console-add-function.png[Add Function in Admin Console] +image::operations:admin-console-add-function.png[Add Function in Admin Console] + To specify the class name, it depends on the programming language or runtime of the function. Python, Java, and Go functions are added differently from each other. @@ -220,14 +220,14 @@ You have created a function for this namespace. You can confirm your function wa You can start, stop, and restart your function by selecting *Manage* in the *Functions* dashboard. -image::admin-console-function-added.png[Manage Functions] +image::operations:admin-console-function-added.png[Manage Functions] === Monitor your function Functions produce logs to help you in debugging. To view your function's logs, select *Logs* in the *Manage* dashboard. -image::admin-console-logs.png[Function Log] +image::operations:admin-console-logs.png[Function Log] === Update your function @@ -253,7 +253,7 @@ A *Function-name Deleted Successfully!* flag will appear to let you know you've To trigger a function in the {pulsar-short} Admin Console, select *Trigger* in the *Manage* dashboard. -image::admin-console-trigger-function.png[Trigger Function] +image::operations:admin-console-trigger-function.png[Trigger Function] Enter your message in the *Message to Send* field, and select the output topic. In this case, the trigger sends the string `Hello world!` to your exclamation function with no output function. diff --git a/modules/operations/pages/troubleshooting.adoc b/modules/operations/pages/troubleshooting.adoc index b69ec45..2a6abcb 100644 --- a/modules/operations/pages/troubleshooting.adoc +++ b/modules/operations/pages/troubleshooting.adoc @@ -9,7 +9,7 @@ You can check quotas in the cloud provider's user interface. For example, in the Google Cloud (GCP) console, check for any unhealthy pods in your GKE project. Then in the *IAM & Admin* section of the GCP console, navigate to *Quotas*. Look for any reported issues with backend services: -image::gcp-quota-example1.png[GCP Quota] +image::operations:gcp-quota-example1.png[GCP Quota] From the GCP Console *Quotas* page: @@ -28,7 +28,7 @@ From the GCP Console *Quotas* page: In the following example, the Backend services quota is set to '5', and the requested limit is '50'. For K8ssandra deployments, such as Stargate, cass-operator, Reaper, and Medusa, `10` might be a sufficient quota. -image::gcp-quota-example2.png[GCP Backend Quota] +image::operations:gcp-quota-example2.png[GCP Backend Quota] [#containerspending] == Containers in Pending state From 0fc6461ddaafbabdc2cd056165f5a9bb1c6e6429 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 28 Jul 2026 06:45:02 -0700 Subject: [PATCH 2/6] modules in include paths --- modules/ROOT/pages/faqs.adoc | 2 +- modules/ROOT/pages/index.adoc | 2 +- modules/components/pages/pulsar-beam.adoc | 4 ++-- modules/components/pages/pulsar-sql.adoc | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/modules/ROOT/pages/faqs.adoc b/modules/ROOT/pages/faqs.adoc index fa53889..bc95f9a 100644 --- a/modules/ROOT/pages/faqs.adoc +++ b/modules/ROOT/pages/faqs.adoc @@ -10,7 +10,7 @@ If you are new to {product} and its {pulsar} enhancements, these FAQs are for yo == Are {product} and {company} Luna Streaming the same offering? Yes. -include::partial$luna-name.adoc[] +include::ROOT:partial$luna-name.adoc[] == What components and features are provided by {product}? diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 2f03dfc..7800de0 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -5,7 +5,7 @@ {product} provides all of the core capabilities included in the Apache Community version of {pulsar}, plus a number of additional tools and features to facilitate administration and operational tasks associated with running {pulsar} in production. -include::partial$luna-name.adoc[] +include::ROOT:partial$luna-name.adoc[] == Release notes diff --git a/modules/components/pages/pulsar-beam.adoc b/modules/components/pages/pulsar-beam.adoc index 9f4e296..97ca9b7 100644 --- a/modules/components/pages/pulsar-beam.adoc +++ b/modules/components/pages/pulsar-beam.adoc @@ -22,7 +22,7 @@ In this guide, you'll install a minimal {company} {pulsar-short} Helm chart that == Install the {company} {pulsar-short} Helm chart -include::partial$install-helm.adoc[] +include::components:partial$install-helm.adoc[] == Forward service port @@ -155,7 +155,7 @@ The payload is base64 encoded. Simply decode the string to see the actual messag == Clean up -include::partial$cleanup-terminal-and-helm.adoc[] +include::components:partial$cleanup-terminal-and-helm.adoc[] == Next steps diff --git a/modules/components/pages/pulsar-sql.adoc b/modules/components/pages/pulsar-sql.adoc index f84b3a9..fcd2327 100644 --- a/modules/components/pages/pulsar-sql.adoc +++ b/modules/components/pages/pulsar-sql.adoc @@ -33,7 +33,7 @@ The Trino CLI uses the "X-TRINO-USER" header for authentications. == Install the {company} {pulsar-short} Helm chart -include::partial$install-helm.adoc[] +include::components:partial$install-helm.adoc[] == Forward service port @@ -284,7 +284,7 @@ Connection established...... == Clean up -include::partial$cleanup-terminal-and-helm.adoc[] +include::components:partial$cleanup-terminal-and-helm.adoc[] == Next steps From bbfe115fa2f06002f8bedd9c92b5b7fe7b52db18 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 28 Jul 2026 06:51:40 -0700 Subject: [PATCH 3/6] modules and anchors --- modules/ROOT/pages/index.adoc | 2 +- modules/components/pages/admin-console-tutorial.adoc | 4 ++-- modules/components/pages/heartbeat-vm.adoc | 2 +- modules/components/pages/pulsar-beam.adoc | 2 +- modules/components/pages/pulsar-sql.adoc | 4 ++-- .../pages/cluster-sizing-reference.adoc | 2 +- .../pages/production-cluster-sizing.adoc | 4 ++-- .../pages/quickstart-helm-installs.adoc | 10 ++++++---- 8 files changed, 16 insertions(+), 14 deletions(-) diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 7800de0..8510080 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -64,4 +64,4 @@ In addition to the distribution of https://pulsar.apache.org/en/versions/[{pulsa * If you have an existing Kubernetes environment, deploy {product} with a xref:install-upgrade:quickstart-helm-installs.adoc[Helm Installation]. * If you have a bare metal or a cloud environment, see xref:install-upgrade:quickstart-server-installs.adoc[Server/VM Installation]. * If you want to learn about monitoring with {pulsar-short} Heartbeat, see xref:components:pulsar-monitor.adoc[{pulsar-short} Heartbeat]. -* If you have questions about {product}, see xref::faqs.adoc[{product} FAQs]. \ No newline at end of file +* If you have questions about {product}, see xref:ROOT:faqs.adoc[{product} FAQs]. \ No newline at end of file diff --git a/modules/components/pages/admin-console-tutorial.adoc b/modules/components/pages/admin-console-tutorial.adoc index 2d7a468..5af0286 100644 --- a/modules/components/pages/admin-console-tutorial.adoc +++ b/modules/components/pages/admin-console-tutorial.adoc @@ -13,7 +13,7 @@ image::components:GCP-all-pods.png[GCP Pods] Log in with username `admin`. -If you're running a xref:install-upgrade:quickstart-server-installs.adoc[server or VM] deployment, see xref:admin-console-vm.adoc[Admin Console on Server/VM] for instructions on deploying and accessing the Admin console. +If you're running a xref:install-upgrade:quickstart-server-installs.adoc[server or VM] deployment, see xref:components:admin-console-vm.adoc[Admin Console on Server/VM] for instructions on deploying and accessing the Admin console. [#features] == {pulsar-short} Admin Console features @@ -145,4 +145,4 @@ Alternatively, you can save the URL authentication parameters in your `client.co == Next steps -For more on building and running a standalone {pulsar-short} Admin console, see the xref:admin-console-vm.adoc[Admin Console on Server/VM] or the {pulsar-short} Admin console repo {pulsar-admin-console-repo}#dev[readme]. \ No newline at end of file +For more on building and running a standalone {pulsar-short} Admin console, see the xref:components:admin-console-vm.adoc[Admin Console on Server/VM] or the {pulsar-short} Admin console repo {pulsar-admin-console-repo}#dev[readme]. \ No newline at end of file diff --git a/modules/components/pages/heartbeat-vm.adoc b/modules/components/pages/heartbeat-vm.adoc index 06b45d4..df88c16 100644 --- a/modules/components/pages/heartbeat-vm.adoc +++ b/modules/components/pages/heartbeat-vm.adoc @@ -39,4 +39,4 @@ export PULSAR_OPS_MONITOR_CFG=/Users/username/go/src/github.com/datastax/pulsar- == Next steps -Learn more about monitoring your cluster with Heartbeat, see xref:pulsar-monitor.adoc[]. \ No newline at end of file +Learn more about monitoring your cluster with Heartbeat, see xref:components:pulsar-monitor.adoc[]. \ No newline at end of file diff --git a/modules/components/pages/pulsar-beam.adoc b/modules/components/pages/pulsar-beam.adoc index 97ca9b7..2b07434 100644 --- a/modules/components/pages/pulsar-beam.adoc +++ b/modules/components/pages/pulsar-beam.adoc @@ -163,4 +163,4 @@ Here are links to resources and guides you might be interested in: * {pulsar-beam-repo}[Learn more] about the {pulsar-beam} project * https://kafkaesque-io.github.io/pulsar-beam-swagger[{pulsar-beam} API] -* xref:pulsar-sql.adoc[] \ No newline at end of file +* xref:components:pulsar-sql.adoc[] \ No newline at end of file diff --git a/modules/components/pages/pulsar-sql.adoc b/modules/components/pages/pulsar-sql.adoc index fcd2327..2a169fe 100644 --- a/modules/components/pages/pulsar-sql.adoc +++ b/modules/components/pages/pulsar-sql.adoc @@ -288,5 +288,5 @@ include::components:partial$cleanup-terminal-and-helm.adoc[] == Next steps -* xref:pulsar-beam.adoc[] -* xref:admin-console-tutorial.adoc[] \ No newline at end of file +* xref:components:pulsar-beam.adoc[] +* xref:components:admin-console-tutorial.adoc[] \ No newline at end of file diff --git a/modules/install-upgrade/pages/cluster-sizing-reference.adoc b/modules/install-upgrade/pages/cluster-sizing-reference.adoc index 727eaf5..6e3c371 100644 --- a/modules/install-upgrade/pages/cluster-sizing-reference.adoc +++ b/modules/install-upgrade/pages/cluster-sizing-reference.adoc @@ -146,4 +146,4 @@ a|* CPU: 4 vCPU == Next steps -For more on cluster sizing, see xref:production-cluster-sizing.adoc[]. \ No newline at end of file +For more on cluster sizing, see xref:install-upgrade:production-cluster-sizing.adoc[]. \ No newline at end of file diff --git a/modules/install-upgrade/pages/production-cluster-sizing.adoc b/modules/install-upgrade/pages/production-cluster-sizing.adoc index f272264..c296687 100644 --- a/modules/install-upgrade/pages/production-cluster-sizing.adoc +++ b/modules/install-upgrade/pages/production-cluster-sizing.adoc @@ -6,7 +6,7 @@ Remember, a {pulsar-short} *instance* is made of one or many clusters. Of course, the sizing of a cluster depends on factors like use case and expected load, so this document is not intended to be a one-size-fits-all guide. Rather, we'd like to demonstrate how we consider and spec the initial size of a {pulsar-short} cluster, and assist you on your journey to unlocking the scaling power of {pulsar-short}. This page summarizes the requirements, assumptions, definitions, and methodologies that inform our cluster sizing recommendations. -If you're looking for specific deployment topology recommendations, see xref:cluster-sizing-reference.adoc[]. +If you're looking for specific deployment topology recommendations, see xref:install-upgrade:cluster-sizing-reference.adoc[]. include::operations:partial$operator-scaling.adoc[] @@ -235,4 +235,4 @@ Now that we know how many server instances of broker and bookie are required to == Next steps -See xref:cluster-sizing-reference.adoc[] for specific deployment topologies and hardware recommendations. \ No newline at end of file +See xref:install-upgrade:cluster-sizing-reference.adoc[] for specific deployment topologies and hardware recommendations. \ No newline at end of file diff --git a/modules/install-upgrade/pages/quickstart-helm-installs.adoc b/modules/install-upgrade/pages/quickstart-helm-installs.adoc index 092ec63..1e717cf 100644 --- a/modules/install-upgrade/pages/quickstart-helm-installs.adoc +++ b/modules/install-upgrade/pages/quickstart-helm-installs.adoc @@ -34,13 +34,13 @@ It is designed for production use, but can also be used in local development env The resulting configuration includes support for: -* xref:install-upgrade:quickstart-helm-installs.adoc#tls[TLS] -* xref:install-upgrade:quickstart-helm-installs.adoc#authentication[Authentication] +* <> +* <> * WebSocket proxy * Standalone Functions Workers * {pulsar-short} I/O connectors -* xref:install-upgrade:quickstart-helm-installs.adoc#_tiered_storage_configuration[Tiered storage] including Tardigarde distributed cloud storage -* xref:install-upgrade:quickstart-helm-installs.adoc#_pulsar_sql_configuration[{pulsar-short} SQL workers] +* <> including Tardigarde distributed cloud storage +* <> * {pulsar-short} Admin Console for managing the cluster * {pulsar-short} Heartbeat * Burnell for API-based token generation @@ -387,12 +387,14 @@ kube-prometheus-stack: create: yes ---- +[#tiered-storage-configuration] ==== Tiered Storage Configuration Tiered storage (offload to blob storage) can be configured in the `storageOffload` section of the `values.yaml` file. Instructions for AWS S3 and Google Cloud Storage are provided in the file. In addition, you can configure any S3 compatible storage. There is explicit support for https://tardigrade.io[Tardigrade], which is a provider of secure, decentralized storage. You can enable the Tardigarde S3 gateway in the `extra` configuration. The instructions for configuring the gateway are provided in the `tardigrade` section of the `values.yaml` file. +[#pulsar-sql-configuration] ==== {pulsar-short} SQL Configuration If you enable {pulsar-short} SQL, the cluster provides https://trino.io/[Trino] access to the data stored in {bookkeeper-short} (and tiered storage, if enabled). Trino is exposed on the service named `-sql`. From 0059b58f5fa2d9b65f3f501cff8a9a114acc429f Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 28 Jul 2026 06:53:32 -0700 Subject: [PATCH 4/6] unnecessary same page anchor --- modules/install-upgrade/pages/quickstart-server-installs.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/install-upgrade/pages/quickstart-server-installs.adoc b/modules/install-upgrade/pages/quickstart-server-installs.adoc index 48459bc..b107598 100644 --- a/modules/install-upgrade/pages/quickstart-server-installs.adoc +++ b/modules/install-upgrade/pages/quickstart-server-installs.adoc @@ -1,6 +1,6 @@ = Quick Start for Bare Metal/VM installs -This document explains xref:install-upgrade:quickstart-server-installs.adoc#install[installation] of {product} for Bare Metal/VM deployments with a {pulsar-short} tarball. +This document explains installation of {product} for Bare Metal/VM deployments with a {pulsar-short} tarball. [NOTE] ==== From 37a283c9f423ae223d3a991053940482aaa67fbd Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 28 Jul 2026 06:58:02 -0700 Subject: [PATCH 5/6] admonitions --- modules/components/pages/admin-console-vm.adoc | 2 +- modules/components/pages/pulsar-beam.adoc | 2 +- modules/components/pages/pulsar-sql.adoc | 8 ++------ modules/connectors/pages/index.adoc | 5 +---- .../install-upgrade/pages/quickstart-helm-installs.adoc | 2 +- .../install-upgrade/pages/quickstart-server-installs.adoc | 2 +- modules/install-upgrade/pages/supported-versions.adoc | 2 +- modules/operations/pages/functions.adoc | 2 +- modules/operations/pages/scale-cluster.adoc | 2 +- 9 files changed, 10 insertions(+), 17 deletions(-) diff --git a/modules/components/pages/admin-console-vm.adoc b/modules/components/pages/admin-console-vm.adoc index 09ad2ba..e36a4e0 100644 --- a/modules/components/pages/admin-console-vm.adoc +++ b/modules/components/pages/admin-console-vm.adoc @@ -55,7 +55,7 @@ You can modify the configuration for the Admin Console in `pulsar-admin-console/ You need to configure `pulsar_url` to point to one of your brokers or a proxy/loadbalancer in front of the brokers (can be {pulsar-short} proxy). The Admin Console server must be able to directly reach each broker by the IP/hostname that is returned by the {pulsar-short} CLI command `pulsar-admin brokers list `. -[NOTE] +[TIP] ==== The cluster name can be retrieved with the CLI command `pulsar-admin clusters list`. ==== diff --git a/modules/components/pages/pulsar-beam.adoc b/modules/components/pages/pulsar-beam.adoc index 2b07434..e05486a 100644 --- a/modules/components/pages/pulsar-beam.adoc +++ b/modules/components/pages/pulsar-beam.adoc @@ -7,7 +7,7 @@ The {pulsar-beam-repo}[{pulsar-beam}] project is an HTTP-based streaming and que With {pulsar-beam}, you can send messages over HTTP, push messages to a webhook or cloud function, chain webhooks and functions together, or stream messages through server-sent events (SSE). -[NOTE] +[TIP] ==== include::ROOT:partial$luna-name.adoc[] ==== diff --git a/modules/components/pages/pulsar-sql.adoc b/modules/components/pages/pulsar-sql.adoc index 2a169fe..7b996d2 100644 --- a/modules/components/pages/pulsar-sql.adoc +++ b/modules/components/pages/pulsar-sql.adoc @@ -9,7 +9,7 @@ Stream processing, real-time analytics, and highly customized dashboards are jus {pulsar-short} offers a pre-made plugin for Trino that is included in its distribution. Additionally, {pulsar-short} has built-in options to create Trino workers and automatically configure the communications between {pulsar-short}'s ledger and Trino. -[NOTE] +[TIP] ==== include::ROOT:partial$luna-name.adoc[] ==== @@ -94,12 +94,8 @@ The CLI will use the environment variable's value as configuration for interacti ./bin/pulsar-admin sources create --name generator --destination-topic-name public/default/mytopic --source-type data-generator ---- + -[NOTE] -==== -The topic name will become a table name in Trino, so SQL naming rules apply. - +The topic name becomes the Trino table name, so SQL naming rules apply. Names can contain only alphanumeric characters and must begin with an alphabetic character or an underscore (_). -==== . Confirm the topic was created: + diff --git a/modules/connectors/pages/index.adoc b/modules/connectors/pages/index.adoc index c542ada..5fd295a 100644 --- a/modules/connectors/pages/index.adoc +++ b/modules/connectors/pages/index.adoc @@ -2,18 +2,15 @@ :navtitle: {pulsar-short} I/O connectors reference :page-aliases: operations:io-connectors.adoc -[NOTE] +[TIP] ==== include::ROOT:partial$luna-name.adoc[] ==== {product} offers fully-managed versions of https://pulsar.apache.org/docs/en/io-overview/[{pulsar-reg} sink and source connectors]. -[TIP] -==== There are three versions of the {product} distribution. The `lunastreaming-all` version includes all connectors. -==== [#sink-connectors] == Sink connectors diff --git a/modules/install-upgrade/pages/quickstart-helm-installs.adoc b/modules/install-upgrade/pages/quickstart-helm-installs.adoc index 1e717cf..a1106bf 100644 --- a/modules/install-upgrade/pages/quickstart-helm-installs.adoc +++ b/modules/install-upgrade/pages/quickstart-helm-installs.adoc @@ -1,6 +1,6 @@ = Quick Start for Helm Chart installs -[IMPORTANT] +[TIP] ==== include::ROOT:partial$luna-name.adoc[] ==== diff --git a/modules/install-upgrade/pages/quickstart-server-installs.adoc b/modules/install-upgrade/pages/quickstart-server-installs.adoc index b107598..5a5a650 100644 --- a/modules/install-upgrade/pages/quickstart-server-installs.adoc +++ b/modules/install-upgrade/pages/quickstart-server-installs.adoc @@ -2,7 +2,7 @@ This document explains installation of {product} for Bare Metal/VM deployments with a {pulsar-short} tarball. -[NOTE] +[TIP] ==== include::ROOT:partial$luna-name.adoc[] ==== diff --git a/modules/install-upgrade/pages/supported-versions.adoc b/modules/install-upgrade/pages/supported-versions.adoc index 6008ed9..693b7d4 100644 --- a/modules/install-upgrade/pages/supported-versions.adoc +++ b/modules/install-upgrade/pages/supported-versions.adoc @@ -2,7 +2,7 @@ Support covers only the following Software versions for {pulsar}: -[NOTE] +[TIP] ==== include::ROOT:partial$luna-name.adoc[] ==== diff --git a/modules/operations/pages/functions.adoc b/modules/operations/pages/functions.adoc index 4ab31c3..ef46adc 100644 --- a/modules/operations/pages/functions.adoc +++ b/modules/operations/pages/functions.adoc @@ -6,7 +6,7 @@ You can apply custom logic to a message, transforming or enriching it, and then Functions run inside {product}, which makes them serverless. -[NOTE] +[TIP] ==== include::ROOT:partial$luna-name.adoc[] ==== diff --git a/modules/operations/pages/scale-cluster.adoc b/modules/operations/pages/scale-cluster.adoc index 36f3280..509aa35 100644 --- a/modules/operations/pages/scale-cluster.adoc +++ b/modules/operations/pages/scale-cluster.adoc @@ -2,7 +2,7 @@ You can scale {product} clusters up for more compute capacity and down for less capacity. -[NOTE] +[TIP] ==== include::ROOT:partial$luna-name.adoc[] ==== From a84984862621cae6e576f941e11306c23f124e99 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 28 Jul 2026 07:18:48 -0700 Subject: [PATCH 6/6] source blocks --- modules/components/pages/pulsar-beam.adoc | 4 ++-- .../pages/production-cluster-sizing.adoc | 8 +++---- .../pages/quickstart-helm-installs.adoc | 24 ++++++++++++++++--- .../pages/quickstart-server-installs.adoc | 4 ++-- modules/operations/pages/scale-cluster.adoc | 4 ++++ modules/operations/pages/troubleshooting.adoc | 8 +++++-- 6 files changed, 39 insertions(+), 13 deletions(-) diff --git a/modules/components/pages/pulsar-beam.adoc b/modules/components/pages/pulsar-beam.adoc index e05486a..cc38acd 100644 --- a/modules/components/pages/pulsar-beam.adoc +++ b/modules/components/pages/pulsar-beam.adoc @@ -36,7 +36,7 @@ kubectl port-forward -n datastax-pulsar service/pulsar-proxy 8085:8085 The forwarding service will map the URL:PORT https://127.0.0.1:8085 to {pulsar-short} proxy running in the new cluster. Because {pulsar-beam} was enabled, the proxy knows to forward on to the {pulsar-beam} service. -[source,shell] +[source,console] ---- Forwarding from 127.0.0.1:8085 -> 8085 Forwarding from [::1]:8085 -> 8085 @@ -74,7 +74,7 @@ curl --request POST \ The message consumer will output the data of the new message just produced. -[source,shell] +[source,console] ---- id: {9 0 0 0 0xc002287ad0} data: Hi there diff --git a/modules/install-upgrade/pages/production-cluster-sizing.adoc b/modules/install-upgrade/pages/production-cluster-sizing.adoc index c296687..bfac557 100644 --- a/modules/install-upgrade/pages/production-cluster-sizing.adoc +++ b/modules/install-upgrade/pages/production-cluster-sizing.adoc @@ -155,7 +155,7 @@ But (very important) we want the message replication factor to be an odd number, . Multiply replication factor (3) by average message payload size (1) by average message throughput (100000), then factor in TTL (3) and retention period (3600) (when applicable). + -[source,plaintext] +[source,console] ---- Total message size (raw) = 3 * // replication factor @@ -168,9 +168,9 @@ Total message size (raw) = + We now know our cluster needs 3 Tb of storage for {bookkeeper-short} ledger data. -. Calculate the number of {bookkeeper-short} nodes with an individual ledger disk capacity. +. Calculate the number of {bookkeeper-short} nodes with an individual ledger disk capacity: + -[source,plain,subs="+attributes"] +[source,console,subs="+attributes"] ---- {bookkeeper-short} count(raw)=ceiling(3/(4 * 0.85)) = 1 ---- @@ -180,7 +180,7 @@ For fault tolerance, we adjust this to a number that is divisible by the number . Given the replication factor of 3, we will need at least 1 broker to write messages to the bookies. That gives us a broker-to-{bookkeeper-short} ratio of 1:3. Now we can calculate the total number of brokers across 3 zones. + -[source,plain] +[source,console] ---- broker count(raw)=ceiling(1/3) = 1 ---- diff --git a/modules/install-upgrade/pages/quickstart-helm-installs.adoc b/modules/install-upgrade/pages/quickstart-helm-installs.adoc index a1106bf..777b6f7 100644 --- a/modules/install-upgrade/pages/quickstart-helm-installs.adoc +++ b/modules/install-upgrade/pages/quickstart-helm-installs.adoc @@ -272,7 +272,10 @@ Example of checking the pods' status: [source,shell] ---- kubectl get pods +---- +[source,console] +---- NAME READY STATUS RESTARTS AGE prometheus-pulsar-kube-prometheus-sta-prometheus-0 2/2 Running 1 10m pulsar-adminconsole-9669f6d98-dxjvp 2/2 Running 3 12m @@ -405,9 +408,13 @@ The easiest way to access the Trino command line is to log into the bastion host Where the value for the `server` option should be the service name plus port. Once you are connected, you can enter Trino commands. Example: -[source,console] +[source,shell] ---- trino> SELECT * FROM system.runtime.nodes; +---- + +[source,console] +---- node_id | http_uri | node_version | coordinator | state --------------------------------------+--------------------------+--------------+-------------+-------- 64b7c5a1-9a72-4598-b494-b140169abc55 | http://10.244.5.164:8080 | 0.206 | true | active @@ -425,11 +432,22 @@ It is recommended that you match the Trino CLI version to the version running as The Trino CLI supports basic authentication, so if you enabled that on the Ingress (using annotations), you can have secure Trino access. Example: -[source,sql] +Connect: + +[source,shell] ---- trino --server https://trino.example.com --user admin --password -Password: +---- + +Enter password when prompted, and then get catalogs: + +[source,shell] +---- trino> show catalogs; +---- + +[source,console] +---- Catalog --------- pulsar diff --git a/modules/install-upgrade/pages/quickstart-server-installs.adoc b/modules/install-upgrade/pages/quickstart-server-installs.adoc index 5a5a650..1da981b 100644 --- a/modules/install-upgrade/pages/quickstart-server-installs.adoc +++ b/modules/install-upgrade/pages/quickstart-server-installs.adoc @@ -72,9 +72,9 @@ tar xzvf lunastreaming-3.1.3.0-bin.tar.gz cd lunastreaming-3.1.3.0 ---- -. Enter `ls -al` to view your {product} files: +. Run `ls -al` to view your {product} files: + -[source,bash] +[source,console] ---- ➜ lunastreaming-3.1.3.0 ls -al total 88 diff --git a/modules/operations/pages/scale-cluster.adoc b/modules/operations/pages/scale-cluster.adoc index 509aa35..e85186c 100644 --- a/modules/operations/pages/scale-cluster.adoc +++ b/modules/operations/pages/scale-cluster.adoc @@ -22,6 +22,10 @@ To start the cluster, use the values provided in the {pulsar-helm-chart-repo}/bl [source,bash] ---- diff ~/dev-values.yaml ~/dev-values_large.yaml +---- + +[source,console] +---- 40c40,47 < replicaCount: 1 --- diff --git a/modules/operations/pages/troubleshooting.adoc b/modules/operations/pages/troubleshooting.adoc index 2a6abcb..9279e48 100644 --- a/modules/operations/pages/troubleshooting.adoc +++ b/modules/operations/pages/troubleshooting.adoc @@ -65,8 +65,12 @@ pulsar@pulsar-bastion-78d4cd74ff-ctvvh:/pulsar$ === Test bastion pod -To verify that your bastion pod sees your cluster, run `pulsar admin namespaces list public`. -It should return a list of your public namespaces: +To verify that your bastion pod sees your cluster, run the following command to get a list of your public namespaces: + +[source,bash] +---- +pulsar admin namespaces list public +---- [source,console] ----