Skip to content

Commit 6259a3c

Browse files
aimurphyaimurphy
authored
DOC-5692 Deprecated/archived repos (#197)
* pulsar helm chart, burnell deprecated * remove dependency on luna-streaming-examples * keep links to pulsar-helm-chart repo * helm chart name * double heading * ragstack-ai attributes
1 parent 6938b75 commit 6259a3c

16 files changed

Lines changed: 233 additions & 54 deletions

‎antora.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ asciidoc:
3535
pulsar-heartbeat-repo: 'https://github.com/datastax/pulsar-heartbeat'
3636
pulsar-sink-repo: 'https://github.com/datastax/pulsar-sink'
3737
pulsar-ansible-repo: 'https://github.com/datastax/pulsar-ansible'
38-
pulsar-helm-chart-repo: 'https://github.com/datastax/pulsar-helm-chart'
38+
pulsar-helm-chart-repo: 'https://github.com/datastax/pulsar-helm-chart' # deprecated, use kaap-operator-repo, kaap, and kaap-short instead
3939
pulsar-openid-connect-repo: 'https://github.com/datastax/pulsar-openid-connect-plugin'
4040
pulsar-repo: 'https://github.com/datastax/pulsar'
4141
pulsar-beam-repo: 'https://github.com/kafkaesque-io/pulsar-beam'

‎local-preview-playbook.yml‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -221,9 +221,6 @@ asciidoc:
221221
cr-short: 'CR'
222222
crd: 'custom resource definition (CRD)'
223223
crd-short: 'CRD'
224-
# Custom attributes only used in ragstack-ai
225-
astra_db: 'Astra DB'
226-
astra_ui: 'Astra Portal'
227224
# Antora Atlas
228225
primary-site-url: https://docs.datastax.com/en
229226
primary-site-manifest-url: https://docs.datastax.com/en/site-manifest.json

‎modules/ROOT/pages/faqs.adoc‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,13 @@ They include Minikube, K8d, Kind, Google Kubernetes Engine (GKE), Microsoft Azur
4343

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

46-
* {pulsar-repo}[{pulsar-repo}] : This is the distro repo (a fork of apache/pulsar).
47-
* {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}.
46+
* {pulsar-repo}[{pulsar-repo}]: This is the distro repo (a fork of `apache/pulsar`).
47+
* {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}.
4848
* {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.
49-
* {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.
50-
* {pulsar-sink-repo}[{pulsar-sink-repo}] : This is the {company} {pulsar} Connector (`pulsar-sink`) repo.
51-
* 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.
49+
* {kaap-operator-repo}[{kaap-operator-repo}]: Use the {kaap-short} to deploy the {company} {pulsar-short} Distro in an existing Kubernetes cluster.
50+
+
51+
{company} recommends the {kaap-short} as a replacement for the deprecated {pulsar-helm-chart-repo}[{company} {pulsar-short} Helm chart].
52+
* {pulsar-sink-repo}[{pulsar-sink-repo}]: This is the {company} {pulsar} Connector (`pulsar-sink`) repo.
5253

5354
== Is there a prerequisite version of Java needed for the {product} installation?
5455

@@ -57,17 +58,17 @@ The {product} distribution is designed for Java 17. However, because the product
5758
== What are the install options for {product}?
5859

5960
* **{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.
60-
* **{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.
61+
* **{company} {pulsar-short} Helm chart (Deprecated)**: The Helm chart provided at {pulsar-helm-chart-repo}[{pulsar-helm-chart-repo}] is deprecated and no longer maintained. Use the {kaap-short} instead.
6162
* **Tarball**: Use the tarball provided at {pulsar-repo}/releases[{pulsar-repo}/releases] to install {product} on a server or VM.
6263
* **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.
6364

6465
== How do I install {product} in my Kubernetes cluster?
6566

66-
Follow the full instructions in xref:install-upgrade:quickstart-helm-installs.adoc[Quick Start for Helm Chart installs].
67+
Follow the full instructions in xref:install-upgrade:quickstart-helm-installs.adoc[].
6768

6869
== How do I install {product} on my server or VM?
6970

70-
Follow the full instructions in xref:install-upgrade:quickstart-server-installs.adoc[Quick Start for Server/VM installs].
71+
Follow the full instructions in xref:install-upgrade:quickstart-server-installs.adoc[].
7172

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

‎modules/components/attachments/beam/values.yaml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
extra:
2+
broker: false
3+
brokerSts: true
4+
pulsarBeam: true
5+
proxy: true
6+
wsproxy: false
7+
bastion: false
8+
9+
zookeeper:
10+
replicaCount: 1
11+
12+
bookkeeper:
13+
replicaCount: 1
14+
15+
broker:
16+
component: "broker" # this has to match brokerSts naming
17+
replicaCount: 0
18+
19+
brokerSts:
20+
component: "broker" # this has to match broker naming
21+
replicaCount: 1
22+
functionsWorkerEnabled: true # to overcome the need for functions working
23+
ledger: # the default assumes 2 bookies but this chart only deploys 1
24+
defaultEnsembleSize: 1
25+
defaultAckQuorum: 1
26+
defaultWriteQuorum: 1
27+
28+
# this is a legacy value that the beam sub-chart uses
29+
tokenServer:
30+
allowedRoles: superuser,admin,websocket,proxy
31+
32+
proxy:
33+
component: "proxy"
34+
replicaCount: 1
35+
service:
36+
ports:
37+
- name: "pulsarbeam"
38+
port: 8085
39+
protocol: TCP
40+
- name: "http"
41+
port: 8080
42+
protocol: TCP
43+
- name: "pulsar"
44+
port: 6650
45+
protocol: TCP
46+
47+
pulsarBeam:
48+
component: "pulsarbeam"
49+
replicaCount: 1
50+
51+
image:
52+
proxy:
53+
repository: datastax/lunastreaming
54+
pullPolicy: IfNotPresent
55+
tag: 2.10_2.4
56+
brokerSts:
57+
repository: datastax/lunastreaming
58+
pullPolicy: IfNotPresent
59+
tag: 2.10_2.4
60+
zookeeper:
61+
repository: datastax/lunastreaming
62+
pullPolicy: IfNotPresent
63+
tag: 2.10_2.4
64+
bookkeeper:
65+
repository: datastax/lunastreaming
66+
pullPolicy: IfNotPresent
67+
tag: 2.10_2.4
68+
pulsarBeam:
69+
repository: kesque/pulsar-beam
70+
pullPolicy: IfNotPresent
71+
tag: "1.0.0"

‎modules/components/attachments/client.conf‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Configuration for pulsar-client and pulsar-admin CLI tools
2+
3+
# URL for Pulsar REST API (for admin operations)
4+
# For TLS:
5+
# webServiceUrl=https://localhost:8443/
6+
webServiceUrl=http://127.0.0.1:8080/
7+
8+
# URL for Pulsar Binary Protocol (for produce and consume operations)
9+
# For TLS:
10+
# brokerServiceUrl=pulsar+ssl://localhost:6651/
11+
brokerServiceUrl=pulsar://127.0.0.1:6650/
12+
13+
# Authentication plugin to authenticate with servers
14+
# e.g. for TLS
15+
# authPlugin=org.apache.pulsar.client.impl.auth.AuthenticationTls
16+
authPlugin=
17+
18+
# Parameters passed to authentication plugin.
19+
# A comma separated list of key:value pairs.
20+
# Keys depend on the configured authPlugin.
21+
# e.g. for TLS
22+
# authParams=tlsCertFile:/path/to/client-cert.pem,tlsKeyFile:/path/to/client-key.pem
23+
authParams=
24+
25+
# Allow TLS connections to servers whose certificate cannot be
26+
# be verified to have been signed by a trusted certificate
27+
# authority.
28+
tlsAllowInsecureConnection=false
29+
30+
# Whether server hostname must match the common name of the certificate
31+
# the server is using.
32+
tlsEnableHostnameVerification=false
33+
34+
# Path for the trusted TLS certificate file.
35+
# This cert is used to verify that any cert presented by a server
36+
# is signed by a certificate authority. If this verification
37+
# fails, then the cert is untrusted and the connection is dropped.
38+
tlsTrustCertsFilePath=
39+
40+
# Enable TLS with KeyStore type configuration in broker.
41+
useKeyStoreTls=false
42+
43+
# TLS KeyStore type configuration: JKS, PKCS12
44+
tlsTrustStoreType=JKS
45+
46+
# TLS TrustStore path
47+
tlsTrustStorePath=
48+
49+
# TLS TrustStore password
50+
tlsTrustStorePassword=

‎modules/components/attachments/sql/values.yaml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
extra:
2+
broker: false
3+
brokerSts: true
4+
pulsarSQL: true
5+
proxy: false
6+
wsproxy: false
7+
bastion: false
8+
9+
pulsarSQL:
10+
server:
11+
workers: 1
12+
service:
13+
type: ClusterIP
14+
15+
zookeeper:
16+
replicaCount: 1
17+
18+
bookkeeper:
19+
replicaCount: 1
20+
21+
broker:
22+
component: "broker" # this has to match brokerSts naming due to a bug
23+
replicaCount: 0
24+
25+
brokerSts:
26+
component: "broker" # this has to match broker naming due to a bug
27+
replicaCount: 1
28+
functionsWorkerEnabled: true # to overcome the need for functions working
29+
ledger: # the default assumes 2 bookies but this chart only deploys 1
30+
defaultEnsembleSize: 1
31+
defaultAckQuorum: 1
32+
defaultWriteQuorum: 1
33+
34+
image:
35+
brokerSts:
36+
repository: datastax/lunastreaming-all #because we want connectors too
37+
pullPolicy: IfNotPresent
38+
tag: 2.10_2.4
39+
zookeeper:
40+
repository: datastax/lunastreaming
41+
pullPolicy: IfNotPresent
42+
tag: 2.10_2.4
43+
bookkeeper:
44+
repository: datastax/lunastreaming
45+
pullPolicy: IfNotPresent
46+
tag: 2.10_2.4
47+
pulsarSQL:
48+
repository: datastax/lunastreaming
49+
tag: 2.10_2.4
50+
pullPolicy: IfNotPresent

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The *Admin Console for {pulsar-reg}* is a web-based UI from {company} that admin
77

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

10-
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:
10+
If you installed the Admin console with the xref:install-upgrade:quickstart-helm-installs.adoc[{company} {pulsar-short} Helm chart], access the Admin console via the `pulsar-adminconsole` external load balancer endpoint in your cloud provider:
1111

1212
image::GCP-all-pods.png[GCP Pods]
1313

‎modules/components/pages/heartbeat-vm.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
= Heartbeat on VM/Server
22

3-
This document describes how to install {pulsar-short} Heartbeat on a virtual machine (VM) or server. For installation with the Docker image, see xref:install-upgrade:quickstart-helm-installs.adoc[Helm Chart Installation].
3+
This document describes how to install {pulsar-short} Heartbeat on a virtual machine (VM) or server. For installation with the Docker image, see xref:install-upgrade:quickstart-helm-installs.adoc[].
44

55
== Install Heartbeat Binary
66

‎modules/components/pages/pulsar-beam.adoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= {pulsar-beam} with {product}
22
:navtitle: {pulsar-beam}
3-
:description: Install a minimal {product} Helm chart that includes {pulsar-beam}
4-
:helmValuesPath: https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/beam/values.yaml
3+
:description: Install a minimal {company} {pulsar-short} Helm chart that includes {pulsar-beam}
4+
:helmValuesPath: beam
55

66
The {pulsar-beam-repo}[{pulsar-beam}] project is an HTTP-based streaming and queueing system for use with {pulsar}.
77

@@ -12,15 +12,15 @@ With {pulsar-beam}, you can send messages over HTTP, push messages to a webhook
1212
include::ROOT:partial$luna-name.adoc[]
1313
====
1414

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

1717
== Prerequisites
1818

1919
* https://helm.sh/docs/intro/install/[Helm 3 CLI] (this example uses version 3.8.0)
2020
* Enough access to a K8s cluster to create a namespace, deployments, and pods
2121
* https://kubernetes.io/docs/tasks/tools/[Kubectl CLI] (this example uses version 1.23.4)
2222

23-
== Install {product} Helm chart
23+
== Install the {company} {pulsar-short} Helm chart
2424

2525
include::partial$install-helm.adoc[]
2626

‎modules/components/pages/pulsar-sql.adoc‎

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Using {pulsar-short} SQL with {product}
22
:navtitle: {pulsar-short} SQL
3-
:description: This guide installs the {product} Helm chart using minimum values for a working {pulsar-short} cluster that includes SQL workers
4-
:helmValuesPath: https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/pulsar-sql/values.yaml
3+
:description: This guide installs the {company} {pulsar-short} Helm chart using minimum values for a working {pulsar-short} cluster that includes SQL workers
4+
:helmValuesPath: sql
55

66
{pulsar-short} SQL allows enterprises to query {pulsar} topic data with SQL.
77
This is a powerful feature for an Enterprise, and SQL is a language they're likely familiar with.
@@ -14,7 +14,7 @@ Additionally, {pulsar-short} has built-in options to create Trino workers and au
1414
include::ROOT:partial$luna-name.adoc[]
1515
====
1616
17-
In this guide, we will use the {product} Helm Chart to install a {pulsar-short} cluster with {pulsar-short} SQL.
17+
In this guide, we will use the {company} {pulsar-short} Helm Chart to install a {pulsar-short} cluster with {pulsar-short} SQL.
1818
The Trino coordinator and desired number of workers will be created directly in the cluster.
1919
2020
== Prerequisites
@@ -31,7 +31,7 @@ PrestoDB has been replaced by Trino, and {pulsar} is using Trino's version.
3131
The Trino CLI uses the "X-TRINO-USER" header for authentications.
3232
====
3333
34-
== Install {product} Helm chart
34+
== Install the {company} {pulsar-short} Helm chart
3535
3636
include::partial$install-helm.adoc[]
3737
@@ -76,20 +76,14 @@ The minimalist Helm chart values use the https://github.com/datastax/release-not
7676
This example uses the "public" tenant and "default" namespace.
7777
These are created by default in {pulsar-short}, but you can use whatever tenant and namespace you are comfortable with.
7878
79-
. Download the minimalist {pulsar-short} client.
80-
This "client.conf" assumes the port forwarding addresses we will perform in the next step.
81-
+
82-
[source,shell]
83-
----
84-
wget https://raw.githubusercontent.com/datastaxdevs/luna-streaming-examples/main/client.conf
85-
----
79+
. xref:components:attachment$client.conf[Download the minimalist {pulsar-short} client].
80+
This `client.conf` assumes the port forwarding addresses we will perform in the next step.
8681
87-
. Set the client environment variable. Replace the value with the absolute path to the "client.conf" you just downloaded.
82+
. Set a client configuration environment variable with the absolute path to the downloaded `client.conf` file:
8883
+
8984
[source,shell]
9085
----
91-
# the client conf path must be an absolute path to the downloaded conf file
92-
export PULSAR_CLIENT_CONF=<REPLACE_WITH /path/to/client.conf>
86+
export PULSAR_CLIENT_CONF=/path/to/client.conf
9387
----
9488
9589
. Navigate to the {pulsar-short} home folder and run the following command.

0 commit comments

Comments
 (0)