Doc 3707 2 2103x

antora.yml

@@ -18,7 +18,32 @@ asciidoc:
     pulsar-reg: 'Apache Pulsar(TM)'
     pulsar: 'Apache Pulsar'
     pulsar-short: 'Pulsar'
+    pulsar-beam: 'Pulsar Beam'
+    kaap: 'Kubernetes Autoscaling for Apache Pulsar (KAAP)'
     astra-stream: 'Astra Streaming'
+    kafka-reg: 'Apache Kafka(R)'
+    kafka: 'Apache Kafka'
+    kafka-short: 'Kafka'
+    kafka-connect: 'Kafka Connect'
+    geode-reg: 'Apache Geode(TM)'
+    hbase-reg: 'Apache HBase(R)'
+    kudu-reg: 'Apache Kudu(TM)'
+    phoenix-reg: 'Apache Phoenix(TM)'
+    solr-reg: 'Apache Solr(TM)'
+    pulsar-admin-console-repo: 'https://github.com/datastax/pulsar-admin-console'
+    pulsar-heartbeat-repo: 'https://github.com/datastax/pulsar-heartbeat'
+    pulsar-sink-repo: 'https://github.com/datastax/pulsar-sink'
+    pulsar-ansible-repo: 'https://github.com/datastax/pulsar-ansible'
+    pulsar-helm-chart-repo: 'https://github.com/datastax/pulsar-helm-chart'
+    pulsar-openid-connect-repo: 'https://github.com/datastax/pulsar-openid-connect-plugin'
+    pulsar-repo: 'https://github.com/datastax/pulsar'
+    pulsar-beam-repo: 'https://github.com/kafkaesque-io/pulsar-beam'
+    bookkeeper-reg: 'Apache BookKeeper(TM)'
+    bookkeeper-short: 'BookKeeper'
+    zookeeper-reg: 'Apache ZooKeeper(TM)'
+    zookeeper: 'Apache ZooKeeper'
+    zookeeper-short: 'ZooKeeper'
+    crd: 'custom resource definition (CRD)'
 
     # Required for include::common partials that are shared with Astra Streaming
     web-ui: 'Admin Console'

local-preview-playbook.yml

@@ -54,23 +54,176 @@ asciidoc:
     xrefstyle: short
     # CUSTOM ATTRIBUTES
     company: 'DataStax'
