Skip to content

Commit 1c1d6fe

Browse files
authored
DOC-4944 DOC-4945 Pulsar attributes, attribute cleanup (#127)
* pulsar, cdc, cpp attribute issues * remove unnecessary attributes * move examples repo attribute * fix attributes * remove unused attrib
1 parent c0744d3 commit 1c1d6fe

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+311
-312
lines changed

antora.yml

+11-15
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,20 @@ nav:
1212

1313
asciidoc:
1414
attributes:
15-
pulsar_version: '2.10' #DO NOT INCLUDE PATCH VERSION <MAJOR>.<MINOR>.<PATCH>
16-
pulsar_full_version: '2.10.1'
1715
product: 'Astra Streaming'
16+
pulsar: 'Apache Pulsar'
17+
pulsar-short: 'Pulsar'
18+
pulsar-reg: 'Apache Pulsar(TM)'
19+
pulsar-version: '2.10' #DO NOT INCLUDE PATCH VERSION <MAJOR>.<MINOR>.<PATCH>
20+
pulsar-version-patch: '2.10.1'
1821
kafka_for_astra: 'Starlight for Kafka'
1922
starlight_rabbitmq: 'Starlight for RabbitMQ'
2023
gpt-schema-translator: 'GPT schema translator'
21-
base_url: 'https://api.astra.datastax.com'
22-
base_api: '/v2/streaming'
23-
bearer_token: '$BEARER_TOKEN'
24-
tenant_name_with_topics: 'llp-test'
25-
cluster_name: 'astradev-aws'
26-
tenant_name: 'testcreate'
27-
topic_name: 'blah'
28-
request_feature_access_email: '[email protected]'
29-
streaming_signup_url: 'https://astra.datastax.com/streaming'
30-
login_url: 'https://astra.datastax.com'
31-
langstream: 'RAGStack'
32-
ragstack: 'RAGStack'
33-
db-serverless: 'Astra DB Serverless'
3424
url-astra: 'https://astra.datastax.com'
3525
link-astra-portal: '{url-astra}[{astra_ui}^]'
26+
astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master'
27+
28+
# LEGACY ATTRIBUTES - CONSIDER REMOVING
29+
langstream: 'RAGStack'
30+
ragstack: 'RAGStack'
31+
streaming_signup_url: 'https://astra.datastax.com/streaming'
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
curl --location --head '{base_url}{base_api}/tenants/test-llp' \
2-
--header "Authorization: Bearer {bearer_token}"
1+
curl --location --head 'https://api.astra.datastax.com/v2/streaming/tenants/test-llp' \
2+
--header "Authorization: Bearer $BEARER_TOKEN"
+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
curl --location --request POST '{base_url}{base_api}/tenants?topic={topic_name}' \
1+
curl --location --request POST 'https://api.astra.datastax.com/v2/streaming/tenants?topic=blah' \
22
--header 'Content-Type: application/json' \
3-
--header "Authorization: Bearer {bearer_token}" \
3+
--header "Authorization: Bearer $BEARER_TOKEN" \
44
--data-raw '{
55
"cloudProvider": "aws",
66
"cloudRegion": "useast2",
7-
"tenantName": "{tenant_name}",
7+
"tenantName": "testcreate",
88
"userEmail": "[email protected]"
99
}'

modules/ROOT/examples/curl_deflate.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
curl -v -H 'Authorization: Bearer {bearer_token}' -H 'Accept-encoding: deflate' https://prometheus-aws-useast1.streaming.datastax.com/pulsarmetrics/tenant-1 --compressed
1+
curl -v -H 'Authorization: Bearer $BEARER_TOKEN' -H 'Accept-encoding: deflate' https://prometheus-aws-useast1.streaming.datastax.com/pulsarmetrics/tenant-1 --compressed

modules/ROOT/examples/curl_gzip.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
curl -v -H 'Authorization: Bearer {bearer_token}' -H 'Accept-encoding: gzip' https://prometheus-aws-useast1.streaming.datastax.com/pulsarmetrics/tenant-1 | zcat
1+
curl -v -H 'Authorization: Bearer $BEARER_TOKEN' -H 'Accept-encoding: gzip' https://prometheus-aws-useast1.streaming.datastax.com/pulsarmetrics/tenant-1 | zcat
+2-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
curl --location --request DELETE '{base_url}{base_api}/tenants/{tenant_name}/clusters/{cluster_name}' \
2-
--header "Authorization: Bearer {bearer_token}"
1+
curl --location --request DELETE 'https://api.astra.datastax.com/v2/streaming/tenants/testcreate/clusters/astradev-aws' \
2+
--header "Authorization: Bearer $BEARER_TOKEN"
+2-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
curl --location --request DELETE '{base_url}{base_api}/tenants/{tenant_name}/clusters/{cluster_name}?opt={cluster_name}' \
2-
--header "Authorization: Bearer {bearer_token}"
1+
curl --location --request DELETE 'https://api.astra.datastax.com/v2/streaming/tenants/testcreate/clusters/astradev-aws?opt=astradev-aws' \
2+
--header "Authorization: Bearer $BEARER_TOKEN"

