Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions local-preview-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/faqs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -56,17 +56,17 @@ The {product} distribution is designed for Java 17. However, because the product

== What are the install options for {product}?

* **{product} Helm chart**: Use the Helm chart provided at {pulsar-helm-chart-repo}[{pulsar-helm-chart-repo}] to install {product} in an existing Kubernetes cluster on your laptop or hosted by a cloud provider.
* **{company} {pulsar-short} Helm chart**: Use the Helm chart provided at {pulsar-helm-chart-repo}[{pulsar-helm-chart-repo}] to install {product} in an existing Kubernetes cluster on your laptop or hosted by a cloud provider.
* **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?

Expand Down
2 changes: 1 addition & 1 deletion modules/components/pages/admin-console-tutorial.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
2 changes: 1 addition & 1 deletion modules/components/pages/heartbeat-vm.adoc
Original file line number Diff line number Diff line change
@@ -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

Expand Down
6 changes: 3 additions & 3 deletions modules/components/pages/pulsar-beam.adoc
Original file line number Diff line number Diff line change
@@ -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: https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/beam/values.yaml

The {pulsar-beam-repo}[{pulsar-beam}] project is an HTTP-based streaming and queueing system for use with {pulsar}.
Expand All @@ -12,15 +12,15 @@ 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

* https://helm.sh/docs/intro/install/[Helm 3 CLI] (this example uses version 3.8.0)
* 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[]

Expand Down
6 changes: 3 additions & 3 deletions modules/components/pages/pulsar-sql.adoc
Original file line number Diff line number Diff line change
@@ -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: https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/pulsar-sql/values.yaml

{pulsar-short} SQL allows enterprises to query {pulsar} topic data with SQL.
Expand All @@ -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
Expand All @@ -31,7 +31,7 @@ PrestoDB has been replaced by Trino, but {pulsar} is using Presto's version.
The Trino CLI uses the "X-TRINO-USER" header for authentications but Presto expects "X-PRESTO-USER", which is why we use the Presto CLI.
====

== Install {product} Helm chart
== Install the {company} {pulsar-short} Helm chart

include::partial$install-helm.adoc[]

Expand Down
4 changes: 2 additions & 2 deletions modules/components/partials/install-helm.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
. Add the {company} Helm chart repo to your Helm store:
. Add the {company} {pulsar-short} 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".
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,subs="attributes+"]
Expand Down
4 changes: 2 additions & 2 deletions modules/install-upgrade/pages/production-cluster-sizing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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[]

Expand Down
4 changes: 2 additions & 2 deletions modules/install-upgrade/pages/quickstart-helm-installs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ 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.
* With the *{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}].

Expand All @@ -32,7 +32,7 @@ The resulting configuration includes support for:

== Prerequisites

For an example set of production cluster values, see the {company} production-ready {pulsar-helm-chart-repo}[Helm chart].
For an example set of production cluster values, see the {pulsar-helm-chart-repo}[{company} {pulsar-short} Helm chart].

{company} recommends these hardware resources for running {product} in a Kubernetes environment:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,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}].