+    trust-center: 'IBM Trust Center'
+    trust-center-url: 'https://www.ibm.com/trust'
+    trust-center-link: '{trust-center-url}[{trust-center}]'
+    support-url: 'https://www.ibm.com/mysupport/s/'
+    dsbulk: 'DataStax Bulk Loader (DSBulk)'
+    dsbulk-short: 'DSBulk'
+    dsbulk-repo: 'https://github.com/datastax/dsbulk'
+    astra: 'Astra'
+    astra-db: 'Astra DB'
+    astra-ui: 'Astra Portal'
+    astra-url: 'https://astra.datastax.com'
+    astra-ui-link: '{astra-url}[{astra-ui}^]'
+    db-classic: 'Managed Cluster'
+    db-serverless: 'Serverless (non-vector)'
+    db-serverless-vector: 'Serverless (vector)'
+    scb: 'Secure Connect Bundle (SCB)'
+    scb-short: 'SCB'
+    scb-brief: 'Secure Connect Bundle'
+    devops-api: 'DevOps API'
+    devops-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$devops-api/index.html'
+    astra-cli: 'Astra CLI'
+    astra-stream: 'Astra Streaming'
+    starlight-kafka: 'Starlight for Kafka'
+    starlight-rabbitmq: 'Starlight for RabbitMQ'
+    astra-streaming-examples-repo: 'https://github.com/datastax/astra-streaming-examples'
+    sstable-sideloader: '{astra-db} Sideloader'
+    zdm: 'Zero Downtime Migration'
+    zdm-short: 'ZDM'
+    zdm-proxy: 'ZDM Proxy'
+    cass-migrator: 'Cassandra Data Migrator (CDM)'
+    cass-migrator-short: 'CDM'
+    hcd: 'Hyper-Converged Database (HCD)'
+    hcd-short: 'HCD'
+    dse: 'DataStax Enterprise (DSE)'
+    dse-short: 'DSE'
+    metrics-collector: 'DSE Metrics Collector'
+    mc: 'Mission Control'
+    opscenter: 'DSE OpsCenter'
+    studio: 'DataStax Studio'
+    cass-reg: 'Apache Cassandra(R)'
+    cass: 'Apache Cassandra'
+    cass-short: 'Cassandra'
+    cql: 'Cassandra Query Language (CQL)'
+    cql-shell: 'CQL shell'
+    cql-console: 'CQL console'
+    cql-service: 'CQL Service'
+    pulsar-reg: 'Apache Pulsar(TM)'
+    pulsar: 'Apache Pulsar'
+    pulsar-short: 'Pulsar'
+    spark-reg: 'Apache Spark(TM)'
+    spark: 'Apache Spark'
+    spark-short: 'Spark'
+    spark-connect: 'Spark Connect'
+    spark-connector: 'Apache Cassandra Spark Connector'
+    spark-connector-short: 'Spark Connector'
+    kafka-reg: 'Apache Kafka(R)'
+    kafka: 'Apache Kafka'
+    kafka-short: 'Kafka'
+    kafka-connect: 'Kafka Connect'
+    kafka-connector: 'DataStax Apache Kafka Connector'
+    kafka-connector-short: 'Kafka Connector'
+    solr-reg: 'Apache Solr(TM)'
+    solr: 'Apache Solr'
+    solr-short: 'Solr'
+    lucene-reg: 'Apache Lucene(TM)'
+    lucene: 'Apache Lucene'
+    lucene-short: 'Lucene'
+    hadoop-reg: 'Apache Hadoop(R)'
+    hadoop: 'Apache Hadoop'
+    hadoop-short: 'Hadoop'
+    airflow-reg: 'Apache Airflow(R)'
+    airflow: 'Apache Airflow'
+    airflow-short: 'Airflow'
+    maven-reg: 'Apache Maven(TM)'
+    maven: 'Apache Maven'
+    maven-short: 'Maven'
+    flink-reg: 'Apache Flink(R)'
+    flink: 'Apache Flink'
+    flink-short: 'Flink'
+    beam-reg: 'Apache Beam(R)'
+    beam: 'Apache Beam'
+    beam-short: 'Beam'
+    geode-reg: 'Apache Geode(TM)'
+    geode: 'Apache Geode'
+    geode-short: 'Geode'
+    hbase-reg: 'Apache HBase(R)'
+    hbase: 'Apache HBase'
+    hbase-short: 'HBase'
+    kudu-reg: 'Apache Kudu(TM)'
+    kudu: 'Apache Kudu'
+    kudu-short: 'Kudu'
+    phoenix-reg: 'Apache Phoenix(TM)'
+    phoenix: 'Apache Phoenix'
+    phoenix-short: 'Phoenix'
+    zookeeper-reg: 'Apache ZooKeeper(TM)'
+    zookeeper: 'Apache ZooKeeper'
+    zookeeper-short: 'ZooKeeper'
+    asf: 'Apache Software Foundation (ASF)'
+    asf-short: 'ASF'
+    tinkerpop-reg: 'Apache TinkerPop(TM)'
+    tinkerpop: 'Apache TinkerPop'
+    tinkerpop-short: 'TinkerPop'
+    cloudstack-reg: 'Apache CloudStack(R)'
+    cloudstack: 'Apache CloudStack'
+    cloudstack-short: 'CloudStack'
+    tomcat-reg: 'Apache Tomcat(R)'
+    tomcat: 'Apache Tomcat'
+    tomcat-short: 'Tomcat'
+    ajp: 'Apache JServ Protocol (AJP)'
+    ajp-short: 'AJP'
+    activemq-reg: 'Apache ActiveMQ(R)'
+    activemq: 'Apache ActiveMQ'
+    activemq-short: 'ActiveMQ'
+    tomee-reg: 'Apache TomEE(TM)'
+    tomee: 'Apache TomEE'
+    tomee-short: 'TomEE'
+    bookkeeper-reg: 'Apache BookKeeper(TM)'
+    bookkeeper: 'Apache BookKeeper'
+    bookkeeper-short: 'BookKeeper'
+    groovy-reg: 'Apache Groovy(TM)'
+    groovy: 'Apache Groovy'
+    groovy-short: 'Groovy'
+    cpp-driver-url: 'https://github.com/datastax/cpp-driver'
+    csharp-driver-url: 'https://github.com/datastax/csharp-driver'
+    gocql-astra-url: 'https://github.com/datastax/gocql-astra'
+    go-driver-url: 'https://github.com/apache/cassandra-gocql-driver'
+    cql-proxy-url: 'https://github.com/datastax/cql-proxy'
+    java-driver-url: 'https://github.com/apache/cassandra-java-driver'
+    nodejs-driver-url: 'https://github.com/datastax/nodejs-driver'
+    python-driver-url: 'https://github.com/datastax/python-driver'
+    scala-driver-url: 'https://github.com/apache/cassandra-spark-connector'
+    cass-driver-cpp-shield: 'image:https://img.shields.io/github/v/tag/datastax/cpp-driver?label=latest[alt="Latest cpp-driver release on GitHub",link="{cpp-driver-url}/tags"]'
+    cass-driver-csharp-shield: 'image:https://img.shields.io/nuget/v/CassandraCSharpDriver?label=latest[alt="Latest CassandraCSharpDriver release on NuGet",link="https://www.nuget.org/packages/CassandraCSharpDriver"]'
+    cass-driver-go-shield: 'image:https://img.shields.io/github/v/tag/apache/cassandra-gocql-driver?label=latest%20gocql[alt="Latest gocql release on GitHub",link="{go-driver-url}/tags"]'
+    cass-driver-java-shield: 'image:https://img.shields.io/github/v/tag/apache/cassandra-java-driver?label=latest[alt="Latest cassandra-java-driver release on GitHub",link="{java-driver-url}/tags"]'
+    cass-driver-nodejs-shield: 'image:https://img.shields.io/github/v/tag/datastax/nodejs-driver?label=latest[alt="Latest nodejs-driver release on GitHub",link="{nodejs-driver-url}/tags"]'
+    cass-driver-python-shield: 'image:https://img.shields.io/github/v/tag/datastax/python-driver?label=latest[alt="Latest python-driver release on GitHub",link="{python-driver-url}/tags"]'
+    cass-driver-scala-shield: 'image:https://img.shields.io/github/v/tag/apache/cassandra-spark-connector?label=latest[alt="Latest cassandra-spark-connector release on GitHub",link="{scala-driver-url}/releases"]'
+    data-api: 'Data API'
+    csharp-client-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$csharp-client'
+    py-client-api-ref-url-2x: 'xref:astra-api-docs:ROOT:attachment$python-client/astrapy'
+    ts-client-api-ref-url-2x: 'xref:astra-api-docs:ROOT:attachment$typescript-client'
+    java-client-api-ref-url-2x: 'xref:astra-api-docs:ROOT:attachment$java-client'
+    python-client-repo-url: 'https://github.com/datastax/astrapy'
+    typescript-client-repo-url: 'https://github.com/datastax/astra-db-ts'
+    typescript-client-examples-url: '{typescript-client-repo-url}/blob/v2.x/examples'
+    java-client-repo-url: 'https://github.com/datastax/astra-db-java'
+    csharp-client-repo-url: 'https://github.com/datastax/astra-db-csharp'
+    python-client-python-version: '3.8'
+    dataapi-java-client-shield: 'image:https://img.shields.io/maven-central/v/com.datastax.astra/astra-db-java.svg?label=latest[alt="Latest astra-db-java release on Maven Central",link="https://search.maven.org/artifact/com.datastax.astra/astra-db-java"]'
+    dataapi-python-client-shield: 'image:https://img.shields.io/github/v/tag/datastax/astrapy?label=latest[alt="Latest astrapy release on GitHub",link="{python-client-repo-url}/releases"]'
+    dataapi-typescript-client-shield: 'image:https://img.shields.io/github/v/tag/datastax/astra-db-ts?label=latest[alt="Latest astra-db-ts release on GitHub",link="{typescript-client-repo-url}/releases"]'
+    dataapi-csharp-client-shield: 'image:https://img.shields.io/github/v/tag/datastax/astra-db-csharp?label=latest[alt="Latest astra-db-csharp release on GitHub",link="{csharp-client-repo-url}/releases"]'
+    agent: 'DataStax Agent'
+    repair-service: 'Repair Service'
+    backup-service: 'Backup Service'
+    performance-service: 'Performance Service'
+    monitoring-service: 'OpsCenter Monitoring'
+    nodesync-service: 'NodeSync Service'
+    bestpractice-service: 'Best Practice Service'
+    capacity-service: 'Capacity Service'
+    lcm: 'Lifecycle Manager (LCM)'
+    lcm-short: 'LCM'
+    cr: 'custom resource (CR)'
+    cr-short: 'CR'
+    crd: 'custom resource definition (CRD)'
+    crd-short: 'CRD'
+    # Custom attributes only used in ragstack-ai
     astra_db: 'Astra DB'