modules/ROOT/examples/get_clusters.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
curl --location --request GET '{base_url}{base_api}/clusters' \
2-
--header "Authorization: Bearer {bearer_token}"
1+
curl --location --request GET 'https://api.astra.datastax.com/v2/streaming/clusters' \
2+
--header "Authorization: Bearer $BEARER_TOKEN"
+2-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
curl --location --request GET '{base_url}{base_api}/providers' \
2-
--header "Authorization: Bearer {bearer_token}"
1+
curl --location --request GET 'https://api.astra.datastax.com/v2/streaming/providers' \
2+
--header "Authorization: Bearer $BEARER_TOKEN"
+3-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
curl --location --request GET '{base_url}{base_api}/tenants/{tenant_name_with_topics}/limits' \
2-
--header 'X-DataStax-Pulsar-Cluster: {cluster_name}' \
3-
--header "Authorization: Bearer {bearer_token}"
1+
curl --location --request GET 'https://api.astra.datastax.com/v2/streaming/tenants/llp-test/limits' \
2+
--header 'X-DataStax-Pulsar-Cluster: astradev-aws' \
3+
--header "Authorization: Bearer $BEARER_TOKEN"

modules/ROOT/examples/get_tenants.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
curl --location --request GET '{base_url}{base_api}/tenants' \
2-
--header "Authorization: Bearer {bearer_token}"
1+
curl --location --request GET 'https://api.astra.datastax.com/v2/streaming/tenants' \
2+
--header "Authorization: Bearer $BEARER_TOKEN"

modules/ROOT/examples/test.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ for FILE in *;
1717
do
1818
if [[ "$FILE" != "test"* ]]
1919
then
20-
gsed "s#{base_url}#$base_url#; s#{base_api}#$base_api#; s#{tenant_name}#$tenant_name#; s#{tenant_name_with_topics}#$tenant_name_with_topics#; s#{topic_name}#$topic_name#; s#{cluster_name}#$cluster_name#; s#{bearer_token}#$BEARER_TOKEN#;" $FILE > $FILE.tmp;
20+
gsed "s#https://api.astra.datastax.com#$base_url#; s#/v2/streaming#$base_api#; s#testcreate#$tenant_name#; s#llp-test#$tenant_name_with_topics#; s#blah#$topic_name#; s#astradev-aws#$cluster_name#; s#$BEARER_TOKEN#$BEARER_TOKEN#;" $FILE > $FILE.tmp;
2121
chmod 755 $FILE.tmp;
2222
fi
2323
done

modules/ROOT/pages/astream-faq.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ See xref:getting-started:index.adoc[].
1010

1111
See xref:operations:astream-pricing.adoc[].
1212

13-
== Why is {product} based on Apache Pulsar?
13+
== Why is {product} based on {pulsar-reg}?
1414

15-
For information about the decision to use Apache Pulsar, see https://www.datastax.com/blog/four-reasons-why-apache-pulsar-essential-modern-data-stack[Four Reasons Why Apache Pulsar is Essential to the Modern Data Stack].
15+
For information about the decision to use {pulsar}, see https://www.datastax.com/blog/four-reasons-why-apache-pulsar-essential-modern-data-stack[Four Reasons Why {pulsar} is Essential to the Modern Data Stack].
1616

1717
== What happened to Kesque?
1818

@@ -26,11 +26,11 @@ With the launch of {product}, {company} began shutting down the Kesque service a
2626

2727
The pricing model also makes {product} accessible to mid market and small/medium business customers who need event stream processing capabilities to run core parts of their business.
2828

29-
And finally {product} offers a user-friendly interface and free tier to satisfy the needs of individual developers and technologists who want to learn more about Apache Pulsar and data streaming in general.
29+
And finally {product} offers a user-friendly interface and free tier to satisfy the needs of individual developers and technologists who want to learn more about {pulsar} and data streaming in general.
3030

