diff --git a/antora.yml b/antora.yml index 422d00c..a5c80dc 100644 --- a/antora.yml +++ b/antora.yml @@ -18,6 +18,7 @@ asciidoc: pulsar-reg: 'Apache Pulsar(TM)' pulsar: 'Apache Pulsar' pulsar-short: 'Pulsar' + astra-stream: 'Astra Streaming' # Required for include::common partials that are shared with Astra Streaming web-ui: 'Admin Console' diff --git a/modules/ROOT/pages/faqs.adoc b/modules/ROOT/pages/faqs.adoc index ba115f8..b1d01eb 100644 --- a/modules/ROOT/pages/faqs.adoc +++ b/modules/ROOT/pages/faqs.adoc @@ -1,40 +1,40 @@ -= Luna Streaming FAQs += {product} FAQs :navtitle: FAQs -If you are new to {company} Luna Streaming and its {pulsar} enhancements, these FAQs are for you. +If you are new to {company} {product} and its {pulsar} enhancements, these FAQs are for you. -== What is {company} Luna Streaming? +== What is {company} {product}? -{company} Luna Streaming 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. +{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. -== What components and features are provided by {company} Luna Streaming? +== What components and features are provided by {company} {product}? -In addition to {pulsar} itself, {company} Luna Streaming provides: +In addition to {pulsar} itself, {company} {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 -* Cassandra, Elastic, Kinesis, Kafka, and JDBC connectors +* {cass-short}, Elastic, Kinesis, Kafka, and JDBC connectors * A management dashboard * A monitoring and alerting system -== On which version of {pulsar} is {company} Luna Streaming based? +== On which version of {pulsar} is {company} {product} based? -{company} Luna Streaming {luna-version} is based on its distribution of {pulsar} {pulsar-version}, plus features and additional enhancements from {company} contributors. +{company} {product} {luna-version} is based on its distribution of {pulsar} {pulsar-version}, plus features and additional enhancements from {company} contributors. -== What does {company} Luna Streaming provide that I cannot get with open-source {pulsar}? +== What does {company} {product} provide that I cannot get with open-source {pulsar}? -{company} Luna Streaming 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. +{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. -== Is {company} Luna Streaming an open-source project? +== Is {company} {product} an open-source project? -Yes, {company} Luna Streaming is open source. See the <>. +Yes, {company} {product} is open source. See the <>. -== Which Kubernetes platforms are supported by {company} Luna Streaming? +== Which Kubernetes platforms are supported by {company} {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} Luna Streaming public GitHub repos? +== Where are the {company} {product} public GitHub repos? There are several public repos, each with a different purpose. See: @@ -42,36 +42,36 @@ There are several public repos, each with a different purpose. See: * https://github.com/datastax/pulsar-admin-console[https://github.com/datastax/pulsar-admin-console] : This is the repo for the {pulsar-short} admin console, which allows for the configuration and monitoring of {pulsar-short}. * https://github.com/datastax/pulsar-heartbeat[https://github.com/datastax/pulsar-heartbeat] : This is a monitoring/observability tool for {pulsar-short} that tracks the health of the cluster and can generate alerts in Slack and OpsGenie. * https://github.com/datastax/pulsar-helm-chart[https://github.com/datastax/pulsar-helm-chart] : This is the Helm chart for deploying the {company} {pulsar-short} Distro in an existing Kubernetes cluster. -* https://github.com/datastax/pulsar-sink[https://github.com/datastax/pulsar-sink] : This is the {company} {pulsar} Connector (`pulsar-sink` for Cassandra) repo. +* https://github.com/datastax/pulsar-sink[https://github.com/datastax/pulsar-sink] : This is the {company} {pulsar} Connector (`pulsar-sink` for {cass-short}) 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} Luna Streaming installation? +== Is there a prerequisite version of Java needed for the {company} {product} installation? -The {company} Luna Streaming 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 {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. -== What are the install options for {company} Luna Streaming? +== What are the install options for {company} {product}? * **KAAP Helm chart (Recommended)**: Use the {company} https://github.com/datastax/kaap/[KAAP operator Helm chart], which provides Kubernetes-native autoscaling and simplified management for {pulsar} clusters. For more information, see the xref:kaap-operator::index.adoc[Kubernetes Autoscaling for {pulsar} (KAAP)] documentation. -* **Luna Streaming Helm chart**: Use the Helm chart provided at https://github.com/apache/pulsar-helm-chart[https://github.com/datastax/pulsar-helm-chart] to install {company} Luna Streaming in an existing Kubernetes cluster on your laptop or hosted by a cloud provider. -* **Tarball**: Use the tarball provided at https://github.com/datastax/pulsar/releases[https://github.com/datastax/pulsar/releases] to install {company} Luna Streaming on a server or VM. -* **Ansible**: Use the {company} Ansible scripts provided at https://github.com/datastax/pulsar-ansible[https://github.com/datastax/pulsar-ansible] to install {company} Luna Streaming on a server or VM with our provided playbooks. +* **{product} Helm chart**: Use the Helm chart provided at https://github.com/apache/pulsar-helm-chart[https://github.com/datastax/pulsar-helm-chart] to install {company} {product} in an existing Kubernetes cluster on your laptop or hosted by a cloud provider. +* **Tarball**: Use the tarball provided at https://github.com/datastax/pulsar/releases[https://github.com/datastax/pulsar/releases] to install {company} {product} on a server or VM. +* **Ansible**: Use the {company} Ansible scripts provided at https://github.com/datastax/pulsar-ansible[https://github.com/datastax/pulsar-ansible] to install {company} {product} on a server or VM with our provided playbooks. -== How do I install {company} Luna Streaming in my Kubernetes cluster? +== How do I install {company} {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} Luna Streaming on my server or VM? +== How do I install {company} {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} Luna Streaming Admin Console? +== What task can I perform in the {company} {product} Admin Console? From the Admin Console, you can: * Add and run {pulsar-short} clients * Establish credentials for secure connections * Define topics that can be published for streaming apps -* Set up {pulsar-short} sinks that publish topics and make them available to subscribers, such as for a Cassandra database table +* Set up {pulsar-short} sinks that publish topics and make them available to subscribers, such as for a {cass-short} database table * Control namespaces used by {pulsar-short} * Use the Admin API @@ -81,7 +81,7 @@ https://github.com/datastax/pulsar-heartbeat[{pulsar-short} Heartbeat] monitors == What are the features provided by {company} {pulsar} Connector (`pulsar-sink`) that are not supported in `kafka-sink`? -The https://pulsar.apache.org/docs/en/io-overview/[{pulsar-short} IO framework] provides many features that are not possible in Kafka, and has different compression formats and auth/security features. The features are handled by {pulsar-short}. For more, see xref:connectors:index.adoc[Luna Streaming IO Connectors]. +The https://pulsar.apache.org/docs/en/io-overview/[{pulsar-short} IO framework] provides many features that are not possible in Kafka, and has different compression formats and auth/security features. The features are handled by {pulsar-short}. For more, see xref:connectors:index.adoc[{product} IO Connectors]. The {company} {pulsar} Connector allows single-record acknowledgement and negative acknowledgements. @@ -96,17 +96,17 @@ 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} Luna Streaming. It's built in! +* The `pulsar-sink` functionality of {company} {pulsar} Connector is included with {company} {product}. It's built in! * You can optionally download the {company} {pulsar} Connector tarball from the https://downloads.datastax.com/#pulsar-sink[{company} Downloads] site, 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 Cassandra. +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}. See the xref:pulsar-connector:ROOT:index.adoc[{company} {pulsar} Connector documentation]. -== What is the {company} Change Data Capture (CDC) for Cassandra connector? +== What is the {company} Change Data Capture (CDC) for {cass-short} connector? -This source connector streams data changes from Cassandra tables to Pulsar topics. -For more information, see the xref:cdc-for-cassandra:ROOT:index.adoc[{company} CDC for Cassandra connector documentation]. +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} Luna Streaming provide? +== What client APIs does {company} {product} provide? The same as for {pulsar}. See https://pulsar.apache.org/docs/en/client-libraries/. \ No newline at end of file diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 7364bed..cebc98f 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,23 +1,23 @@ -= Welcome to {company} Luna Streaming -:navtitle: Luna Streaming += Welcome to {company} {product} +:navtitle: {product} -{company} Luna Streaming is a production-ready distribution of {pulsar} built to run seamlessly on any CNCF conformant version of Kubernetes. {company} Luna Streaming 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. +{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. == Release notes -The latest release of {company} Luna Streaming is {luna-version}, which matches the supported, distributed {pulsar-short} version numbers. +The latest release of {company} {product} is {luna-version}, which matches the supported, distributed {pulsar-short} version numbers. -The prior Luna Streaming release (2.10.x) provided the {pulsar-short} 2.10.x distribution. +The prior {product} release (2.10.x) provided the {pulsar-short} 2.10.x distribution. -Refer to the {company} Luna Streaming 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 & linked commit IDs that were implemented in the latest Luna Streaming {luna-version} release. +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 & 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} Luna Streaming provides: +In addition to the distribution of https://pulsar.apache.org/en/versions/[{pulsar} {pulsar-version}], {company} {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 -* Cassandra, Elastic, Kinesis, Kafka, and JDBC xref:connectors:index.adoc[connectors] +* {cass-short}, Elastic, Kinesis, Kafka, and JDBC xref:connectors:index.adoc[connectors] * The xref:components:starlight.adoc[Starlight suite of {pulsar-short} protocol handlers for Kafka, RabbitMQ, and JMS] @@ -57,7 +57,7 @@ In addition to the distribution of https://pulsar.apache.org/en/versions/[{pulsa == 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 an existing Kubernetes environment, deploy {product} 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]. * If you want to learn about monitoring with {pulsar-short} Heartbeat, see xref:components:pulsar-monitor.adoc[{pulsar-short} Heartbeat]. -* If you have questions about Luna Streaming, see xref::faqs.adoc[Luna Streaming FAQs]. \ No newline at end of file +* If you have questions about {product}, see xref::faqs.adoc[{product} FAQs]. \ No newline at end of file diff --git a/modules/components/pages/admin-console-tutorial.adoc b/modules/components/pages/admin-console-tutorial.adoc index d8628ca..3c6e3ef 100644 --- a/modules/components/pages/admin-console-tutorial.adoc +++ b/modules/components/pages/admin-console-tutorial.adoc @@ -5,7 +5,7 @@ The *{company} Admin Console for {pulsar-reg}* is a web-based UI from {company} [#getting-started] == Getting Started in {pulsar-short} Admin Console -In the *Luna Streaming {pulsar-short} Admin Console*, you can use {pulsar-short} clients to send and receive pub/sub messages. +In the *{product} {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: @@ -26,7 +26,7 @@ image::luna-streaming-select-namespace.png[Select Namespace] Messages published to namespaces are automatically replicated to all node(s) in the cluster. -image::luna-streaming-admin-console.png[Luna Streaming Admin Console] +image::luna-streaming-admin-console.png[{product} Admin Console] For interactive code samples, go to *Code Samples*. diff --git a/modules/components/pages/pulsar-beam.adoc b/modules/components/pages/pulsar-beam.adoc index 645dab9..ac6c9a3 100644 --- a/modules/components/pages/pulsar-beam.adoc +++ b/modules/components/pages/pulsar-beam.adoc @@ -1,6 +1,6 @@ -= {pulsar-short} Beam with Luna Streaming += {pulsar-short} Beam with {product} :navtitle: {pulsar-short} Beam -:description: Install a minimal Luna Streaming Helm chart that includes {pulsar-short} Beam +:description: Install a minimal {product} Helm chart that includes {pulsar-short} Beam :helmValuesPath: https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/beam/values.yaml The https://github.com/kafkaesque-io/pulsar-beam[{pulsar-short} Beam] project is an HTTP-based streaming and queueing system for use with {pulsar}. @@ -15,7 +15,7 @@ In this guide, you'll install a minimal {company} {pulsar-short} Helm chart that * 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 Luna Streaming Helm chart +== Install {product} Helm chart include::partial$install-helm.adoc[] @@ -40,7 +40,7 @@ Forwarding from [::1]:8085 -> 8085 == Start a message consumer In a new terminal window, run the following curl command to begin streaming server-sent events. -See xref:astra-streaming:developing:configure-pulsar-env.adoc[configuring your local environment for Astra Streaming]. +See xref:astra-streaming:developing:configure-pulsar-env.adoc[configuring your local environment for {astra-stream}]. [source,shell] ---- diff --git a/modules/components/pages/pulsar-sql.adoc b/modules/components/pages/pulsar-sql.adoc index 2fd6a24..37c5d22 100644 --- a/modules/components/pages/pulsar-sql.adoc +++ b/modules/components/pages/pulsar-sql.adoc @@ -1,6 +1,6 @@ -= Using {pulsar-short} SQL with Luna Streaming += Using {pulsar-short} SQL with {product} :navtitle: {pulsar-short} SQL -:description: This guide installs the Luna Streaming Helm chart using minimum values for a working {pulsar-short} cluster that includes SQL workers +:description: This guide installs the {product} 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. @@ -26,7 +26,7 @@ PrestoDB has been replaced by Trino, and {pulsar} is using Trino's version. The Trino CLI uses the "X-TRINO-USER" header for authentications. ==== -== Install Luna Streaming Helm chart +== Install {product} Helm chart include::partial$install-helm.adoc[] diff --git a/modules/connectors/pages/index.adoc b/modules/connectors/pages/index.adoc index f6f300f..454921f 100644 --- a/modules/connectors/pages/index.adoc +++ b/modules/connectors/pages/index.adoc @@ -6,7 +6,7 @@ [TIP] ==== -There are three versions of the {company} Luna Streaming distribution. +There are three versions of the {company} {product} distribution. The `lunastreaming-all` version includes all connectors. ==== @@ -30,8 +30,8 @@ The following sink connectors are included in {product}: Experimental sink connectors:: The following sink connectors are experimental. -They are available in the `luna-streaming-all` version of {product}, and you can use them in your Luna Streaming cluster. -They are considered experimental because they aren't fully supported or tested with Astra Streaming. +They are available in the `luna-streaming-all` version of {product}, and you can use them in your {product} cluster. +They are considered experimental because they aren't fully supported or tested with {astra-stream}. + * Aerospike * Apache Geode @@ -90,8 +90,8 @@ The following source connectors are included in {product}: Experimental source connectors:: The following source connectors are experimental. -They are available in the `luna-streaming-all` version of {product}, and you can use them in your Luna Streaming cluster. -They are considered experimental because they aren't fully supported or tested with Astra Streaming. +They are available in the `luna-streaming-all` version of {product}, and you can use them in your {product} cluster. +They are considered experimental because they aren't fully supported or tested with {astra-stream}. + * {cass} * Apache Geode diff --git a/modules/install-upgrade/pages/production-cluster-sizing.adoc b/modules/install-upgrade/pages/production-cluster-sizing.adoc index 51530d5..1447148 100644 --- a/modules/install-upgrade/pages/production-cluster-sizing.adoc +++ b/modules/install-upgrade/pages/production-cluster-sizing.adoc @@ -40,7 +40,7 @@ Scale bookies up on disc usage percentage. Scale down manually by making a booki [#recommended] === Recommended server components -The {company} Luna Streaming Helm chart deployment includes optional but highly recommended server components for better {pulsar-short} cluster metrics monitoring and operation visibility. +The {company} {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 AutoRecovery] - This is a {pulsar-short} component that recovers Bookkeeper 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. diff --git a/modules/install-upgrade/pages/quickstart-helm-installs.adoc b/modules/install-upgrade/pages/quickstart-helm-installs.adoc index 0004818..0a41fb4 100644 --- a/modules/install-upgrade/pages/quickstart-helm-installs.adoc +++ b/modules/install-upgrade/pages/quickstart-helm-installs.adoc @@ -5,10 +5,10 @@ The {company} production-ready Helm chart is now deprecated. For new deployments, we recommend using the {company} https://github.com/datastax/kaap/[KAAP operator Helm chart], which provides Kubernetes-native autoscaling and simplified management for {pulsar} clusters. For more information, see the xref:kaap-operator::index.adoc[Kubernetes Autoscaling for {pulsar} (KAAP)] documentation. ==== -You have options for installing *{company} Luna Streaming*: +You have options for installing *{company} {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} Luna Streaming 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} {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 https://github.com/datastax/pulsar-ansible[https://github.com/datastax/pulsar-ansible]. The Helm chart and options described below configure an {pulsar} cluster. @@ -32,7 +32,7 @@ The resulting configuration includes support for: == Prerequisites -{company} recommends these hardware resources for running Luna Streaming in a Kubernetes environment: +{company} recommends these hardware resources for running {product} in a Kubernetes environment: * Helm version 3 @@ -143,7 +143,7 @@ There are two ways to override `default_storage`: existingStorageClassName: bookkeeper-storageclass.yaml ---- -== Install Luna Streaming in a cloud provider +== Install {product} in a cloud provider First, create the namespace; in this example, we use `pulsar`. @@ -157,9 +157,9 @@ TIP: To avoid having to specify the `pulsar` namespace on each subsequent comman `kubectl config set-context $(kubectl config current-context) --namespace=pulsar` -Once {pulsar-short} is installed, you can now access your Luna Streaming cluster. +Once {pulsar-short} is installed, you can now access your {product} cluster. -=== Access the Luna Streaming cluster +=== Access the {product} cluster The default values will create a ClusterIP for all components. ClusterIPs are only accessible within the Kubernetes cluster. The easiest way to work with {pulsar-short} is to log into the bastion host (assuming it is in the `pulsar` namespace): @@ -191,7 +191,7 @@ proxy: If you are using a load balancer on the proxy, you can find the IP address using `kubectl get service -n pulsar`. -=== Manage Luna Streaming with {pulsar-short} Admin Console +=== Manage {product} with {pulsar-short} Admin Console Or if you would rather go directly to the broker: @@ -199,7 +199,7 @@ Or if you would rather go directly to the broker: `kubectl port-forward -n pulsar $(kubectl get pods -n pulsar -l component=broker -o jsonpath='{.items[0].metadata.name}') 6650:6650` -=== Manage Luna Streaming with {pulsar-short} Admin Console +=== Manage {product} with {pulsar-short} Admin Console The {pulsar-short} Admin Console is installed in your cluster by enabling the console with this values setting: @@ -221,7 +221,7 @@ pulsarAdminConsole: To learn more about using the {pulsar-short} Admin Console, see xref:components:admin-console-tutorial.adoc[Admin Console Tutorial]. -== Install Luna Streaming locally +== Install {product} locally With the prerequisites listed above met, start minikube with adequate resources. For example: @@ -501,4 +501,4 @@ Once you have created the secrets that store the certificate info (or specified == Next steps -To learn about installing Luna Streaming for Bare Metal/VM, see xref:install-upgrade:quickstart-server-installs.adoc[Quickstart for Bare Metal/VM Installs]. \ No newline at end of file +To learn about installing {product} for Bare Metal/VM, see xref:install-upgrade:quickstart-server-installs.adoc[Quickstart for Bare Metal/VM Installs]. \ No newline at end of file diff --git a/modules/install-upgrade/pages/quickstart-server-installs.adoc b/modules/install-upgrade/pages/quickstart-server-installs.adoc index 4ce451a..a1fa8dd 100644 --- a/modules/install-upgrade/pages/quickstart-server-installs.adoc +++ b/modules/install-upgrade/pages/quickstart-server-installs.adoc @@ -1,8 +1,8 @@ = Quick Start for Bare Metal/VM installs -This document explains xref:install-upgrade:quickstart-server-installs.adoc#install[installation] of Luna Streaming for Bare Metal/VM deployments with a {pulsar-short} tarball. +This document explains xref:install-upgrade:quickstart-server-installs.adoc#install[installation] of {product} for Bare Metal/VM deployments with a {pulsar-short} tarball. -The resulting Luna Streaming deployment includes: +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. * *Built-in Schema Registry:* Guarantee messaging type safety on a per-topic basis without relying on any external facility. @@ -41,12 +41,12 @@ Check this setting with `cat /sys/kernel/mm/transparent_hugepage/enabled` and `c [#install] == Installation -. Download the {company} Luna Streaming tarball from the https://github.com/datastax/pulsar/releases[{company} GitHub repo]. There are three versions of Luna Streaming currently available: +. Download the {company} {product} tarball from the https://github.com/datastax/pulsar/releases[{company} GitHub repo]. There are three versions of {product} currently available: + [cols="1,1"] [%autowidth] |=== -|Luna Streaming filename |Included components +|{product} filename |Included components |`lunastreaming-core--bin.tar.gz` |Contains the core {pulsar-short} modules: Zookeeper, Broker, BookKeeper, and function worker @@ -67,7 +67,7 @@ tar xzvf lunastreaming-3.1.3.0-bin.tar.gz cd lunastreaming-3.1.3.0 ---- -. Enter `ls -al` to view your Luna Streaming files: +. Enter `ls -al` to view your {product} files: + [source,bash] ---- @@ -86,11 +86,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} Luna Streaming tarball. +You have successfully installed the {company} {product} tarball. == Additional tooling -Once the {company} Luna Streaming tarball is installed, you may want to add additional tooling to your server/VM deployment. +Once the {company} {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 https://github.com/datastax/pulsar-admin-console[{company} GitHub repo] and follow the instructions xref:components:admin-console-vm.adoc[here]. diff --git a/modules/install-upgrade/pages/supported-versions.adoc b/modules/install-upgrade/pages/supported-versions.adoc index 66093ac..267480f 100644 --- a/modules/install-upgrade/pages/supported-versions.adoc +++ b/modules/install-upgrade/pages/supported-versions.adoc @@ -11,13 +11,13 @@ Support covers only the following Software versions for {pulsar}: |3.1.x |=== -Support covers only the following Software versions for {company} Luna Streaming Distribution: +Support covers only the following Software versions for {company} {product} Distribution: [cols="2*"] |=== |Name |Version -|{company} Luna Streaming Distribution +|{company} {product} Distribution |v.1.0.0 and above |=== @@ -45,13 +45,13 @@ Support covers only the following Software versions for the Open Source Projects |=== -Support covers only the following {company} Luna Streaming Connectors and {pulsar} Connectors (as included in the {pulsar} download): +Support covers only the following {company} {product} Connectors and {pulsar} Connectors (as included in the {pulsar} download): [cols="2*"] |=== |Name |Version -|Cassandra enhanced sink +|{cass-short} enhanced sink |v1.6.11 |Cloud storage sink |v2.10.0 @@ -71,7 +71,7 @@ Support covers only the following {company} Luna Streaming Connectors and {pulsa |v3.1.x |Snowflake sink |v0.1.13 -|Cassandra source +|{cass-short} source |v2.2.9 |Data generator source |v3.1.x diff --git a/modules/install-upgrade/pages/upgrade-guide.adoc b/modules/install-upgrade/pages/upgrade-guide.adoc index 003f927..807f825 100644 --- a/modules/install-upgrade/pages/upgrade-guide.adoc +++ b/modules/install-upgrade/pages/upgrade-guide.adoc @@ -1,15 +1,15 @@ -= Upgrade Luna Streaming from 2.10 to 3.1 += Upgrade {product} from 2.10 to 3.1 :navtitle: Upgrade from 2.10 to 3.1 -This guide provides instructions and recommendations for upgrading Luna Streaming from version 2.10 to 3.1. +This guide provides instructions and recommendations for upgrading {product} from version 2.10 to 3.1. -Upgrades to Luna Streaming 3.1 should only be performed from Luna Streaming 2.10. +Upgrades to {product} 3.1 should only be performed from {product} 2.10. -All Luna Streaming 2.10 components support the upgrade to 3.1. +All {product} 2.10 components support the upgrade to 3.1. == Functional impacts -This section describes changes in Luna Streaming 3.1 that may impact how your deployment functions. +This section describes changes in {product} 3.1 that may impact how your deployment functions. === Default system topics @@ -17,7 +17,7 @@ In {pulsar-short} 3.1, system topics are now enabled by default. === Prometheus metrics changes -Prometheus metrics have been updated in Luna Streaming 3.1. +Prometheus metrics have been updated in {product} 3.1. * Prometheus Client version has changed from `0.5.0` to `0.16.0` * Prometheus Metric type `UNTYPED` is renamed to `UNKNOWN` @@ -26,7 +26,7 @@ Prometheus metrics have been updated in Luna Streaming 3.1. .Renamed metrics [cols="2,2"] |=== -|Luna Streaming 2.10 |Luna Streaming 3.1 +|{product} 2.10 |{product} 3.1 |pulsar_expired_token_count |pulsar_expired_token_total @@ -125,7 +125,7 @@ The following PRs were merged to update metrics: === Other functional impacts -The following PRs were merged in Luna Streaming 3.1 that may impact your deployment's functionality. +The following PRs were merged in {product} 3.1 that may impact your deployment's functionality. [cols="1,2,3"] |=== @@ -162,7 +162,7 @@ The following PRs were merged in Luna Streaming 3.1 that may impact your deploym == Configuration impacts -This section describes changes in Luna Streaming 3.1 that may impact your deployment's configuration. +This section describes changes in {product} 3.1 that may impact your deployment's configuration. === Configuration values removed in 3.1 @@ -175,12 +175,12 @@ The `MetadataStore` instance is now passed from the `PulsarService` directly to === Default values changed or deprecated in 3.1 -The following default values in `broker.conf` and `standalone.conf` have changed or been deprecated in Luna Streaming 3.1. +The following default values in `broker.conf` and `standalone.conf` have changed or been deprecated in {product} 3.1. .`broker.conf` and `standalone.conf` values [cols="1,1,1"] |=== -|Configuration |Luna Streaming 2.10 Default | Luna Streaming 3.1 Default +|Configuration |{product} 2.10 Default | {product} 3.1 Default |`managedLedgerCacheEvictionFrequency`` |`100.0` @@ -217,11 +217,11 @@ The following default values in `broker.conf` and `standalone.conf` have changed == Operational impacts -This section describes changes in Luna Streaming 3.1 that may impact how your deployment operates. +This section describes changes in {product} 3.1 that may impact how your deployment operates. === JDK 17 upgrade -Luna Streaming 3.1 uses JDK 17. +{product} 3.1 uses JDK 17. The {pulsar-short} server module's `javac` release version is `17`. @@ -231,7 +231,7 @@ This modification is described in detail in https://github.com/apache/pulsar/pul === Python 2 support removed -Luna Streaming 3.1 removes Python 2 from build scripts. +{product} 3.1 removes Python 2 from build scripts. Python 3 is used in the build image. @@ -243,15 +243,15 @@ This modification is described in detail in https://github.com/apache/pulsar/pul == Known issues -This section describes known issues encountered when upgrading to Luna Streaming 3.1. +This section describes known issues encountered when upgrading to {product} 3.1. === Bookkeeper / RocksDB format -**Downgrading to Luna Streaming 2.10 from Luna Streaming 3.1 is not supported for Bookies and ZooKeeper**. +**Downgrading to {product} 2.10 from {product} 3.1 is not supported for Bookies and ZooKeeper**. {pulsar-short} 3.1 uses RocksDB `7.x`, which writes in a format that is not compatible with RocksDB `6.x`. -Luna Streaming 2.10 uses Bookkeeper 4.14, which uses RocksDB `6.x`. +{product} 2.10 uses Bookkeeper 4.14, which uses RocksDB `6.x`. All other components such as Broker, Proxy, and Functions Worker can be downgraded at any time. @@ -259,7 +259,7 @@ For more information, see https://github.com/apache/pulsar/issues/22051[Issue 22 == Upgrade procedure -Luna Streaming can be deployed on bare metal, Docker, and Kubernetes. +{product} can be deployed on bare metal, Docker, and Kubernetes. This guide only addresses Kubernetes deployment. @@ -267,7 +267,7 @@ For more information on upgrading bare metal and Docker {pulsar-short} deploymen === Upgrade Kubernetes deployment with KAAP Operator -Upgrade to Luna Streaming 3.1 on Kubernetes with the KAAP (Kubernetes Autoscaling for {pulsar}) operator. +Upgrade to {product} 3.1 on Kubernetes with the KAAP (Kubernetes Autoscaling for {pulsar}) operator. For more information, see the xref:kaap-operator::index.adoc[KAAP documentation]. @@ -350,7 +350,7 @@ kubectl logs *POD-NAME* -n *NAMESPACE* === Upgrade Kubernetes deployment with Helm chart -The Helm chart for Luna Streaming is available in the https://github.com/datastax/pulsar-helm-chart/blob/master/helm-chart-sources/pulsar/values.yaml[Helm chart sources] repository. +The Helm chart for {product} is available in the https://github.com/datastax/pulsar-helm-chart/blob/master/helm-chart-sources/pulsar/values.yaml[Helm chart sources] repository. . To prevent data loss, back up your existing {pulsar-short} data and configuration files. . To save your current Helm release configuration, run the following command: diff --git a/modules/operations/pages/auth.adoc b/modules/operations/pages/auth.adoc index 52d7f99..32f1ac8 100644 --- a/modules/operations/pages/auth.adoc +++ b/modules/operations/pages/auth.adoc @@ -1,4 +1,4 @@ -= Luna Streaming Authentication += {product} Authentication The Helm chart can enable token-based authentication for your {pulsar-short} cluster. For more, see https://pulsar.apache.org/docs/en/security-token-admin/[{pulsar-short} token authentication]. diff --git a/modules/operations/pages/functions.adoc b/modules/operations/pages/functions.adoc index 931105c..808e89a 100644 --- a/modules/operations/pages/functions.adoc +++ b/modules/operations/pages/functions.adoc @@ -10,7 +10,7 @@ The function automatically runs for each message published to the specified inpu Functions are implemented using https://pulsar.apache.org/docs/en/functions-overview/[{pulsar-reg} functions]. -https://github.com/datastax/pulsar[Luna Streaming 2.10 or later] is required to deploy custom functions in {pulsar-short}. +https://github.com/datastax/pulsar[{product} 2.10 or later] is required to deploy custom functions in {pulsar-short}. == Manage functions using {pulsar-short} Admin CLI diff --git a/modules/operations/pages/scale-cluster.adoc b/modules/operations/pages/scale-cluster.adoc index 57e272f..25a27c4 100644 --- a/modules/operations/pages/scale-cluster.adoc +++ b/modules/operations/pages/scale-cluster.adoc @@ -1,6 +1,6 @@ -= Scaling your Luna Streaming cluster += Scaling your {product} cluster -You can scale Luna Streaming clusters up for more compute capacity and down for less capacity. +You can scale {product} clusters up for more compute capacity and down for less capacity. include::operations:partial$operator-scaling.adoc[] diff --git a/modules/operations/pages/troubleshooting.adoc b/modules/operations/pages/troubleshooting.adoc index cdf84d8..b69ec45 100644 --- a/modules/operations/pages/troubleshooting.adoc +++ b/modules/operations/pages/troubleshooting.adoc @@ -35,7 +35,7 @@ image::gcp-quota-example2.png[GCP Backend Quota] If your pods are stuck in a *Pending* state after installation or your cloud provider is warning you about *Unschedulable Pods*, there are a few ways to work through this: -* If some of your pods start, but others like `pulsar-adminconsole` and `pulsar-grafana` are left in an *Unschedulable* state, you might need to add CPUs to your existing nodes or an additional node pool. Luna Streaming requires more resources than {pulsar}. +* If some of your pods start, but others like `pulsar-adminconsole` and `pulsar-grafana` are left in an *Unschedulable* state, you might need to add CPUs to your existing nodes or an additional node pool. {product} requires more resources than {pulsar}. * To examine a specific pod, use `kubectl describe`. For example, if your `pulsar-bookkeeper-0` pod is not scheduling, use `kubectl describe pods/pulsar-bookkeeper-0` to view detailed output on the pod's state, dependencies, and events. @@ -44,7 +44,7 @@ If your pods are stuck in a *Pending* state after installation or your cloud pro [#bastionpod] == Bastion pod -The bastion pod deploys with Luna Streaming and allows a user to execute administrative commands in a bash shell of the cluster. This can be a helpful troubleshooting tool for testing the health of your cluster. +The bastion pod deploys with {product} and allows a user to execute administrative commands in a bash shell of the cluster. This can be a helpful troubleshooting tool for testing the health of your cluster. === Access bastion pod