-    astra_stream: 'Astra Streaming'
     astra_ui: 'Astra Portal'
-    astra_cli: 'Astra CLI'
-    astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master'
-    luna-streaming-examples-repo: 'https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main'
-    support_url: 'https://www.ibm.com/mysupport/s/'
-    glossary-url: 'https://docs.datastax.com/en/glossary/docs/index.html#'
-    emoji-tada: "🎉"
-    emoji-rocket: "🚀"
-    emoji-smile: "&#128512"
-    dse: 'DataStax Enterprise (DSE)'
-    cassandra: 'Apache Cassandra(R)'
-    classic: 'classic'
-    classic_cap: 'Classic'
-    serverless: 'serverless'
-    serverless_cap: 'Serverless'
     # Antora Atlas
     primary-site-url: https://docs.datastax.com/en
     primary-site-manifest-url: https://docs.datastax.com/en/site-manifest.json

modules/ROOT/pages/faqs.adoc

@@ -13,7 +13,7 @@ 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
-* {cass-short}, Elastic, Kinesis, Kafka, and JDBC connectors
+* {cass-short}, Elastic, Kinesis, {kafka-reg}, and JDBC connectors
 * A management dashboard
 * A monitoring and alerting system
 
@@ -38,11 +38,11 @@ They include Minikube, K8d, Kind, Google Kubernetes Engine (GKE), Microsoft Azur
 
 There are several public repos, each with a different purpose. See:
 
