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 antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ start_page: 'index.adoc'

nav:
- modules/ROOT/nav.adoc
- modules/install-upgrade/nav.adoc
- modules/components/nav.adoc
- modules/operations/nav.adoc

asciidoc:
attributes:
Expand Down
Binary file removed modules/ROOT/images/GCP-all-pods.png
Binary file not shown.
Binary file removed modules/ROOT/images/care.png
Binary file not shown.
Binary file removed modules/ROOT/images/install-to-admin-console.png
Binary file not shown.
Binary file not shown.
Binary file removed modules/ROOT/images/luna-streaming-configure.png
Binary file not shown.
Binary file not shown.
Binary file removed modules/ROOT/images/luna-streaming-tls-warning.png
Binary file not shown.
Binary file not shown.
29 changes: 29 additions & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1 +1,30 @@
.Get started
* xref:ROOT:index.adoc[]
* xref:ROOT:faqs.adoc[]

.Install and upgrade
* xref:install-upgrade:quickstart-helm-installs.adoc[]
* xref:install-upgrade:quickstart-server-installs.adoc[]
* xref:ROOT:install-aks.adoc[]
* xref:ROOT:install-eks.adoc[]
* xref:ROOT:install-gke.adoc[]

.Components and extensions
* xref:components:admin-console-tutorial.adoc[]
* xref:components:admin-console-vm.adoc[]
* xref:components:pulsar-monitor.adoc[]
* xref:components:heartbeat-vm.adoc[]
* xref:components:pulsar-beam.adoc[]
* xref:components:pulsar-sql.adoc[]
* Starlight
** xref:components:starlight.adoc[]
** xref:components:starlight-for-rabbitmq.adoc[]
** xref:components:starlight-for-kafka.adoc[]

.Operations
* xref:operations:auth.adoc[]
* xref:operations:functions.adoc[]
* xref:operations:io-connectors.adoc[]
* xref:operations:io-elastic-sink.adoc[]
* xref:operations:scale-cluster.adoc[]
* xref:operations:troubleshooting.adoc[]
3 changes: 1 addition & 2 deletions modules/ROOT/pages/faqs.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
= Luna Streaming FAQs
:navtitle: FAQs
:page-tag: luna-streaming,dev,admin,pulsar

If you are new to DataStax Luna Streaming and its Apache Pulsar enhancements, these FAQs are for you.

Expand Down Expand Up @@ -113,7 +112,7 @@ There are two packages:
* The `pulsar-sink` functionality of DataStax Apache Pulsar Connector is included with DataStax Luna Streaming. It's built in!
* You can optionally download the DataStax Apache Pulsar Connector tarball from the https://downloads.datastax.com/#pulsar-sink[DataStax Downloads] site, and then use it as its own product with your open-source Apache Pulsar install.

If you're using open-source software (OSS) Apache Pulsar, you can use DataStax Apache Pulsar Connector with the OSS to take advantage of this `pulsar-sink` for Cassandra. See the DataStax Apache Pulsar Connector https://docs.datastax.com/en/pulsar-connector/[documentation].
If you're using open-source software (OSS) Apache Pulsar, you can use DataStax Apache Pulsar Connector with the OSS to take advantage of this `pulsar-sink` for Cassandra. See the xref:pulsar-connector:ROOT:index.adoc[DataStax Apache Pulsar Connector documentation].

== APIs

Expand Down
3 changes: 1 addition & 2 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
= Welcome to DataStax Luna Streaming
:navtitle: Luna Streaming
:page-tag: luna-streaming,dev,admin,pulsar

DataStax Luna Streaming is a production-ready distribution of Apache Pulsar built to run seamlessly on any CNCF conformant version of Kubernetes. DataStax Luna Streaming provides all of the core capabilities included in the Apache Community version of Apache Pulsar, plus a number of additional tools and features to facilitate administration and operational tasks associated with running Apache Pulsar in production.

Expand Down Expand Up @@ -54,7 +53,7 @@ In addition to the distribution of https://pulsar.apache.org/en/versions/[Apache

* Transparent batching of messages

== What's next?
== Next steps

* If you have an existing Kubernetes environment, deploy Luna Streaming with a xref:install-upgrade:quickstart-helm-installs.adoc[Helm Installation].
* If you have a bare metal or a cloud environment, see xref:install-upgrade:quickstart-server-installs.adoc[Server/VM Installation].
Expand Down
10 changes: 5 additions & 5 deletions modules/ROOT/pages/install-aks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@

This document covers installation of Luna Streaming on the Azure Kubernetes Service (AKS).

For an example set of production cluster values, see the DataStax production-ready https://github.com/datastax/pulsar-helm-chart[Helm chart]. +
For an example set of production cluster values, see the DataStax production-ready https://github.com/datastax/pulsar-helm-chart[Helm chart].

DataStax recommends these hardware resources for running Luna Streaming in a Kubernetes environment: +
DataStax recommends these hardware resources for running Luna Streaming in a Kubernetes environment:

include::ROOT:partial$helm-chart-recommendations.adoc[]

