From 2ca185b339590b45700a2fca3c31b71e53945d9f Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 10 Mar 2026 11:26:06 -0700 Subject: [PATCH 1/6] pulsar helm chart, burnell deprecated --- antora.yml | 2 +- modules/ROOT/pages/faqs.adoc | 7 +++---- .../install-upgrade/pages/quickstart-helm-installs.adoc | 8 ++++++++ modules/install-upgrade/pages/upgrade-guide.adoc | 6 ++++++ modules/operations/pages/scale-cluster.adoc | 8 ++++++-- 5 files changed, 24 insertions(+), 7 deletions(-) diff --git a/antora.yml b/antora.yml index 611cdeb..8dedf0c 100644 --- a/antora.yml +++ b/antora.yml @@ -35,7 +35,7 @@ asciidoc: pulsar-heartbeat-repo: 'https://github.com/datastax/pulsar-heartbeat' pulsar-sink-repo: 'https://github.com/datastax/pulsar-sink' pulsar-ansible-repo: 'https://github.com/datastax/pulsar-ansible' - pulsar-helm-chart-repo: 'https://github.com/datastax/pulsar-helm-chart' + pulsar-helm-chart-repo: 'https://github.com/datastax/pulsar-helm-chart' # deprecated, use kaap-operator-repo, kaap, and kaap-short instead pulsar-openid-connect-repo: 'https://github.com/datastax/pulsar-openid-connect-plugin' pulsar-repo: 'https://github.com/datastax/pulsar' pulsar-beam-repo: 'https://github.com/kafkaesque-io/pulsar-beam' diff --git a/modules/ROOT/pages/faqs.adoc b/modules/ROOT/pages/faqs.adoc index a02beef..ae57949 100644 --- a/modules/ROOT/pages/faqs.adoc +++ b/modules/ROOT/pages/faqs.adoc @@ -38,12 +38,11 @@ They include Minikube, K8d, Kind, Google Kubernetes Engine (GKE), Microsoft Azur There are several public repos, each with a different purpose. See: -* {pulsar-repo}[{pulsar-repo}] : This is the distro repo (a fork of apache/pulsar). +* {pulsar-repo}[{pulsar-repo}] : This is the distro repo (a fork of `apache/pulsar`). * {pulsar-admin-console-repo}[{pulsar-admin-console-repo}] : This is the repo for the {pulsar-short} admin console, which allows for the configuration and monitoring of {pulsar-short}. * {pulsar-heartbeat-repo}[{pulsar-heartbeat-repo}] : This is a monitoring/observability tool for {pulsar-short} that tracks the health of the cluster and can generate alerts in Slack and OpsGenie. -* {pulsar-helm-chart-repo}[{pulsar-helm-chart-repo}] : This is the Helm chart for deploying the {company} {pulsar-short} Distro in an existing Kubernetes cluster. +* {kaap-operator-repo}[{kaap-operator-repo}] : This is the utility for deploying the {company} {pulsar-short} Distro in an existing Kubernetes cluster. * {pulsar-sink-repo}[{pulsar-sink-repo}] : This is the {company} {pulsar} Connector (`pulsar-sink`) repo. -* https://github.com/datastax/burnell[https://github.com/datastax/burnell] : This is a utility for {pulsar-short} that provides various functions, such as key initialization for authentication, and JWT token creation API. == Is there a prerequisite version of Java needed for the {company} {product} installation? @@ -52,7 +51,7 @@ The {company} {product} distribution is designed for Java 17. However, because t == What are the install options for {company} {product}? * **{kaap-short} Helm chart (Recommended)**: Use the {company} {kaap-operator-repo}[{kaap-short} Helm chart], which provides Kubernetes-native autoscaling and simplified management for {pulsar} clusters. For more information, see the xref:kaap-operator::index.adoc[{kaap}] documentation. -* **{product} Helm chart**: Use the Helm chart provided at {pulsar-helm-chart-repo}[{pulsar-helm-chart-repo}] to install {company} {product} in an existing Kubernetes cluster on your laptop or hosted by a cloud provider. +* **{product} Helm chart (Deprecated)**: The Helm chart provided at {pulsar-helm-chart-repo}[{pulsar-helm-chart-repo}] is deprecated and no longer maintained. Use the {kaap-short} instead. * **Tarball**: Use the tarball provided at {pulsar-repo}/releases[{pulsar-repo}/releases] to install {company} {product} on a server or VM. * **Ansible**: Use the {company} Ansible scripts provided at {pulsar-ansible-repo}[{pulsar-ansible-repo}] to install {company} {product} on a server or VM with our provided playbooks. diff --git a/modules/install-upgrade/pages/quickstart-helm-installs.adoc b/modules/install-upgrade/pages/quickstart-helm-installs.adoc index 17cadf2..0f3eb01 100644 --- a/modules/install-upgrade/pages/quickstart-helm-installs.adoc +++ b/modules/install-upgrade/pages/quickstart-helm-installs.adoc @@ -8,7 +8,15 @@ The {company} production-ready Helm chart is now deprecated. For new deployments You have options for installing *{company} {product}*: * With the provided *{company} Helm chart* for an existing Kubernetes environment locally or with a cloud provider, as covered in this topic. ++ +[IMPORTANT] +==== +The {pulsar-helm-chart-repo}[{company} Pulsar Helm chart] is deprecated. +For Kubernetes deployments, use xref:kaap-operator::index.adoc[{kaap}] instead. +==== + * With the *{company} {product} tarball* for deployment to a single server/VM, or to multiple servers/VMs. See xref:install-upgrade:quickstart-server-installs.adoc[Quick Start for Server/VM installs]. + * With the *{company} Ansible scripts* provided at {pulsar-ansible-repo}[{pulsar-ansible-repo}]. The Helm chart and options described below configure an {pulsar} cluster. diff --git a/modules/install-upgrade/pages/upgrade-guide.adoc b/modules/install-upgrade/pages/upgrade-guide.adoc index f7320c2..ec534ad 100644 --- a/modules/install-upgrade/pages/upgrade-guide.adoc +++ b/modules/install-upgrade/pages/upgrade-guide.adoc @@ -353,6 +353,12 @@ kubectl logs *POD-NAME* -n *NAMESPACE* === Upgrade Kubernetes deployment with Helm chart +[IMPORTANT] +==== +The {pulsar-helm-chart-repo}[{company} Pulsar Helm chart] is deprecated. +For Kubernetes deployments, use xref:kaap-operator::index.adoc[{kaap}] instead. +==== + The Helm chart for {product} is available in the {pulsar-helm-chart-repo}/blob/master/helm-chart-sources/pulsar/values.yaml[Helm chart sources] repository. . To prevent data loss, back up your existing {pulsar-short} data and configuration files. diff --git a/modules/operations/pages/scale-cluster.adoc b/modules/operations/pages/scale-cluster.adoc index bff4a36..2ea1b31 100644 --- a/modules/operations/pages/scale-cluster.adoc +++ b/modules/operations/pages/scale-cluster.adoc @@ -6,9 +6,13 @@ include::operations:partial$operator-scaling.adoc[] == Install {pulsar-short} cluster -For our {pulsar-short} cluster installation, use this {pulsar-helm-chart-repo}[Helm chart]. +[IMPORTANT] +==== +The {pulsar-helm-chart-repo}[{company} Pulsar Helm chart] is deprecated. +For Kubernetes deployments, use xref:kaap-operator::index.adoc[{kaap}] instead. +==== -To start the cluster, use the values provided in this {pulsar-helm-chart-repo}/blob/master/examples/dev-values.yaml[YAML file]: +To start the cluster, use the values provided in the {pulsar-helm-chart-repo}/blob/master/examples/dev-values.yaml[{company} Pulsar values YAML file]: [source,bash] ---- From 71bd35bae01067c86fb746c79018e48fd15ef950 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 10 Mar 2026 11:38:39 -0700 Subject: [PATCH 2/6] remove dependency on luna-streaming-examples --- .../components/attachments/beam/values.yaml | 71 +++++++++++++++++++ modules/components/attachments/client.conf | 50 +++++++++++++ .../components/attachments/sql/values.yaml | 50 +++++++++++++ modules/components/pages/pulsar-beam.adoc | 2 +- modules/components/pages/pulsar-sql.adoc | 16 ++--- modules/components/partials/install-helm.adoc | 14 ++-- 6 files changed, 181 insertions(+), 22 deletions(-) create mode 100644 modules/components/attachments/beam/values.yaml create mode 100644 modules/components/attachments/client.conf create mode 100644 modules/components/attachments/sql/values.yaml diff --git a/modules/components/attachments/beam/values.yaml b/modules/components/attachments/beam/values.yaml new file mode 100644 index 0000000..8cf4bf9 --- /dev/null +++ b/modules/components/attachments/beam/values.yaml @@ -0,0 +1,71 @@ +extra: + broker: false + brokerSts: true + pulsarBeam: true + proxy: true + wsproxy: false + bastion: false + +zookeeper: + replicaCount: 1 + +bookkeeper: + replicaCount: 1 + +broker: + component: "broker" # this has to match brokerSts naming + replicaCount: 0 + +brokerSts: + component: "broker" # this has to match broker naming + replicaCount: 1 + functionsWorkerEnabled: true # to overcome the need for functions working + ledger: # the default assumes 2 bookies but this chart only deploys 1 + defaultEnsembleSize: 1 + defaultAckQuorum: 1 + defaultWriteQuorum: 1 + +# this is a legacy value that the beam sub-chart uses +tokenServer: + allowedRoles: superuser,admin,websocket,proxy + +proxy: + component: "proxy" + replicaCount: 1 + service: + ports: + - name: "pulsarbeam" + port: 8085 + protocol: TCP + - name: "http" + port: 8080 + protocol: TCP + - name: "pulsar" + port: 6650 + protocol: TCP + +pulsarBeam: + component: "pulsarbeam" + replicaCount: 1 + +image: + proxy: + repository: datastax/lunastreaming + pullPolicy: IfNotPresent + tag: 2.10_2.4 + brokerSts: + repository: datastax/lunastreaming + pullPolicy: IfNotPresent + tag: 2.10_2.4 + zookeeper: + repository: datastax/lunastreaming + pullPolicy: IfNotPresent + tag: 2.10_2.4 + bookkeeper: + repository: datastax/lunastreaming + pullPolicy: IfNotPresent + tag: 2.10_2.4 + pulsarBeam: + repository: kesque/pulsar-beam + pullPolicy: IfNotPresent + tag: "1.0.0" \ No newline at end of file diff --git a/modules/components/attachments/client.conf b/modules/components/attachments/client.conf new file mode 100644 index 0000000..30ccead --- /dev/null +++ b/modules/components/attachments/client.conf @@ -0,0 +1,50 @@ +# Configuration for pulsar-client and pulsar-admin CLI tools + +# URL for Pulsar REST API (for admin operations) +# For TLS: +# webServiceUrl=https://localhost:8443/ +webServiceUrl=http://127.0.0.1:8080/ + +# URL for Pulsar Binary Protocol (for produce and consume operations) +# For TLS: +# brokerServiceUrl=pulsar+ssl://localhost:6651/ +brokerServiceUrl=pulsar://127.0.0.1:6650/ + +# Authentication plugin to authenticate with servers +# e.g. for TLS +# authPlugin=org.apache.pulsar.client.impl.auth.AuthenticationTls +authPlugin= + +# Parameters passed to authentication plugin. +# A comma separated list of key:value pairs. +# Keys depend on the configured authPlugin. +# e.g. for TLS +# authParams=tlsCertFile:/path/to/client-cert.pem,tlsKeyFile:/path/to/client-key.pem +authParams= + +# Allow TLS connections to servers whose certificate cannot be +# be verified to have been signed by a trusted certificate +# authority. +tlsAllowInsecureConnection=false + +# Whether server hostname must match the common name of the certificate +# the server is using. +tlsEnableHostnameVerification=false + +# Path for the trusted TLS certificate file. +# This cert is used to verify that any cert presented by a server +# is signed by a certificate authority. If this verification +# fails, then the cert is untrusted and the connection is dropped. +tlsTrustCertsFilePath= + +# Enable TLS with KeyStore type configuration in broker. +useKeyStoreTls=false + +# TLS KeyStore type configuration: JKS, PKCS12 +tlsTrustStoreType=JKS + +# TLS TrustStore path +tlsTrustStorePath= + +# TLS TrustStore password +tlsTrustStorePassword= \ No newline at end of file diff --git a/modules/components/attachments/sql/values.yaml b/modules/components/attachments/sql/values.yaml new file mode 100644 index 0000000..4986a0d --- /dev/null +++ b/modules/components/attachments/sql/values.yaml @@ -0,0 +1,50 @@ +extra: + broker: false + brokerSts: true + pulsarSQL: true + proxy: false + wsproxy: false + bastion: false + +pulsarSQL: + server: + workers: 1 + service: + type: ClusterIP + +zookeeper: + replicaCount: 1 + +bookkeeper: + replicaCount: 1 + +broker: + component: "broker" # this has to match brokerSts naming due to a bug + replicaCount: 0 + +brokerSts: + component: "broker" # this has to match broker naming due to a bug + replicaCount: 1 + functionsWorkerEnabled: true # to overcome the need for functions working + ledger: # the default assumes 2 bookies but this chart only deploys 1 + defaultEnsembleSize: 1 + defaultAckQuorum: 1 + defaultWriteQuorum: 1 + +image: + brokerSts: + repository: datastax/lunastreaming-all #because we want connectors too + pullPolicy: IfNotPresent + tag: 2.10_2.4 + zookeeper: + repository: datastax/lunastreaming + pullPolicy: IfNotPresent + tag: 2.10_2.4 + bookkeeper: + repository: datastax/lunastreaming + pullPolicy: IfNotPresent + tag: 2.10_2.4 + pulsarSQL: + repository: datastax/lunastreaming + tag: 2.10_2.4 + pullPolicy: IfNotPresent \ No newline at end of file diff --git a/modules/components/pages/pulsar-beam.adoc b/modules/components/pages/pulsar-beam.adoc index fb1f509..4b5b057 100644 --- a/modules/components/pages/pulsar-beam.adoc +++ b/modules/components/pages/pulsar-beam.adoc @@ -1,7 +1,7 @@ = {pulsar-beam} with {product} :navtitle: {pulsar-beam} :description: Install a minimal {product} Helm chart that includes {pulsar-beam} -:helmValuesPath: https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/beam/values.yaml +:helmValuesPath: beam The {pulsar-beam-repo}[{pulsar-beam}] project is an HTTP-based streaming and queueing system for use with {pulsar}. diff --git a/modules/components/pages/pulsar-sql.adoc b/modules/components/pages/pulsar-sql.adoc index 167974d..f969235 100644 --- a/modules/components/pages/pulsar-sql.adoc +++ b/modules/components/pages/pulsar-sql.adoc @@ -1,7 +1,7 @@ = Using {pulsar-short} SQL with {product} :navtitle: {pulsar-short} SQL :description: This guide installs the {product} Helm chart using minimum values for a working {pulsar-short} cluster that includes SQL workers -:helmValuesPath: https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/pulsar-sql/values.yaml +:helmValuesPath: sql {pulsar-short} SQL allows enterprises to query {pulsar} topic data with SQL. This is a powerful feature for an Enterprise, and SQL is a language they're likely familiar with. @@ -71,20 +71,14 @@ The minimalist Helm chart values use the https://github.com/datastax/release-not This example uses the "public" tenant and "default" namespace. These are created by default in {pulsar-short}, but you can use whatever tenant and namespace you are comfortable with. -. Download the minimalist {pulsar-short} client. -This "client.conf" assumes the port forwarding addresses we will perform in the next step. -+ -[source,shell] ----- -wget https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/client.conf ----- +. xref:components:attachment$client.conf[Download the minimalist {pulsar-short} client]. +This `client.conf` assumes the port forwarding addresses we will perform in the next step. -. Set the client environment variable. Replace the value with the absolute path to the "client.conf" you just downloaded. +. Set a client configuration environment variable with the absolute path to the downloaded `client.conf` file: + [source,shell] ---- -# the client conf path must be an absolute path to the downloaded conf file -export PULSAR_CLIENT_CONF= +export PULSAR_CLIENT_CONF=/path/to/client.conf ---- . Navigate to the {pulsar-short} home folder and run the following command. diff --git a/modules/components/partials/install-helm.adoc b/modules/components/partials/install-helm.adoc index 11b558c..93633e2 100644 --- a/modules/components/partials/install-helm.adoc +++ b/modules/components/partials/install-helm.adoc @@ -1,21 +1,15 @@ -. Add the {company} Helm chart repo to your Helm store: -+ -[source,shell] ----- -helm repo add datastax-pulsar https://datastax.github.io/pulsar-helm-chart ----- +. xref:components:attachment${helmValuesPath}/values.yaml[Download the {company} Luna Helm chart values file]. . Install the Helm chart using a minimalist values file. This command creates a Helm release named "my-pulsar-cluster" using the {company} Luna Helm chart, within the K8s namespace "datastax-pulsar". The minimal cluster creates only the essential components and has no ingress or load balanced services. + -[source,shell,subs="attributes+"] +[source,shell] ---- -VALUES_URL="{helmValuesPath}" helm install \ --namespace datastax-pulsar \ --create-namespace \ - --values $VALUES_URL \ + --values /path/to/values.yaml \ --version 3.0.4 \ my-pulsar-cluster \ datastax-pulsar/pulsar @@ -24,7 +18,7 @@ helm install \ . Wait for the broker pod to be in a running state. You might see a few restarts as your components start up. + -[source,shell,subs="attributes+"] +[source,shell] ---- kubectl -n datastax-pulsar wait --for=condition=Ready pod/pulsar-broker-0 --timeout=120s ---- \ No newline at end of file From 02723e00bc028bc43db4eed290ef816df8001498 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Thu, 12 Mar 2026 14:01:03 -0700 Subject: [PATCH 3/6] keep links to pulsar-helm-chart repo --- modules/ROOT/pages/faqs.adoc | 10 ++++++---- modules/components/partials/install-helm.adoc | 13 ++++++++++++- .../pages/quickstart-helm-installs.adoc | 2 +- modules/install-upgrade/pages/upgrade-guide.adoc | 2 +- modules/operations/pages/scale-cluster.adoc | 4 ++-- 5 files changed, 22 insertions(+), 9 deletions(-) diff --git a/modules/ROOT/pages/faqs.adoc b/modules/ROOT/pages/faqs.adoc index ae57949..0db038a 100644 --- a/modules/ROOT/pages/faqs.adoc +++ b/modules/ROOT/pages/faqs.adoc @@ -38,11 +38,13 @@ They include Minikube, K8d, Kind, Google Kubernetes Engine (GKE), Microsoft Azur There are several public repos, each with a different purpose. See: -* {pulsar-repo}[{pulsar-repo}] : This is the distro repo (a fork of `apache/pulsar`). -* {pulsar-admin-console-repo}[{pulsar-admin-console-repo}] : This is the repo for the {pulsar-short} admin console, which allows for the configuration and monitoring of {pulsar-short}. +* {pulsar-repo}[{pulsar-repo}]: This is the distro repo (a fork of `apache/pulsar`). +* {pulsar-admin-console-repo}[{pulsar-admin-console-repo}]: This is the repo for the {pulsar-short} admin console, which allows for the configuration and monitoring of {pulsar-short}. * {pulsar-heartbeat-repo}[{pulsar-heartbeat-repo}] : This is a monitoring/observability tool for {pulsar-short} that tracks the health of the cluster and can generate alerts in Slack and OpsGenie. -* {kaap-operator-repo}[{kaap-operator-repo}] : This is the utility for deploying the {company} {pulsar-short} Distro in an existing Kubernetes cluster. -* {pulsar-sink-repo}[{pulsar-sink-repo}] : This is the {company} {pulsar} Connector (`pulsar-sink`) repo. +* {kaap-operator-repo}[{kaap-operator-repo}]: Use the {kaap-short} to deploy the {company} {pulsar-short} Distro in an existing Kubernetes cluster. ++ +{company} recommends the {kaap-short} as a replacement for the deprecated {pulsar-helm-chart-repo}[{company} {pulsar-short} Helm chart]. +* {pulsar-sink-repo}[{pulsar-sink-repo}]: This is the {company} {pulsar} Connector (`pulsar-sink`) repo. == Is there a prerequisite version of Java needed for the {company} {product} installation? diff --git a/modules/components/partials/install-helm.adoc b/modules/components/partials/install-helm.adoc index 93633e2..3388609 100644 --- a/modules/components/partials/install-helm.adoc +++ b/modules/components/partials/install-helm.adoc @@ -1,4 +1,15 @@ -. xref:components:attachment${helmValuesPath}/values.yaml[Download the {company} Luna Helm chart values file]. +[IMPORTANT] +==== +The {pulsar-helm-chart-repo}[{company} {pulsar-short} Helm chart] is deprecated. +For Kubernetes deployments, use xref:kaap-operator::index.adoc[{kaap}] instead. +==== + +. Add the {company} Helm chart repo to your Helm store: ++ +[source,shell] +---- +helm repo add datastax-pulsar https://datastax.github.io/pulsar-helm-chart +---- . Install the Helm chart using a minimalist values file. This command creates a Helm release named "my-pulsar-cluster" using the {company} Luna Helm chart, within the K8s namespace "datastax-pulsar". diff --git a/modules/install-upgrade/pages/quickstart-helm-installs.adoc b/modules/install-upgrade/pages/quickstart-helm-installs.adoc index 0f3eb01..a3a8d3b 100644 --- a/modules/install-upgrade/pages/quickstart-helm-installs.adoc +++ b/modules/install-upgrade/pages/quickstart-helm-installs.adoc @@ -11,7 +11,7 @@ You have options for installing *{company} {product}*: + [IMPORTANT] ==== -The {pulsar-helm-chart-repo}[{company} Pulsar Helm chart] is deprecated. +The {pulsar-helm-chart-repo}[{company} {pulsar-short} Helm chart] is deprecated. For Kubernetes deployments, use xref:kaap-operator::index.adoc[{kaap}] instead. ==== diff --git a/modules/install-upgrade/pages/upgrade-guide.adoc b/modules/install-upgrade/pages/upgrade-guide.adoc index ec534ad..9d33d8c 100644 --- a/modules/install-upgrade/pages/upgrade-guide.adoc +++ b/modules/install-upgrade/pages/upgrade-guide.adoc @@ -355,7 +355,7 @@ kubectl logs *POD-NAME* -n *NAMESPACE* [IMPORTANT] ==== -The {pulsar-helm-chart-repo}[{company} Pulsar Helm chart] is deprecated. +The {pulsar-helm-chart-repo}[{company} {pulsar-short} Helm chart] is deprecated. For Kubernetes deployments, use xref:kaap-operator::index.adoc[{kaap}] instead. ==== diff --git a/modules/operations/pages/scale-cluster.adoc b/modules/operations/pages/scale-cluster.adoc index 2ea1b31..11c36e8 100644 --- a/modules/operations/pages/scale-cluster.adoc +++ b/modules/operations/pages/scale-cluster.adoc @@ -8,11 +8,11 @@ include::operations:partial$operator-scaling.adoc[] [IMPORTANT] ==== -The {pulsar-helm-chart-repo}[{company} Pulsar Helm chart] is deprecated. +The {pulsar-helm-chart-repo}[{company} {pulsar-short} Helm chart] is deprecated. For Kubernetes deployments, use xref:kaap-operator::index.adoc[{kaap}] instead. ==== -To start the cluster, use the values provided in the {pulsar-helm-chart-repo}/blob/master/examples/dev-values.yaml[{company} Pulsar values YAML file]: +To start the cluster, use the values provided in the {pulsar-helm-chart-repo}/blob/master/examples/dev-values.yaml[{company} {pulsar-short} values YAML file]: [source,bash] ---- From 03956907394f63ec52e88ca45c6da2849bc833d1 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 17 Mar 2026 12:15:04 -0700 Subject: [PATCH 4/6] helm chart name --- modules/ROOT/pages/faqs.adoc | 6 +++--- modules/components/pages/admin-console-tutorial.adoc | 2 +- modules/components/pages/heartbeat-vm.adoc | 2 +- modules/components/pages/pulsar-beam.adoc | 6 +++--- modules/components/pages/pulsar-sql.adoc | 6 +++--- modules/components/partials/install-helm.adoc | 4 ++-- .../install-upgrade/pages/production-cluster-sizing.adoc | 4 ++-- .../install-upgrade/pages/quickstart-helm-installs.adoc | 7 +------ .../install-upgrade/pages/quickstart-server-installs.adoc | 2 +- modules/install-upgrade/pages/upgrade-guide.adoc | 6 +++--- 10 files changed, 20 insertions(+), 25 deletions(-) diff --git a/modules/ROOT/pages/faqs.adoc b/modules/ROOT/pages/faqs.adoc index 3d4e23c..81eacc7 100644 --- a/modules/ROOT/pages/faqs.adoc +++ b/modules/ROOT/pages/faqs.adoc @@ -58,17 +58,17 @@ The {product} distribution is designed for Java 17. However, because the product == What are the install options for {product}? * **{kaap-short} Helm chart (Recommended)**: Use the {company} {kaap-operator-repo}[{kaap-short} Helm chart], which provides Kubernetes-native autoscaling and simplified management for {pulsar} clusters. For more information, see the xref:kaap-operator::index.adoc[{kaap}] documentation. -* **{product} Helm chart (Deprecated)**: The Helm chart provided at {pulsar-helm-chart-repo}[{pulsar-helm-chart-repo}] is deprecated and no longer maintained. Use the {kaap-short} instead. +* **{company} {pulsar-short} Helm chart (Deprecated)**: The Helm chart provided at {pulsar-helm-chart-repo}[{pulsar-helm-chart-repo}] is deprecated and no longer maintained. Use the {kaap-short} instead. * **Tarball**: Use the tarball provided at {pulsar-repo}/releases[{pulsar-repo}/releases] to install {product} on a server or VM. * **Ansible**: Use the {company} Ansible scripts provided at {pulsar-ansible-repo}[{pulsar-ansible-repo}] to install {product} on a server or VM with our provided playbooks. == How do I install {product} in my Kubernetes cluster? -Follow the full instructions in xref:install-upgrade:quickstart-helm-installs.adoc[Quick Start for Helm Chart installs]. +Follow the full instructions in xref:install-upgrade:quickstart-helm-installs.adoc[]. == How do I install {product} on my server or VM? -Follow the full instructions in xref:install-upgrade:quickstart-server-installs.adoc[Quick Start for Server/VM installs]. +Follow the full instructions in xref:install-upgrade:quickstart-server-installs.adoc[]. == What task can I perform in the {product} Admin Console? diff --git a/modules/components/pages/admin-console-tutorial.adoc b/modules/components/pages/admin-console-tutorial.adoc index e4eaac6..6a6e48a 100644 --- a/modules/components/pages/admin-console-tutorial.adoc +++ b/modules/components/pages/admin-console-tutorial.adoc @@ -7,7 +7,7 @@ The *Admin Console for {pulsar-reg}* is a web-based UI from {company} that admin In the *{pulsar-short} Admin Console*, you can use {pulsar-short} clients to send and receive pub/sub messages. -If you installed the Admin console with the xref:install-upgrade:quickstart-helm-installs.adoc[{company} Helm chart], access the Admin console via the `pulsar-adminconsole` external load balancer endpoint in your cloud provider: +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] diff --git a/modules/components/pages/heartbeat-vm.adoc b/modules/components/pages/heartbeat-vm.adoc index ba1b12e..06b45d4 100644 --- a/modules/components/pages/heartbeat-vm.adoc +++ b/modules/components/pages/heartbeat-vm.adoc @@ -1,6 +1,6 @@ = Heartbeat on VM/Server -This document describes how to install {pulsar-short} Heartbeat on a virtual machine (VM) or server. For installation with the Docker image, see xref:install-upgrade:quickstart-helm-installs.adoc[Helm Chart Installation]. +This document describes how to install {pulsar-short} Heartbeat on a virtual machine (VM) or server. For installation with the Docker image, see xref:install-upgrade:quickstart-helm-installs.adoc[]. == Install Heartbeat Binary diff --git a/modules/components/pages/pulsar-beam.adoc b/modules/components/pages/pulsar-beam.adoc index 4d25ae8..9f4e296 100644 --- a/modules/components/pages/pulsar-beam.adoc +++ b/modules/components/pages/pulsar-beam.adoc @@ -1,6 +1,6 @@ = {pulsar-beam} with {product} :navtitle: {pulsar-beam} -:description: Install a minimal {product} Helm chart that includes {pulsar-beam} +:description: Install a minimal {company} {pulsar-short} Helm chart that includes {pulsar-beam} :helmValuesPath: beam The {pulsar-beam-repo}[{pulsar-beam}] project is an HTTP-based streaming and queueing system for use with {pulsar}. @@ -12,7 +12,7 @@ With {pulsar-beam}, you can send messages over HTTP, push messages to a webhook include::ROOT:partial$luna-name.adoc[] ==== -In this guide, you'll install a minimal {product} Helm chart that includes {pulsar-beam}. +In this guide, you'll install a minimal {company} {pulsar-short} Helm chart that includes {pulsar-beam}. == Prerequisites @@ -20,7 +20,7 @@ In this guide, you'll install a minimal {product} Helm chart that includes {puls * Enough access to a K8s cluster to create a namespace, deployments, and pods * https://kubernetes.io/docs/tasks/tools/[Kubectl CLI] (this example uses version 1.23.4) -== Install {product} Helm chart +== Install the {company} {pulsar-short} Helm chart include::partial$install-helm.adoc[] diff --git a/modules/components/pages/pulsar-sql.adoc b/modules/components/pages/pulsar-sql.adoc index aa6206c..8fedf88 100644 --- a/modules/components/pages/pulsar-sql.adoc +++ b/modules/components/pages/pulsar-sql.adoc @@ -1,6 +1,6 @@ = Using {pulsar-short} SQL with {product} :navtitle: {pulsar-short} SQL -:description: This guide installs the {product} Helm chart using minimum values for a working {pulsar-short} cluster that includes SQL workers +:description: This guide installs the {company} {pulsar-short} Helm chart using minimum values for a working {pulsar-short} cluster that includes SQL workers :helmValuesPath: sql {pulsar-short} SQL allows enterprises to query {pulsar} topic data with SQL. @@ -14,7 +14,7 @@ Additionally, {pulsar-short} has built-in options to create Trino workers and au include::ROOT:partial$luna-name.adoc[] ==== -In this guide, we will use the {product} Helm Chart to install a {pulsar-short} cluster with {pulsar-short} SQL. +In this guide, we will use the {company} {pulsar-short} Helm Chart to install a {pulsar-short} cluster with {pulsar-short} SQL. The Trino coordinator and desired number of workers will be created directly in the cluster. == Prerequisites @@ -31,7 +31,7 @@ PrestoDB has been replaced by Trino, and {pulsar} is using Trino's version. The Trino CLI uses the "X-TRINO-USER" header for authentications. ==== -== Install {product} Helm chart +== Install the {company} {pulsar-short} Helm chart include::partial$install-helm.adoc[] diff --git a/modules/components/partials/install-helm.adoc b/modules/components/partials/install-helm.adoc index 3388609..ea6b9b0 100644 --- a/modules/components/partials/install-helm.adoc +++ b/modules/components/partials/install-helm.adoc @@ -4,7 +4,7 @@ The {pulsar-helm-chart-repo}[{company} {pulsar-short} Helm chart] is deprecated. For Kubernetes deployments, use xref:kaap-operator::index.adoc[{kaap}] instead. ==== -. Add the {company} Helm chart repo to your Helm store: +. Add the {company} {pulsar-short} Helm chart repo to your Helm store: + [source,shell] ---- @@ -12,7 +12,7 @@ helm repo add datastax-pulsar https://datastax.github.io/pulsar-helm-chart ---- . Install the Helm chart using a minimalist values file. -This command creates a Helm release named "my-pulsar-cluster" using the {company} Luna Helm chart, within the K8s namespace "datastax-pulsar". +This command creates a Helm release named "my-pulsar-cluster" using the {company} {pulsar-short} Helm chart, within the K8s namespace "datastax-pulsar". The minimal cluster creates only the essential components and has no ingress or load balanced services. + [source,shell] diff --git a/modules/install-upgrade/pages/production-cluster-sizing.adoc b/modules/install-upgrade/pages/production-cluster-sizing.adoc index 1ffad6a..05313af 100644 --- a/modules/install-upgrade/pages/production-cluster-sizing.adoc +++ b/modules/install-upgrade/pages/production-cluster-sizing.adoc @@ -40,7 +40,7 @@ Scale bookies up on disc usage percentage. Scale down manually by making a booki [#recommended] === Recommended server components -The {product} Helm chart deployment includes optional but highly recommended server components for better {pulsar-short} cluster metrics monitoring and operation visibility. +The {company} {pulsar-short} Helm chart deployment includes optional but highly recommended server components for better {pulsar-short} cluster metrics monitoring and operation visibility. * https://bookkeeper.apache.org/docs/admin/autorecovery[{bookkeeper-short} AutoRecovery] - This is a {pulsar-short} component that recovers {bookkeeper-short} data in the event of a bookie outage. While optional you will want the insurance of AutoRecovery working on your behalf. A single instance of AutoRecovery should be adequate - only in the most heavily-used clusters will you need more. @@ -59,7 +59,7 @@ Function worker spec is usually focused on compute and memory. Scale the workers based on overall usage (both CPU and memory). * xref:luna-streaming:components:admin-console-tutorial.adoc[{pulsar-short} AdminConsole] - This is an optional web-based admin console for managing {pulsar-short} clusters, and makes management much easier than tons of CLI commands. The sizing and scaling for AdminConsole has nothing to do with the cluster, as it is not a failure point. * 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 Luna Helm chart includes pre-made dashboards in Grafana and pre-wires all the metrics scraping. +* 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[] diff --git a/modules/install-upgrade/pages/quickstart-helm-installs.adoc b/modules/install-upgrade/pages/quickstart-helm-installs.adoc index 0c9023a..fb0a602 100644 --- a/modules/install-upgrade/pages/quickstart-helm-installs.adoc +++ b/modules/install-upgrade/pages/quickstart-helm-installs.adoc @@ -2,17 +2,12 @@ [IMPORTANT] ==== -The {company} production-ready Helm chart is now deprecated. For new deployments, we recommend using the {company} {kaap-operator-repo}[{kaap-short} Helm chart], which provides Kubernetes-native autoscaling and simplified management for {pulsar} clusters. For more information, see the xref:kaap-operator::index.adoc[{kaap}] documentation. -==== - -[NOTE] -==== include::ROOT:partial$luna-name.adoc[] ==== You have options for installing {product}: -* With the provided *{company} Helm chart* for an existing Kubernetes environment locally or with a cloud provider, as covered in this topic. +* With the provided *{company} {pulsar-short} Helm chart* for an existing Kubernetes environment locally or with a cloud provider, as covered in this topic. + [IMPORTANT] ==== diff --git a/modules/install-upgrade/pages/quickstart-server-installs.adoc b/modules/install-upgrade/pages/quickstart-server-installs.adoc index 8f477be..48459bc 100644 --- a/modules/install-upgrade/pages/quickstart-server-installs.adoc +++ b/modules/install-upgrade/pages/quickstart-server-installs.adoc @@ -111,6 +111,6 @@ Download the latest version from the {pulsar-heartbeat-repo}/releases/[{company} * For installing optional built-in connectors or tiered storage included in `lunastreaming-all`, see the https://pulsar.apache.org/docs/deploy-bare-metal#install-builtin-connectors-optional[{pulsar-short} documentation]. -* For installation to existing Kubernetes environments or with a cloud provider, see xref:install-upgrade:quickstart-helm-installs.adoc[Quick Start for Helm Chart installs]. +* For installation to existing Kubernetes environments or with a cloud provider, see xref:install-upgrade:quickstart-helm-installs.adoc[]. * For Ansible deployment, use the {company} Ansible scripts provided at {pulsar-ansible-repo}[{pulsar-ansible-repo}]. \ No newline at end of file diff --git a/modules/install-upgrade/pages/upgrade-guide.adoc b/modules/install-upgrade/pages/upgrade-guide.adoc index 0ca0dd3..285d387 100644 --- a/modules/install-upgrade/pages/upgrade-guide.adoc +++ b/modules/install-upgrade/pages/upgrade-guide.adoc @@ -287,7 +287,7 @@ For more information, see the xref:kaap-operator::index.adoc[{kaap-short} docume helm get values *RELEASE-NAME* > pulsar-backup-values.yaml ---- + -. To update the {product} Helm chart repository, run the following command: +. To update the {company} {pulsar-short} Helm chart repository, run the following command: + [source,bash] ---- @@ -364,7 +364,7 @@ The {pulsar-helm-chart-repo}[{company} {pulsar-short} Helm chart] is deprecated. For Kubernetes deployments, use xref:kaap-operator::index.adoc[{kaap}] instead. ==== -The Helm chart for {product} is available in the {pulsar-helm-chart-repo}/blob/master/helm-chart-sources/pulsar/values.yaml[Helm chart sources] repository. +The {company} {pulsar-short} Helm chart is available in the {pulsar-helm-chart-repo}/blob/master/helm-chart-sources/pulsar/values.yaml[Helm chart sources] repository. . To prevent data loss, back up your existing {pulsar-short} data and configuration files. . To save your current Helm release configuration, run the following command: @@ -374,7 +374,7 @@ The Helm chart for {product} is available in the {pulsar-helm-chart-repo}/blob/m helm get values *RELEASE-NAME* > pulsar-backup-values.yaml ---- + -. To update the {product} Helm chart repository, run the following command: +. To update the {company} {pulsar-short} Helm chart repository, run the following command: + [source,bash] ---- From 42d9aa0a395fa6eb5150442ec527f6aa3e810603 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 17 Mar 2026 12:17:21 -0700 Subject: [PATCH 5/6] double heading --- modules/install-upgrade/pages/quickstart-helm-installs.adoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/modules/install-upgrade/pages/quickstart-helm-installs.adoc b/modules/install-upgrade/pages/quickstart-helm-installs.adoc index fb0a602..2ffca39 100644 --- a/modules/install-upgrade/pages/quickstart-helm-installs.adoc +++ b/modules/install-upgrade/pages/quickstart-helm-installs.adoc @@ -199,8 +199,6 @@ proxy: If you are using a load balancer on the proxy, you can find the IP address using `kubectl get service -n pulsar`. -=== Manage {product} with {pulsar-short} Admin Console - Or if you would rather go directly to the broker: `kubectl port-forward -n pulsar $(kubectl get pods -n pulsar -l component=broker -o jsonpath='{.items[0].metadata.name}') 8080:8080` From 29d611650f0d7dc845811d52e0ec1fa12eee9dc2 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 17 Mar 2026 12:18:13 -0700 Subject: [PATCH 6/6] ragstack-ai attributes --- local-preview-playbook.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/local-preview-playbook.yml b/local-preview-playbook.yml index eb97263..664cc64 100644 --- a/local-preview-playbook.yml +++ b/local-preview-playbook.yml @@ -221,9 +221,6 @@ asciidoc: cr-short: 'CR' crd: 'custom resource definition (CRD)' crd-short: 'CRD' - # Custom attributes only used in ragstack-ai - astra_db: 'Astra DB' - astra_ui: 'Astra Portal' # Antora Atlas primary-site-url: https://docs.datastax.com/en primary-site-manifest-url: https://docs.datastax.com/en/site-manifest.json