Skip to content

Commit 340a5a9

Browse files
authored
helm chart name (#207)
1 parent 1f16d0a commit 340a5a9

10 files changed

Lines changed: 18 additions & 21 deletions

local-preview-playbook.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -221,9 +221,6 @@ asciidoc:
221221
cr-short: 'CR'
222222
crd: 'custom resource definition (CRD)'
223223
crd-short: 'CRD'
224-
# Custom attributes only used in ragstack-ai
225-
astra_db: 'Astra DB'
226-
astra_ui: 'Astra Portal'
227224
# Antora Atlas
228225
primary-site-url: https://docs.datastax.com/en
229226
primary-site-manifest-url: https://docs.datastax.com/en/site-manifest.json

modules/ROOT/pages/faqs.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,17 +56,17 @@ The {product} distribution is designed for Java 17. However, because the product
5656

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

59-
* **{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.
59+
* **{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.
6060
* **Tarball**: Use the tarball provided at {pulsar-repo}/releases[{pulsar-repo}/releases] to install {product} on a server or VM.
6161
* **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.
6262

6363
== How do I install {product} in my Kubernetes cluster?
6464

65-
Follow the full instructions in xref:install-upgrade:quickstart-helm-installs.adoc[Quick Start for Helm Chart installs].
65+
Follow the full instructions in xref:install-upgrade:quickstart-helm-installs.adoc[].
6666

6767
== How do I install {product} on my server or VM?
6868

69-
Follow the full instructions in xref:install-upgrade:quickstart-server-installs.adoc[Quick Start for Server/VM installs].
69+
Follow the full instructions in xref:install-upgrade:quickstart-server-installs.adoc[].
7070

7171
== What task can I perform in the {product} Admin Console?
7272

modules/components/pages/admin-console-tutorial.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The *Admin Console for {pulsar-reg}* is a web-based UI from {company} that admin
77

88
In the *{pulsar-short} Admin Console*, you can use {pulsar-short} clients to send and receive pub/sub messages.
99

10-
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:
10+
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:
1111

1212
image::GCP-all-pods.png[GCP Pods]
1313

modules/components/pages/heartbeat-vm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Heartbeat on VM/Server
22

3-
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].
3+
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[].
44

55
== Install Heartbeat Binary
66

modules/components/pages/pulsar-beam.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= {pulsar-beam} with {product}
22
:navtitle: {pulsar-beam}
3-
:description: Install a minimal {product} Helm chart that includes {pulsar-beam}
3+
:description: Install a minimal {company} {pulsar-short} Helm chart that includes {pulsar-beam}
44
:helmValuesPath: https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/beam/values.yaml
55

66
The {pulsar-beam-repo}[{pulsar-beam}] project is an HTTP-based streaming and queueing system for use with {pulsar}.
@@ -12,15 +12,15 @@ With {pulsar-beam}, you can send messages over HTTP, push messages to a webhook
1212
include::ROOT:partial$luna-name.adoc[]
1313
====
1414

15-
In this guide, you'll install a minimal {product} Helm chart that includes {pulsar-beam}.
15+
In this guide, you'll install a minimal {company} {pulsar-short} Helm chart that includes {pulsar-beam}.
1616

1717
== Prerequisites
1818

1919
* https://helm.sh/docs/intro/install/[Helm 3 CLI] (this example uses version 3.8.0)
2020
* Enough access to a K8s cluster to create a namespace, deployments, and pods
2121
* https://kubernetes.io/docs/tasks/tools/[Kubectl CLI] (this example uses version 1.23.4)
2222

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

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

modules/components/pages/pulsar-sql.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Using {pulsar-short} SQL with {product}
22
:navtitle: {pulsar-short} SQL
3-
:description: This guide installs the {product} Helm chart using minimum values for a working {pulsar-short} cluster that includes SQL workers
3+
:description: This guide installs the {company} {pulsar-short} Helm chart using minimum values for a working {pulsar-short} cluster that includes SQL workers
44
:helmValuesPath: https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/pulsar-sql/values.yaml
55

66
{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
1414
include::ROOT:partial$luna-name.adoc[]
1515
====
1616
17-
In this guide, we will use the {product} Helm Chart to install a {pulsar-short} cluster with {pulsar-short} SQL.
17+
In this guide, we will use the {company} {pulsar-short} Helm Chart to install a {pulsar-short} cluster with {pulsar-short} SQL.
1818
The Trino coordinator and desired number of workers will be created directly in the cluster.
1919
2020
== Prerequisites
@@ -31,7 +31,7 @@ PrestoDB has been replaced by Trino, but {pulsar} is using Presto's version.
3131
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.
3232
====
3333
34-
== Install {product} Helm chart
34+
== Install the {company} {pulsar-short} Helm chart
3535
3636
include::partial$install-helm.adoc[]
3737

modules/components/partials/install-helm.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
. Add the {company} Helm chart repo to your Helm store:
1+
. Add the {company} {pulsar-short} Helm chart repo to your Helm store:
22
+
33
[source,shell]
44
----
55
helm repo add datastax-pulsar https://datastax.github.io/pulsar-helm-chart
66
----
77

88
. Install the Helm chart using a minimalist values file.
9-
This command creates a Helm release named "my-pulsar-cluster" using the {company} Luna Helm chart, within the K8s namespace "datastax-pulsar".
9+
This command creates a Helm release named "my-pulsar-cluster" using the {company} {pulsar-short} Helm chart, within the K8s namespace "datastax-pulsar".
1010
The minimal cluster creates only the essential components and has no ingress or load balanced services.
1111
+
1212
[source,shell,subs="attributes+"]

modules/install-upgrade/pages/production-cluster-sizing.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Scale bookies up on disc usage percentage. Scale down manually by making a booki
4040
[#recommended]
4141
=== Recommended server components
4242
43-
The {product} Helm chart deployment includes optional but highly recommended server components for better {pulsar-short} cluster metrics monitoring and operation visibility.
43+
The {company} {pulsar-short} Helm chart deployment includes optional but highly recommended server components for better {pulsar-short} cluster metrics monitoring and operation visibility.
4444
4545
* 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.
4646
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.
5959
Scale the workers based on overall usage (both CPU and memory).
6060
* 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.
6161
* 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.
62-
* 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.
62+
* 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.
6363
6464
image::pulsar-components.png[]
6565

modules/install-upgrade/pages/quickstart-helm-installs.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::ROOT:partial$luna-name.adoc[]
77

88
You have options for installing {product}:
99

10-
* With the provided *{company} Helm chart* for an existing Kubernetes environment locally or with a cloud provider, as covered in this topic.
10+
* With the provided *{company} {pulsar-short} Helm chart* for an existing Kubernetes environment locally or with a cloud provider, as covered in this topic.
1111
* 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].
1212
* With the *{company} Ansible scripts* provided at {pulsar-ansible-repo}[{pulsar-ansible-repo}].
1313
@@ -32,7 +32,7 @@ The resulting configuration includes support for:
3232
3333
== Prerequisites
3434

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

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

modules/install-upgrade/pages/quickstart-server-installs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,6 @@ Download the latest version from the {pulsar-heartbeat-repo}/releases/[{company}
117117

118118
* 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].
119119

120-
* 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].
120+
* For installation to existing Kubernetes environments or with a cloud provider, see xref:install-upgrade:quickstart-helm-installs.adoc[].
121121

122122
* For Ansible deployment, use the {company} Ansible scripts provided at {pulsar-ansible-repo}[{pulsar-ansible-repo}].

0 commit comments

Comments
 (0)