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
6 changes: 3 additions & 3 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= {company} {product} Docs
= {product} Docs (formerly {company} Luna Streaming)
// Variables:
:company: DataStax
:product: Luna Streaming
:product: IBM Elite Support for Apache Pulsar
:repo-name: pulsar-docs
:github-org: datastax
// Settings:
Expand Down Expand Up @@ -32,7 +32,7 @@ endif::[]
// External URLs:
:asciidoc-language: https://docs.asciidoctor.org/asciidoc/latest/

This repository contains the source files for the {company} {product} documentation.
This repository contains the source files for the {product} documentation.

toc::[]

Expand Down
4 changes: 2 additions & 2 deletions antora.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
name: 'luna-streaming'
version: '3.1-3.x'
title: 'Luna Streaming'
title: 'IBM Elite Support for Apache Pulsar'
start_page: 'index.adoc'

nav:
- modules/ROOT/nav.adoc

asciidoc:
attributes:
product: 'Luna Streaming'
product: 'IBM Elite Support for Apache Pulsar'
luna-version: '3.1'
pulsar-version: '3.1'
admin-console-version: '2.0.4'
Expand Down
53 changes: 29 additions & 24 deletions modules/ROOT/pages/faqs.adoc
Original file line number Diff line number Diff line change
@@ -1,40 +1,45 @@
= {product} FAQs
:navtitle: FAQs

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

== What is {company} {product}?
== What is {product}?