-* https://github.com/datastax/pulsar[https://github.com/datastax/pulsar] : This is the distro repo (a fork of apache/pulsar).
-* 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 {cass-short}) repo.
+* {pulsar-repo}[{pulsar-repo}] : This is the distro repo (a fork of apache/pulsar).
+* {pulsar-admin-console-repo}[{pulsar-admin-console-repo}] : This is the repo for the {pulsar-short} admin console, which allows for the configuration and monitoring of {pulsar-short}.
+* {pulsar-heartbeat-repo}[{pulsar-heartbeat-repo}] : This is a monitoring/observability tool for {pulsar-short} that tracks the health of the cluster and can generate alerts in Slack and OpsGenie.
+* {pulsar-helm-chart-repo}[{pulsar-helm-chart-repo}] : This is the Helm chart for deploying the {company} {pulsar-short} Distro in an existing Kubernetes cluster.
+* {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?
@@ -51,9 +51,9 @@ The {company} {product} distribution is designed for Java 11. However, because t
 
 == What are the install options for {company} {product}?
 
-* 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.
-* 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.
-* 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.
+* 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.
+* Use the tarball provided at {pulsar-repo}/releases[{pulsar-repo}/releases] to install {company} {product} on a server or VM.
+* 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.
 
 == How do I install {company} {product} in my Kubernetes cluster?
 
@@ -76,11 +76,11 @@ From the Admin Console, you can:
 
 == What is {pulsar-short} Heartbeat?
 
-https://github.com/datastax/pulsar-heartbeat[{pulsar-short} Heartbeat] monitors the availability, tracks the performance, and reports failures of the {pulsar-short} cluster. It produces synthetic workloads to measure end-to-end message pubsub latency.  {pulsar-short} Heartbeat is a cloud-native application that can be installed by Helm within the {pulsar-short} Kubernetes cluster.
+{pulsar-heartbeat-repo}[{pulsar-short} Heartbeat] monitors the availability, tracks the performance, and reports failures of the {pulsar-short} cluster. It produces synthetic workloads to measure end-to-end message pubsub latency.  {pulsar-short} Heartbeat is a cloud-native application that can be installed by Helm within the {pulsar-short} Kubernetes cluster.
 
 == 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[{product} IO Connectors].
+The https://pulsar.apache.org/docs/en/io-overview/[{pulsar-short} IO framework] provides many features that are not possible in {kafka-short}, 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.
 

modules/ROOT/pages/index.adoc

@@ -15,9 +15,9 @@ In addition to the distribution of https://pulsar.apache.org/en/versions/[{pulsa
 
 * A xref:install-upgrade:quickstart-helm-installs.adoc[Helm chart] that deploys and manages {pulsar-short} on your current CNCF-conformant Kubernetes infrastructure
 
-* {cass-short}, Elastic, Kinesis, Kafka, and JDBC xref:connectors:index.adoc[connectors]
+* {cass-short}, Elastic, Kinesis, {kafka-reg}, and JDBC xref:connectors:index.adoc[connectors]
 
-* The xref:components:starlight.adoc[Starlight suite of {pulsar-short} protocol handlers for Kafka, RabbitMQ, and JMS]
+* The xref:components:starlight.adoc[Starlight suite of {pulsar-short} protocol handlers for {kafka-short}, RabbitMQ, and JMS]
 
 * xref:components:admin-console-vm.adoc[{pulsar-short} Admin Console] for simplified administration of your {pulsar-short} environment
 

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

@@ -69,7 +69,7 @@ On the {pulsar-short} Admin Console's *Code Samples* page, there are examples fo
 
 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-short} by modifying your Maven's `pom.xml` file.
+For example, selecting Java will show you how to connect your Java project to {pulsar-short} by modifying your project's `pom.xml` file.
 
 [#connect-to-pulsar]
 == Connecting to {pulsar-short}
@@ -145,4 +145,4 @@ Alternatively, you can save the URL authentication parameters in your `client.co
 
 == Next steps
 
-For more on building and running a standalone {pulsar-short} Admin console, see the xref:admin-console-vm.adoc[Admin Console on Server/VM] or the https://github.com/datastax/pulsar-admin-console#dev[{pulsar-short} Admin console README].
+For more on building and running a standalone {pulsar-short} Admin console, see the xref:admin-console-vm.adoc[Admin Console on Server/VM] or the {pulsar-admin-console-repo}#dev[{pulsar-short} Admin console README].