Skip to content

Commit 1f16d0a

Browse files
authored
DOC-5684: New product name (#204)
* new-product-name * peer-review * no-kaap * fix-double-name
1 parent e0b21bb commit 1f16d0a

16 files changed

Lines changed: 110 additions & 54 deletions

README.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
= {company} {product} Docs
1+
= {product} Docs (formerly {company} Luna Streaming)
22
// Variables:
33
:company: DataStax
4-
:product: Luna Streaming
4+
:product: IBM Elite Support for Apache Pulsar
55
:repo-name: pulsar-docs
66
:github-org: datastax
77
// Settings:
@@ -32,7 +32,7 @@ endif::[]
3232
// External URLs:
3333
:asciidoc-language: https://docs.asciidoctor.org/asciidoc/latest/
3434

35-
This repository contains the source files for the {company} {product} documentation.
35+
This repository contains the source files for the {product} documentation.
3636

3737
toc::[]
3838

antora.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
name: 'luna-streaming'
22
version: '2.10-3.x'
3-
title: 'Luna Streaming'
3+
title: 'IBM Elite Support for Apache Pulsar'
44
start_page: 'index.adoc'
55

66
nav:
77
- modules/ROOT/nav.adoc
88

99
asciidoc:
1010
attributes:
11-
product: 'Luna Streaming'
11+
product: 'IBM Elite Support for Apache Pulsar'
1212
luna-version: '2.10'
1313
pulsar-version: '2.10'
1414
admin-console-version: '2.0.4'

modules/ROOT/pages/faqs.adoc

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,45 @@
11
= {product} FAQs
22
:navtitle: FAQs
33

4-
If you are new to {company} {product} and its {pulsar} enhancements, these FAQs are for you.
4+
If you are new to {product} and its {pulsar} enhancements, these FAQs are for you.
55

6-
== What is {company} {product}?
6+
== What is {product}?
77

8-
{company} {product} is a new Kubernetes-based distribution of {pulsar}, based on the technology that https://kesque.com/[Kesque] built to run its {pulsar-short}-as-a-service.
8+
{product} is a Kubernetes-based distribution of {pulsar}, based on the technology that https://kesque.com/[Kesque] built to run its {pulsar-short}-as-a-service.
99

10-
== What components and features are provided by {company} {product}?
10+
== Are {product} and {company} Luna Streaming the same offering?
1111

12-
In addition to {pulsar} itself, {company} {product} provides:
12+
Yes.
13+
include::partial$luna-name.adoc[]
14+
15+
== What components and features are provided by {product}?
16+
17+
In addition to {pulsar} itself, {product} provides:
1318

1419
* An installer that can stand up a dev or production cluster on bare metal or VMs without a pre-existing Kubernetes environment
1520
* A Helm chart that can deploy and manage {pulsar-short} on your current Kubernetes infrastructure
1621
* {cass-short}, Elastic, Kinesis, {kafka-reg}, and JDBC connectors
1722
* A management dashboard
1823
* A monitoring and alerting system
1924

20-
== On which version of {pulsar} is {company} {product} based?
25+
== On which version of {pulsar} is {product} based?
2126

22-
{company} {product} {luna-version} is based on its distribution of {pulsar} {pulsar-version}, plus features and additional enhancements from {company} contributors.
27+
{product} {luna-version} is based on its distribution of {pulsar} {pulsar-version}, plus features and additional enhancements from {company} contributors.
2328

24-
== What does {company} {product} provide that I cannot get with open-source {pulsar}?
29+
== What does {product} provide that I cannot get with open-source {pulsar}?
2530

26-
{company} {product} is a hardened version of {pulsar} that been run through additional testing to ensure it is ready for production use. It also includes additional tooling to help monitor your system, including an enhanced Admin Console and a Heartbeat service to monitor the system health.
31+
{product} is a hardened version of {pulsar} that been run through additional testing to ensure it is ready for production use. It also includes additional tooling to help monitor your system, including an enhanced Admin Console and a Heartbeat service to monitor the system health.
2732

28-
== Is {company} {product} an open-source project?
33+
== Is {product} an open-source project?
2934

30-
Yes, {company} {product} is open source. See the <<gitHubRepos,repos FAQ>>.
35+
Yes, {product} is open source. See the <<gitHubRepos,repos FAQ>>.
3136

32-
== Which Kubernetes platforms are supported by {company} {product}?
37+
== Which Kubernetes platforms are supported by {product}?
3338

3439
They include Minikube, K8d, Kind, Google Kubernetes Engine (GKE), Microsoft Azure Kubernetes Service (AKS), Amazon Elastic Kubernetes Service (EKS), and other commonly used platforms.
3540

3641
[#gitHubRepos]
37-
== Where are the {company} {product} public GitHub repos?
42+
== Where are the {product} public GitHub repos?
3843

3944
There are several public repos, each with a different purpose. See:
4045

@@ -45,25 +50,25 @@ There are several public repos, each with a different purpose. See:
4550
* {pulsar-sink-repo}[{pulsar-sink-repo}] : This is the {company} {pulsar} Connector (`pulsar-sink`) repo.
4651
* 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.
4752

48-
== Is there a prerequisite version of Java needed for the {company} {product} installation?
53+
== Is there a prerequisite version of Java needed for the {product} installation?
4954

50-
The {company} {product} distribution is designed for Java 11. However, because the product releases Docker images, you do not need to install Java (8 or 11) in advance. Java 11 is bundled in the Docker image.
55+
The {product} distribution is designed for Java 17. However, because the product releases Docker images, you do not need to install Java 17 in advance. Java 17 is bundled in the Docker image.
5156

52-
== What are the install options for {company} {product}?
57+
== What are the install options for {product}?
5358

54-
* 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.
55-
* Use the tarball provided at {pulsar-repo}/releases[{pulsar-repo}/releases] to install {company} {product} on a server or VM.
56-
* 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.
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.
60+
* **Tarball**: Use the tarball provided at {pulsar-repo}/releases[{pulsar-repo}/releases] to install {product} on a server or VM.
61+
* **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.
5762

58-
== How do I install {company} {product} in my Kubernetes cluster?
63+
== How do I install {product} in my Kubernetes cluster?
5964

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

62-
== How do I install {company} {product} on my server or VM?
67+
== How do I install {product} on my server or VM?
6368

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

66-
== What task can I perform in the {company} {product} Admin Console?
71+
== What task can I perform in the {product} Admin Console?
6772

6873
From the Admin Console, you can:
6974

@@ -95,7 +100,7 @@ The {company} {pulsar} Connector allows single-record acknowledgement and negati
95100

96101
There are two packages:
97102

98-
* The `pulsar-sink` functionality of {company} {pulsar} Connector is included with {company} {product}. It's built in!
103+
* The `pulsar-sink` functionality of {company} {pulsar} Connector is included with {product}. It's built in!
99104
* You can optionally download the {company} {pulsar} Connector `.nar` file from the {pulsar-sink-repo}/releases[`pulsar-sink` repository], and then use it as its own product with your open-source {pulsar} install.
100105

101106
If you're using open-source software (OSS) {pulsar}, you can use {company} {pulsar} Connector with the OSS to take advantage of this `pulsar-sink` for {cass-short}.
@@ -106,6 +111,6 @@ See the xref:pulsar-connector:ROOT:index.adoc[{company} {pulsar} Connector docum
106111
This source connector streams data changes from {cass-short} tables to {pulsar-short} topics.
107112
For more information, see the xref:cdc-for-cassandra:ROOT:index.adoc[{company} CDC for {cass-short} connector documentation].
108113

109-
== What client APIs does {company} {product} provide?
114+
== What client APIs does {product} provide?
110115

111116
The same as for {pulsar}. See https://pulsar.apache.org/docs/en/client-libraries/.

modules/ROOT/pages/index.adoc

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
1-
= Welcome to {company} {product}
1+
= Welcome to {product} (formerly {company} Luna Streaming)
22
:navtitle: {product}
33

4-
{company} {product} is a production-ready distribution of {pulsar} built to run seamlessly on any CNCF conformant version of Kubernetes. {company} {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.
4+
{product} is a production-ready distribution of {pulsar} built to run seamlessly on any CNCF conformant version of Kubernetes.
5+
6+
{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.
7+
8+
include::partial$luna-name.adoc[]
59

610
== Release notes
711

8-
The latest release of {company} {product} is {luna-version}, which matches the supported, distributed {pulsar-short} version numbers.
12+
The latest release of {product} is {luna-version}, which matches the supported, distributed {pulsar-short} version numbers.
13+
14+
The prior {product} release (2.10.x) provided the {pulsar-short} 2.10.x distribution.
915

10-
Refer to the {company} {product} https://github.com/datastax/release-notes/blob/master/Luna_Streaming_2.10_Release_Notes.md[release notes], which are hosted in our public GitHub repo, for information &amp; linked commit IDs that were implemented in the latest {product} {luna-version} release.
16+
Refer to the {product} https://github.com/datastax/release-notes/blob/master/Luna_Streaming_3.1_Release_Notes.md[release notes], which are hosted in our public GitHub repo, for information &amp; linked commit IDs that were implemented in the latest {product} {luna-version} release.
1117

1218
== Components
1319

14-
In addition to the distribution of https://pulsar.apache.org/en/versions/[{pulsar} {pulsar-version}], {company} {product} provides:
20+
In addition to the distribution of https://pulsar.apache.org/en/versions/[{pulsar} {pulsar-version}], {product} provides:
1521

1622
* A xref:install-upgrade:quickstart-helm-installs.adoc[Helm chart] that deploys and manages {pulsar-short} on your current CNCF-conformant Kubernetes infrastructure
1723

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{product} is the new name for Luna Streaming after IBM acquired DataStax.
2+
In this documentation, {product} and Luna Streaming refer to the same product.
3+
4+
For technical specifications, inclusions, and exclusions of the {product} offering, see the https://www.ibm.com/docs/en/supportforpulsar?topic=elite-support-pulsar[{product} page in the IBM documentation].

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
= {pulsar-short} Admin Console
22

3-
The *{company} Admin Console for {pulsar-reg}* is a web-based UI from {company} that administers topics, namespaces, sources, sinks, and various aspects of {pulsar} features.
3+
The *Admin Console for {pulsar-reg}* is a web-based UI from {company} that administers topics, namespaces, sources, sinks, and various aspects of {pulsar} features.
44

55
[#getting-started]
66
== Getting Started in {pulsar-short} Admin Console
77

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

1010
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:
1111

modules/components/pages/pulsar-beam.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@ The {pulsar-beam-repo}[{pulsar-beam}] project is an HTTP-based streaming and que
77

88
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).
99

10-
In this guide, you'll install a minimal {company} {pulsar-short} Helm chart that includes {pulsar-beam}.
10+
[NOTE]
11+
====
12+
include::ROOT:partial$luna-name.adoc[]
13+
====
14+
15+
In this guide, you'll install a minimal {product} Helm chart that includes {pulsar-beam}.
1116

1217
== Prerequisites
1318

modules/components/pages/pulsar-sql.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@ Stream processing, real-time analytics, and highly customized dashboards are jus
99
{pulsar-short} offers a pre-made plugin for Trino that is included in its distribution.
1010
Additionally, {pulsar-short} has built-in options to create Trino workers and automatically configure the communications between {pulsar-short}'s ledger and Trino.
1111
12-
In this guide, we will use the {company} {pulsar-short} Helm Chart to install a {pulsar-short} cluster with {pulsar-short} SQL.
12+
[NOTE]
13+
====
14+
include::ROOT:partial$luna-name.adoc[]
15+
====
16+
17+
In this guide, we will use the {product} Helm Chart to install a {pulsar-short} cluster with {pulsar-short} SQL.
1318
The Trino coordinator and desired number of workers will be created directly in the cluster.
1419
1520
== Prerequisites

modules/connectors/pages/index.adoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,16 @@
22
:navtitle: {pulsar-short} I/O connectors reference
33
:page-aliases: operations:io-connectors.adoc
44

5+
[NOTE]
6+
====
7+
include::ROOT:partial$luna-name.adoc[]
8+
====
9+
510
{product} offers fully-managed versions of https://pulsar.apache.org/docs/en/io-overview/[{pulsar-reg} sink and source connectors].
611

712
[TIP]
813
====
9-
There are three versions of the {company} {product} distribution.
14+
There are three versions of the {product} distribution.
1015
The `lunastreaming-all` version includes all connectors.
1116
====
1217

@@ -135,13 +140,13 @@ They are considered experimental because they aren't fully supported or tested w
135140

136141
You can use the {web-ui} and the `xref:components:admin-console-tutorial.adoc[pulsar-admin]` CLI to create, monitor, and manage sink and source connectors.
137142

138-
Although you use the same base commands to create and update all {product} {pulsar-short} connectors, each connector has different configuration options.
143+
Although you use the same base commands to create and update all {pulsar-short} connectors, each connector has different configuration options.
139144
For example commands and configuration details, see the documentation for your preferred <<sink-connectors,sink connectors>> and <<source-connectors,source connectors>>.
140145

141146
=== `pulsar-admin` CLI sink operations
142147

143148
Get available sink connectors::
144-
Get a list of sink connectors that are available in your {product} {pulsar-short} tenant:
149+
Get a list of sink connectors that are available in your {pulsar-short} tenant:
145150
+
146151
[source,shell]
147152
----
@@ -226,7 +231,7 @@ Delete a sink connector::
226231
=== `pulsar-admin` CLI source operations
227232

228233
Get available source connectors::
229-
Get a list of source connectors that are available in your {product} {pulsar-short} tenant:
234+
Get a list of source connectors that are available in your {pulsar-short} tenant:
230235
+
231236
[source,shell]
232237
----

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

Lines changed: 1 addition & 1 deletion
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 {company} {product} Helm chart deployment includes optional but highly recommended server components for better {pulsar-short} cluster metrics monitoring and operation visibility.
43+
The {product} 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.

0 commit comments

Comments
 (0)