{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.
{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.

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

In addition to {pulsar} itself, {company} {product} provides:
Yes.
include::partial$luna-name.adoc[]

== What components and features are provided by {product}?

In addition to {pulsar} itself, {product} provides:

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

== On which version of {pulsar} is {company} {product} based?
== On which version of {pulsar} is {product} based?

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

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

{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.
{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.

== Is {company} {product} an open-source project?
== Is {product} an open-source project?

Yes, {company} {product} is open source. See the <<gitHubRepos,repos FAQ>>.
Yes, {product} is open source. See the <<gitHubRepos,repos FAQ>>.

== Which Kubernetes platforms are supported by {company} {product}?
== Which Kubernetes platforms are supported by {product}?

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

[#gitHubRepos]
== Where are the {company} {product} public GitHub repos?
== Where are the {product} public GitHub repos?

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

Expand All @@ -45,26 +50,26 @@ There are several public repos, each with a different purpose. See:
* {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?
== Is there a prerequisite version of Java needed for the {product} installation?

The {company} {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.
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.

== What are the install options for {company} {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**: 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.
* **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.
* **{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.
* **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 {company} {product} in my Kubernetes cluster?
== 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].

== How do I install {company} {product} on my server or VM?
== 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].

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

From the Admin Console, you can:

Expand Down Expand Up @@ -96,7 +101,7 @@ The {company} {pulsar} Connector allows single-record acknowledgement and negati

There are two packages:

* The `pulsar-sink` functionality of {company} {pulsar} Connector is included with {company} {product}. It's built in!
* The `pulsar-sink` functionality of {company} {pulsar} Connector is included with {product}. It's built in!
* 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.

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}.
Expand All @@ -107,6 +112,6 @@ See the xref:pulsar-connector:ROOT:index.adoc[{company} {pulsar} Connector docum
This source connector streams data changes from {cass-short} tables to {pulsar-short} topics.
For more information, see the xref:cdc-for-cassandra:ROOT:index.adoc[{company} CDC for {cass-short} connector documentation].

== What client APIs does {company} {product} provide?
== What client APIs does {product} provide?

The same as for {pulsar}. See https://pulsar.apache.org/docs/en/client-libraries/.
14 changes: 9 additions & 5 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
= Welcome to {company} {product}
= Welcome to {product} (formerly {company} Luna Streaming)
:navtitle: {product}

{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.
{product} is a production-ready distribution of {pulsar} built to run seamlessly on any CNCF conformant version of Kubernetes.

{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[]

== Release notes

The latest release of {company} {product} is {luna-version}, which matches the supported, distributed {pulsar-short} version numbers.
The latest release of {product} is {luna-version}, which matches the supported, distributed {pulsar-short} version numbers.

The prior {product} release (2.10.x) provided the {pulsar-short} 2.10.x distribution.

Refer to the {company} {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.
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.

== Components

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

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

Expand Down
4 changes: 4 additions & 0 deletions modules/ROOT/partials/luna-name.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{product} is the new name for Luna Streaming after IBM acquired DataStax.
In this documentation, {product} and Luna Streaming refer to the same product.

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].
4 changes: 2 additions & 2 deletions modules/components/pages/admin-console-tutorial.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
= {pulsar-short} Admin Console

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.
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.

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

In the *{product} {pulsar-short} Admin Console*, you can use {pulsar-short} clients to send and receive pub/sub messages.
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:

Expand Down
7 changes: 6 additions & 1 deletion modules/components/pages/pulsar-beam.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,12 @@ 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).

In this guide, you'll install a minimal {company} {pulsar-short} Helm chart that includes {pulsar-beam}.
[NOTE]
====
include::ROOT:partial$luna-name.adoc[]
====

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

== Prerequisites

Expand Down
7 changes: 6 additions & 1 deletion modules/components/pages/pulsar-sql.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,12 @@ 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.

In this guide, we will use the {company} {pulsar-short} Helm Chart to install a {pulsar-short} cluster with {pulsar-short} SQL.
[NOTE]
====
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.
The Trino coordinator and desired number of workers will be created directly in the cluster.

== Prerequisites
Expand Down
13 changes: 9 additions & 4 deletions modules/connectors/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,16 @@
:navtitle: {pulsar-short} I/O connectors reference
:page-aliases: operations:io-connectors.adoc

[NOTE]
====
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 {company} {product} distribution.
There are three versions of the {product} distribution.
The `lunastreaming-all` version includes all connectors.
====

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

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.

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

=== `pulsar-admin` CLI sink operations

Get available sink connectors::
Get a list of sink connectors that are available in your {product} {pulsar-short} tenant:
Get a list of sink connectors that are available in your {pulsar-short} tenant:
+
[source,shell]
----
Expand Down Expand Up @@ -226,7 +231,7 @@ Delete a sink connector::
=== `pulsar-admin` CLI source operations

Get available source connectors::
Get a list of source connectors that are available in your {product} {pulsar-short} tenant:
Get a list of source connectors that are available in your {pulsar-short} tenant:
+
[source,shell]
----
Expand Down
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 {company} {product} Helm chart deployment includes optional but highly recommended server components for better {pulsar-short} cluster metrics monitoring and operation visibility.
The {product} 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 Down
9 changes: 7 additions & 2 deletions modules/install-upgrade/pages/quickstart-helm-installs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,15 @@
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.
====

You have options for installing *{company} {product}*:
[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 *{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 *{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.
Expand Down
11 changes: 8 additions & 3 deletions modules/install-upgrade/pages/quickstart-server-installs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

This document explains xref:install-upgrade:quickstart-server-installs.adoc#install[installation] of {product} for Bare Metal/VM deployments with a {pulsar-short} tarball.

[NOTE]
====
include::ROOT:partial$luna-name.adoc[]
====

The resulting {product} deployment includes:

* *Tiered Storage:* Offload historical messages to more cost effective object storages such as AWS S3, Azure Blob, Google Cloud Storage, and HDFS.
Expand Down Expand Up @@ -41,7 +46,7 @@ Check this setting with `cat /sys/kernel/mm/transparent_hugepage/enabled` and `c
[#install]
== Installation

. Download the {company} {product} tarball from the {pulsar-repo}/releases[{company} GitHub repo]. There are three versions of {product} currently available:
. Download the {product} tarball from the {pulsar-repo}/releases[{company} GitHub repo]. There are three versions of {product} currently available:
+
[cols="1,1"]
[%autowidth]
Expand Down Expand Up @@ -86,11 +91,11 @@ drwxr-xr-x@ 277 firstname.lastname staff 8864 May 17 05:58 lib
drwxr-xr-x@ 25 firstname.lastname staff 800 Jan 22 2020 licenses
----

You have successfully installed the {company} {product} tarball.
You have successfully installed the {product} tarball.

== Additional tooling

Once the {company} {product} tarball is installed, you may want to add additional tooling to your server/VM deployment.
Once the {product} tarball is installed, you may want to add additional tooling to your server/VM deployment.

* *{pulsar-short} Admin Console:* Web-based UI that administrates {pulsar-short}.
Download the latest version from the {pulsar-admin-console-repo}[{company} GitHub repo] and follow the instructions xref:components:admin-console-vm.adoc[here].
Expand Down
11 changes: 8 additions & 3 deletions modules/install-upgrade/pages/supported-versions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@

Support covers only the following Software versions for {pulsar}:

[NOTE]
====
include::ROOT:partial$luna-name.adoc[]
====

[cols="2*"]
|===
|Name |Versions
Expand All @@ -11,13 +16,13 @@ Support covers only the following Software versions for {pulsar}:
|3.1.x
|===

Support covers only the following Software versions for {company} {product} Distribution:
Support covers only the following Software versions for {product} Distribution:

[cols="2*"]
|===
|Name |Version

|{company} {product} Distribution
|{product} Distribution
|v.1.0.0 and above

|===
Expand Down Expand Up @@ -45,7 +50,7 @@ Support covers only the following Software versions for the Open Source Projects

|===

Support covers only the following {company} {product} Connectors and {pulsar} Connectors (as included in the {pulsar} download):
Support covers only the following {product} Connectors and {pulsar} Connectors (as included in the {pulsar} download):

[cols="2*"]
|===
Expand Down
Loading