3131
== What is CDC for {astra_db}?
3232

33-
Change Data Capture (CDC) for {astra_db} uses a Pulsar IO source connector that processes changes from the Cassandra Change Agent through a Pulsar topic.
33+
Change Data Capture (CDC) for {astra_db} uses a {pulsar-short} IO source connector that processes changes from the Cassandra Change Agent through a {pulsar-short} topic.
3434
For more information, see xref:developing:astream-cdc.adoc[].
3535

3636
== What are tenants, namespaces, topics, and sinks?

modules/ROOT/pages/astream-org-permissions.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -36,22 +36,22 @@ Additional permissions might be required, depending on the tasks the role needs
3636
To control access to specific streaming tenants, you can set granular xref:astra-db-serverless:administration:manage-database-access.adoc#role-scopes[resource scopes] on custom roles.
3737
====
3838

39-
== Authentication and authorization in Pulsar and {astra_db}
39+
== Authentication and authorization in {pulsar-reg} and {astra_db}
4040

41-
Pulsar has the concept of https://pulsar.apache.org/docs/security-authorization/[clients with role tokens].
42-
In Pulsar, authentication is the process of verifying a provided token (JWT), and authorization is the process of determining if the role claimed in that token is allowed to complete the requested action.
41+
{pulsar-short} has the concept of https://pulsar.apache.org/docs/security-authorization/[clients with role tokens].
42+
In {pulsar-short}, authentication is the process of verifying a provided token (JWT), and authorization is the process of determining if the role claimed in that token is allowed to complete the requested action.
4343

44-
{product} uses the {company} version of Apache Pulsar (xref:luna-streaming::index.adoc[Luna Streaming]).
45-
The https://github.com/datastax/pulsar[Luna project] is an open fork of the Pulsar project that maintains feature parity with OSS Pulsar. {product}, as a managed service, abstracts some features/options of Pulsar to ensure continuous, reliable service.
44+
{product} uses the {company} version of {pulsar} (xref:luna-streaming::index.adoc[Luna Streaming]).
45+
The https://github.com/datastax/pulsar[Luna project] is an open fork of the {pulsar-short} project that maintains feature parity with OSS {pulsar-short}. {product}, as a managed service, abstracts some features/options of {pulsar-short} to ensure continuous, reliable service.
4646

47-
On a shared cluster, your {astra_db} organization has one or more tenants on a shared Pulsar cluster.
48-
Each of your tenants is secured by Pulsar authentication and authorization models, as well as your {astra_db} organization's authentication and authorization ({astra_db} RBAC).
47+
On a shared cluster, your {astra_db} organization has one or more tenants on a shared {pulsar-short} cluster.
48+
Each of your tenants is secured by {pulsar-short} authentication and authorization models, as well as your {astra_db} organization's authentication and authorization ({astra_db} RBAC).
4949

5050
{product} shared clusters are created and administered by {product} administrators.
5151
Each tenant is assigned a custom role and permissions limited to that tenant only.
5252
All tokens created within a tenant are assigned roles similar to the assigning tenant.
5353

54-
For programmatic access, you use {astra_db} application tokens or Pulsar JWT, depending on the operation you need to perform.
54+
For programmatic access, you use {astra_db} application tokens or {pulsar-short} JWT, depending on the operation you need to perform.
5555
For more information, see xref:operations:astream-token-gen.adoc[].
5656

5757
== See also

modules/ROOT/pages/astream-subscriptions-exclusive.adoc

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
= Exclusive subscriptions in Pulsar
1+
= Exclusive subscriptions in {pulsar-reg}
22
:navtitle: Exclusive
33
:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
44

5-
_Subscriptions_ in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data.
5+
_Subscriptions_ in {pulsar-reg} describe which consumers are consuming data from a topic and how they want to consume that data.
66

77
An _exclusive subscription_ describes a basic publish-subscribe (pub-sub) pattern where a single consumer subscribes to a single topic and consumes from it.
88