For the local machine running the Helm chart, you will need: +
For the local machine running the Helm chart, you will need:

* https://helm.sh/docs/[Helm] version 3 +
* https://helm.sh/docs/[Helm] version 3
* An Azure account with privileges to install and configure Kubernetes resources.

== Helm chart `values.yaml`
Expand Down Expand Up @@ -106,7 +106,7 @@ kubectl config set-context $(kubectl config current-context) --namespace=pulsar
. Execute `kubectl get pods -A` to view your running pods.
. Once your pods are up and running, continue to xref:install-upgrade:quickstart-helm-installs.adoc[Accessing Pulsar Cluster in Cloud] to access and manage your cluster.

== What's next?
== Next steps

Once your pods are up and running, continue to xref:install-upgrade:quickstart-helm-installs.adoc[Accessing Pulsar Cluster in Cloud] to access and manage your cluster.

Expand Down
10 changes: 5 additions & 5 deletions modules/ROOT/pages/install-eks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@

This document covers installation of Luna Streaming on the Amazon Elastic Kubernetes Environment (EKS).

For an example set of production cluster values, see the DataStax production-ready https://github.com/datastax/pulsar-helm-chart[Helm chart]. +
For an example set of production cluster values, see the DataStax production-ready https://github.com/datastax/pulsar-helm-chart[Helm chart].

DataStax recommends these hardware resources for running Luna Streaming in a Kubernetes environment: +
DataStax recommends these hardware resources for running Luna Streaming in a Kubernetes environment:

include::ROOT:partial$helm-chart-recommendations.adoc[]

For the local machine running the Helm chart, you will need: +
For the local machine running the Helm chart, you will need:

* https://helm.sh/docs/[Helm] version 3 +
* https://helm.sh/docs/[Helm] version 3
* An AWS account with privileges to install and configure Kubernetes resources.

== Helm chart `values.yaml`
Expand Down Expand Up @@ -103,7 +103,7 @@ helm install pulsar datastax-pulsar/pulsar --namespace pulsar --values storage_v

. Execute `kubectl get pods -A` to view your running pods.

== What's next?
== Next steps

Once your pods are up and running, continue to xref:install-upgrade:quickstart-helm-installs.adoc[Accessing Pulsar Cluster in Cloud] to access and manage your cluster.

Expand Down
10 changes: 5 additions & 5 deletions modules/ROOT/pages/install-gke.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

This document will cover installation of Luna Streaming on the Google Kubernetes Environment (GKE).

For an example set of production cluster values, see the DataStax production-ready https://github.com/datastax/pulsar-helm-chart[Helm chart]. +
For an example set of production cluster values, see the DataStax production-ready https://github.com/datastax/pulsar-helm-chart[Helm chart].

DataStax recommends these hardware resources for running Luna Streaming in a Kubernetes environment: +
DataStax recommends these hardware resources for running Luna Streaming in a Kubernetes environment:

include::ROOT:partial$helm-chart-recommendations.adoc[]

For the local machine running the Helm chart, you will need: +
For the local machine running the Helm chart, you will need:

* https://helm.sh/docs/[Helm] version 3 +
* https://helm.sh/docs/[Helm] version 3
* A Google account with privileges to install and configure Kubernetes resources.

== Helm chart `values.yaml`
Expand Down Expand Up @@ -104,7 +104,7 @@ kubectl config set-context $(kubectl config current-context) --namespace=pulsar

. Execute `kubectl get pods -A` to view your running pods.

== What's next?
== Next steps
Once your pods are up and running, continue to xref:install-upgrade:quickstart-helm-installs.adoc#manage-pulsar-cluster[Accessing Pulsar Cluster in Cloud] to access and manage your cluster.

* To learn more about using the Pulsar Admin Console, see xref:components:admin-console-tutorial.adoc[Admin Console Tutorial].
Expand Down
22 changes: 0 additions & 22 deletions modules/ROOT/partials/auto-create-credentials.adoc

This file was deleted.

8 changes: 5 additions & 3 deletions modules/ROOT/partials/cleanup-terminal-and-helm.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
Return to each window running an open process and enter `ctrl-c` to end the process. +
To completely remove all traces of the Helm chart, remove the namespace.
Return to each window running an open process and enter `ctrl-c` to end the process.
To completely remove all traces of the Helm chart, remove the namespace:

[source,shell]
----
kubectl delete namespace datastax-pulsar
----

If you want to keep the data, uninstall only the chart.
If you want to keep the data, uninstall only the chart:

[source,shell]
----
helm --namespace datastax-pulsar uninstall my-pulsar-cluster
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/partials/helm-chart-recommendations.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
* Helm version 3
* A Kubernetes cluster
* A Kubernetes cluster
* Two node pools
** One `function-worker` node pool for deploying sink and source connectors, and the other node pool for everything else
* Must use SSD disks
Expand Down
14 changes: 10 additions & 4 deletions modules/ROOT/partials/install-helm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,28 @@
+
[source,shell]
----
include::https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/install.sh[tag=helm-repo-add]
helm repo add datastax-pulsar https://datastax.github.io/pulsar-helm-chart
----