9-
This page explains how to use Pulsar's exclusive subscription model to manage your topic consumption.
9+
This page explains how to use {pulsar-short}'s exclusive subscription model to manage your topic consumption.
1010
1111
include::ROOT:partial$subscription-prereq.adoc[]
1212
1313
[#example]
1414
== Exclusive subscription example
1515
16-
. To configure a Pulsar exclusive subscription, define a `pulsarConsumer` object in `SimplePulsarConsumer.java`, as you would for other subscription types.
16+
. To configure a {pulsar-short} exclusive subscription, define a `pulsarConsumer` object in `SimplePulsarConsumer.java`, as you would for other subscription types.
1717
However, you don't need to declare a `subscriptionType`.
18-
Whereas other subscription types required you to declare a specific `subscriptionType`, Pulsar creates an exclusive subscription by default if you don't declare a `subscriptionType`.
18+
Whereas other subscription types required you to declare a specific `subscriptionType`, {pulsar-short} creates an exclusive subscription by default if you don't declare a `subscriptionType`.
1919
+
2020
.SimplePulsarConsumer.java
2121
[source,java]
@@ -82,7 +82,7 @@ Caused by: org.apache.pulsar.client.api.PulsarClientException$ConsumerBusyExcept
8282
8383
== See also
8484
85-
* xref:astream-subscriptions.adoc[Subscriptions in Pulsar]
86-
* xref:astream-subscriptions-shared.adoc[Shared subscriptions]
87-
* xref:astream-subscriptions-failover.adoc[Failover subscriptions]
88-
* xref:astream-subscriptions-keyshared.adoc[Key shared subscriptions]
85+
* xref:astream-subscriptions.adoc[]
86+
* xref:astream-subscriptions-shared.adoc[]
87+
* xref:astream-subscriptions-failover.adoc[]
88+
* xref:astream-subscriptions-keyshared.adoc[]

modules/ROOT/pages/astream-subscriptions-failover.adoc

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
= Failover subscriptions in Pulsar
1+
= Failover subscriptions in {pulsar-reg}
22
:navtitle: Failover
33
:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
44

5-
_Subscriptions_ in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data.
5+
_Subscriptions_ in {pulsar-reg} describe which consumers are consuming data from a topic and how they want to consume that data.
66

77
If an xref:astream-subscriptions-exclusive.adoc[exclusive] consumer fails, the topic backlog accumulates stale, unacknowledged messages.
8-
Pulsar solves this problem with failover subscriptions.
9-
In _failover subscriptions_, Pulsar designates one primary consumer and multiple standby consumers.
8+
{pulsar-short} solves this problem with failover subscriptions.
9+
In _failover subscriptions_, {pulsar-short} designates one primary consumer and multiple standby consumers.
1010
If the primary consumer disconnects, the standby consumers begin consuming the subsequent unacknowledged messages.
1111

12-
This page explains how to use Pulsar's failover subscription model to manage your topic consumption.
12+
This page explains how to use {pulsar-short}'s failover subscription model to manage your topic consumption.
1313
1414
include::ROOT:partial$subscription-prereq.adoc[]
1515
1616
[#example]
1717
== Failover subscription example
1818
19-
To try out a Pulsar failover subscription, add `.subscriptionType(SubscriptionType.Failover)` to the `pulsarConsumer` in `SimplePulsarConsumer.java`:
19+
To try out a {pulsar-short} failover subscription, add `.subscriptionType(SubscriptionType.Failover)` to the `pulsarConsumer` in `SimplePulsarConsumer.java`:
2020
2121
.SimplePulsarConsumer.java
2222
[source,java]
@@ -86,7 +86,7 @@ To test them, you can progressively end each `SimplePulsarConsumer` process, and
8686
8787
== See also
8888
89-
* xref:astream-subscriptions.adoc[Subscriptions in Pulsar]
90-
* xref:astream-subscriptions-exclusive.adoc[Exclusive subscriptions]
91-
* xref:astream-subscriptions-shared.adoc[Shared subscriptions]
92-
* xref:astream-subscriptions-keyshared.adoc[Key shared subscriptions]
89+
* xref:astream-subscriptions.adoc[]
90+
* xref:astream-subscriptions-exclusive.adoc[]
91+
* xref:astream-subscriptions-shared.adoc[]
92+
* xref:astream-subscriptions-keyshared.adoc[]

modules/ROOT/pages/astream-subscriptions-keyshared.adoc

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
= Key shared subscriptions in Pulsar
1+
= Key shared subscriptions in {pulsar-reg}
22
:navtitle: Key shared
33
:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
44

5-
_Subscriptions_ in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data.
5+
_Subscriptions_ in {pulsar-reg} describe which consumers are consuming data from a topic and how they want to consume that data.
66

7-
Pulsar's xref:astream-subscriptions-shared.adoc[shared subscription] model can increase the message processing rate, but it risks losing message ordering guarantees.
7+
{pulsar-short}'s xref:astream-subscriptions-shared.adoc[shared subscription] model can increase the message processing rate, but it risks losing message ordering guarantees.
88
In a round-robin delivery, there's no way for the broker to know which messages are going to which consumer.
99
1010
_Key shared subscriptions_ allow multiple consumers to subscribe to a topic, and provide additional metadata in the form of _keys_ that link messages to specific consumers.
@@ -13,14 +13,14 @@ Keys are generated with hashing that converts arbitrary values like `topic-name`
1313
* *Auto hash*: Uses _consistent hashing_ to balance range values across available consumers without requiring manual setup of hash ranges.
1414
* *Sticky hash*: The client manually assigns consumer range values, and then all hashes within a configured range go to one consumer.
1515
16-
This page explains how to use Pulsar's key shared subscription model to manage your topic consumption.
16+
This page explains how to use {pulsar-short}'s key shared subscription model to manage your topic consumption.
1717
1818
include::ROOT:partial$subscription-prereq.adoc[]
1919
2020
[#example]
2121
== Key shared subscription example
2222
23-
. To try out a Pulsar key shared subscription, add `.subscriptionType(SubscriptionType.Key_Shared)` to the `pulsarConsumer` in `SimplePulsarConsumer.java`:
23+
. To try out a {pulsar-short} key shared subscription, add `.subscriptionType(SubscriptionType.Key_Shared)` to the `pulsarConsumer` in `SimplePulsarConsumer.java`:
2424
+
2525
.SimplePulsarConsumer.java
2626
[source,java]
@@ -144,7 +144,7 @@ Then, you can launch multiple instances of `SimplePulsarConsumer.java` to consum
144144
145145
== See also
146146
147-
* xref:astream-subscriptions.adoc[Subscriptions in Pulsar]
148-
* xref:astream-subscriptions-exclusive.adoc[Exclusive subscriptions]
149-
* xref:astream-subscriptions-shared.adoc[Shared subscriptions]
150-
* xref:astream-subscriptions-failover.adoc[Failover subscriptions]
147+
* xref:astream-subscriptions.adoc[]
148+
* xref:astream-subscriptions-exclusive.adoc[]
149+
* xref:astream-subscriptions-shared.adoc[]
150+
* xref:astream-subscriptions-failover.adoc[]

modules/ROOT/pages/astream-subscriptions-shared.adoc

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
= Shared subscriptions in Pulsar
1+
= Shared subscriptions in {pulsar-reg}
22
:navtitle: Shared
33
:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
44

5-
_Subscriptions_ in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data.
5+
_Subscriptions_ in {pulsar-reg} describe which consumers are consuming data from a topic and how they want to consume that data.
66

77
A _shared subscription_ allows multiple consumers to consume messages from a single topic in a round-robin fashion.
8-
More consumers in a shared subscription can increase your Pulsar deployment's rate of message consumption.
8+
More consumers in a shared subscription can increase your {pulsar-short} deployment's rate of message consumption.
99
However, there is a risk of losing message ordering guarantees and acknowledgment schemes.
1010

11-
This page explains how you can use Pulsar's shared subscription model to manage your topic consumption.
11+
This page explains how you can use {pulsar-short}'s shared subscription model to manage your topic consumption.
1212
1313
include::ROOT:partial$subscription-prereq.adoc[]
1414
1515
[#example]
1616
== Shared subscription example
1717
18-
To try out a Pulsar shared subscription, add `.subscriptionType(SubscriptionType.Shared)` to the `pulsarConsumer` in `SimplePulsarConsumer.java`:
18+
To try out a {pulsar-short} shared subscription, add `.subscriptionType(SubscriptionType.Shared)` to the `pulsarConsumer` in `SimplePulsarConsumer.java`:
1919
2020
.SimplePulsarConsumer.java
2121
[source,java]
@@ -85,7 +85,7 @@ All the consumers subscribe to the topic and consume messages in a round-robin f
8585
8686
== See also
8787
88-
* xref:astream-subscriptions.adoc[Subscriptions in Pulsar]
89-
* xref:astream-subscriptions-exclusive.adoc[Exclusive subscriptions]
90-
* xref:astream-subscriptions-failover.adoc[Failover subscriptions]
91-
* xref:astream-subscriptions-keyshared.adoc[Key shared subscriptions]
88+
* xref:astream-subscriptions.adoc[]
89+
* xref:astream-subscriptions-exclusive.adoc[]
90+
* xref:astream-subscriptions-failover.adoc[]
91+
* xref:astream-subscriptions-keyshared.adoc[]

0 commit comments

Comments
 (0)