. Install the Helm chart using a minimalist values file. +
. Install the Helm chart using a minimalist values file.
This command creates a Helm release named "my-pulsar-cluster" using the DataStax 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+"]
----
VALUES_URL="{helmValuesPath}"
include::https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/install.sh[tag=helm-install]
helm install \
--namespace datastax-pulsar \
--create-namespace \
--values $VALUES_URL \
--version 3.0.4 \
my-pulsar-cluster \
datastax-pulsar/pulsar
----

. 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+"]
----
include::https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/install.sh[tag=wait-for-broker]
kubectl -n datastax-pulsar wait --for=condition=Ready pod/pulsar-broker-0 --timeout=120s
----
13 changes: 0 additions & 13 deletions modules/ROOT/partials/port-forward-beam.adoc

This file was deleted.

6 changes: 0 additions & 6 deletions modules/ROOT/partials/port-forward-s4k.adoc

This file was deleted.

6 changes: 0 additions & 6 deletions modules/ROOT/partials/port-forward-s4r.adoc

This file was deleted.

5 changes: 0 additions & 5 deletions modules/ROOT/partials/port-forward-sql.adoc

This file was deleted.

5 changes: 3 additions & 2 deletions modules/ROOT/partials/port-forward-web-service.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
In a new terminal, port forward Pulsar’s admin service.
In a new terminal, port forward Pulsar's admin service:

[source,shell]
----
include::https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/forward-broker-web-service.sh[]
kubectl port-forward -n datastax-pulsar service/pulsar-broker 8080:8080
----
8 changes: 0 additions & 8 deletions modules/components/nav.adoc

This file was deleted.

17 changes: 8 additions & 9 deletions modules/components/pages/admin-console-tutorial.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
= Pulsar Admin Console
:page-tag: luna-streaming,admin,dev,pulsar

The *DataStax Admin Console for Apache Pulsar(R)* is a web-based UI from DataStax that administers topics, namespaces, sources, sinks, and various aspects of Apache Pulsar features.

Expand Down Expand Up @@ -50,7 +49,7 @@ Scroll down to the Consume tab. In this simple example, which verifies that the

image::test-message.png[Send a message using a test client]

In doing so, you published a message to your server, and in the Test Client you're listening to your own topic. +
In doing so, you published a message to your server, and in the Test Client you're listening to your own topic.

Your client is working with the Pulsar server.

Expand All @@ -59,7 +58,7 @@ Your client is working with the Pulsar server.

By default, topics are automatically created when you first publish or subscribe. To manually create a topic or to create a partitioned topic, go to *Topics*.

The first part of a full topic name is your tenant name, followed by the namespace, and then the topic name, as below: +
The first part of a full topic name is your tenant name, followed by the namespace, and then the topic name, as below:

`public/namespace/my-topic`

Expand All @@ -72,8 +71,8 @@ To see detailed information about your topics, go to *Topics*.
[#code-samples]
== Code samples

On the Pulsar Admin Console's *Code Samples* page, there are examples for Java, Python, Golang, Node.js, WebSocket, and HTTP clients. +
Each example shows Producer, Consumer, and Reader code, plus language-specific examples of setting project properties and dependencies. +
On the Pulsar Admin Console's *Code Samples* page, there are examples for Java, Python, Golang, Node.js, WebSocket, and HTTP clients.
Each example shows Producer, Consumer, and Reader code, plus language-specific examples of setting project properties and dependencies.
For example, selecting Java will show you how to connect your Java project to Pulsar by modifying your Maven's `pom.xml` file.

[#connect-to-pulsar]
Expand All @@ -83,11 +82,11 @@ This section describes how to connect Pulsar components to the Admin console.

=== Creating and showing credentials

When connecting clients, you'll need to provide your connect token to identify your account. In the Pulsar APIs, you specify the token when creating the client object. The token is your password to your account, so keep it safe. +
When connecting clients, you'll need to provide your connect token to identify your account. In the Pulsar APIs, you specify the token when creating the client object. The token is your password to your account, so keep it safe.

The code samples automatically add your client token as part of the source code for convenience. However, a more secure practice would be to read the token from an environment variable or a file. +
The code samples automatically add your client token as part of the source code for convenience. However, a more secure practice would be to read the token from an environment variable or a file.

In the Admin console's *Credentials* page, select **Create New token** and follow the instructions. +
In the Admin console's *Credentials* page, select **Create New token** and follow the instructions.

If you previously created a token, use the Credentials page to get its value.

Expand Down Expand Up @@ -155,6 +154,6 @@ You can also follow along with this video from our *Five Minutes About Pulsar* s

video::1IwblLfPiPQ[youtube, list=PL2g2h-wyI4SqeKH16czlcQ5x4Q_z-X7_m]

== What's next
== Next steps

For more on building and running a standalone Pulsar Admin console, see the xref:admin-console-vm.adoc[Admin Console on Server/VM] or the Pulsar Admin console repo https://github.com/datastax/pulsar-admin-console#dev[readme].
Loading