Skip to content

Commit 9ebc1c7

Browse files
Remove page aliases; fix page headers
1 parent 36fd8f3 commit 9ebc1c7

34 files changed

+83
-143
lines changed

modules/ROOT/pages/astream-custom-roles.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
= Manage custom roles
2-
:slug: manage-custom-user-roles
3-
:page-aliases: docs@astra-streaming::astream-custom-roles.adoc
42
:page-tag: astra-streaming,security,secure,pulsar
53

64
Within *Settings* > *Users*, you can see the permissions for a specific role by hovering over the number in the *Roles* column of the table. This will show the permissions granted to the role.
@@ -21,7 +19,7 @@ You can also create custom roles using the DevOps API.
2119
. From *Settings* page, select *Roles*.
2220
. Select *Add Custom Role*.
2321
. Enter the name you want to use for your custom role. This name should help you easily identify when you want to assign this role to users.
24-
. Select the Organization, Keyspace, Table, and API permissions you want to assign to your custom role.
22+
. Select the Organization, Keyspace, Table, and API permissions you want to assign to your custom role.
2523
+
2624
[NOTE]
2725
====

modules/ROOT/pages/astream-faq.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= {product_name} FAQs
2-
:page-aliases: docs@astra-streaming::astream-faq.adoc
32
:page-tag: astra-streaming,dev,admin,planner,plan,pulsar
43

54
== How do I sign up for the {product_name}?

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
= User permissions
2-
:slug: user-permissions
3-
:page-aliases: docs@astra-streaming::astream-org-permissions.adoc
42
:page-tag: astra-streaming,security,secure,pulsar
53

64
Default and xref:astream-custom-roles.adoc[custom roles] allow admins to manage unique permissions for users based on your organization and database requirements.

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= Exclusive subscriptions in Pulsar
2-
:page-aliases: docs@astra-streaming::astream-subscriptions-exclusive.adoc
32
:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
43

54
*Subscriptions* in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +
@@ -18,9 +17,9 @@ This example uses the `pulsarConsumer` object in `SimplePulsarConsumer.java` bel
1817
[source,java]
1918
----
2019
pulsarConsumer = pulsarClient.newConsumer(Schema.JSON(DemoBean.class))
21-
.topic("persistent://"
22-
+ conf.getTenantName() + "/"
23-
+ conf.getNamespace() + "/"
20+
.topic("persistent://"
21+
+ conf.getTenantName() + "/"
22+
+ conf.getNamespace() + "/"
2423
+ conf.getTopicName())
2524
.startMessageIdInclusive()
2625
.subscriptionInitialPosition(SubscriptionInitialPosition.Earliest)
@@ -32,7 +31,7 @@ pulsarConsumer = pulsarClient.newConsumer(Schema.JSON(DemoBean.class))
3231
====
3332
Pulsar creates an exclusive subscription by default when no `subscriptionType` is declared.
3433
====
35-
34+
3635
. Open the `pulsar-subscription-example` repo in the IDE of your choice and run `SimplePulsarConsumer.java` to begin consuming messages. +
3736
The confirmation message and a cursor appear to indicate the consumer is ready.
3837
+
@@ -43,7 +42,7 @@ The confirmation message and a cursor appear to indicate the consumer is ready.
4342
[pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.ConsumerImpl - [persistent://<tenant_name>/<namespace>/in][SimplePulsarConsumer] Subscribed to topic on <service_url> -- consumer: 0
4443
----
4544

46-
. In a new terminal window, run `SimplePulsarProducer.java` to begin producing messages.
45+
. In a new terminal window, run `SimplePulsarProducer.java` to begin producing messages.
4746
+
4847
[source,bash]
4948
----
@@ -52,7 +51,7 @@ The confirmation message and a cursor appear to indicate the consumer is ready.
5251
[main] INFO com.datastax.pulsar.SimplePulsarProducer - Message 68306175 sent
5352
----
5453

55-
. The consumer begins consuming the produced messages.
54+
. The consumer begins consuming the produced messages.
5655
+
5756
[source,bash]
5857
----
@@ -61,7 +60,7 @@ The confirmation message and a cursor appear to indicate the consumer is ready.
6160
[main] INFO com.datastax.pulsar.SimplePulsarConsumer - Message received: {"show_id":68306175,"cast":"LeBron James, Anthony Davis, Kyrie Irving, Damian Lillard, Klay Thompson...","country":"United States","date_added":"July 16, 2021","description":"NBA superstar LeBron James teams up with Bugs Bunny and the rest of the Looney Tunes for this long-awaited sequel.","director":"Malcolm D. Lee","duration":"120 min","listed_in":"Animation, Adventure, Comedy","rating":"PG","release_year":2021,"title":"Space Jam: A New Legacy","type":"Movie"}
6261
----
6362

64-
. Open a new terminal window and try to run `SimplePulsarConsumer.java`.
63+
. Open a new terminal window and try to run `SimplePulsarConsumer.java`.
6564
+
6665
[source,bash]
6766
----

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= Failover subscriptions in Pulsar
2-
:page-aliases: docs@astra-streaming::astream-subscriptions-failover.adoc
32
:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
43

54
*Subscriptions* in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +
@@ -14,14 +13,14 @@ include::partial$subscription-prereq.adoc[]
1413
[#example]
1514
== Failover subscription example
1615

17-
To try out a Pulsar failover subscription, add `.subscriptionType(SubscriptionType.Failover)` to the `pulsarConsumer` in `SimplePulsarConsumer.java`.
16+
To try out a Pulsar failover subscription, add `.subscriptionType(SubscriptionType.Failover)` to the `pulsarConsumer` in `SimplePulsarConsumer.java`.
1817

1918
[source,java]
2019
----
2120
pulsarConsumer = pulsarClient.newConsumer(Schema.JSON(DemoBean.class))
22-
.topic("persistent://"
23-
+ conf.getTenantName() + "/"
24-
+ conf.getNamespace() + "/"
21+
.topic("persistent://"
22+
+ conf.getTenantName() + "/"
23+
+ conf.getNamespace() + "/"
2524
+ conf.getTopicName())
2625
.startMessageIdInclusive()
2726
.subscriptionInitialPosition(SubscriptionInitialPosition.Earliest)
@@ -41,7 +40,7 @@ The confirmation message and a cursor appear to indicate the consumer is ready.
4140
[pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.ConsumerImpl - [persistent://<tenant_name>/<namespace>/in][SimplePulsarConsumer] Subscribed to topic on <service_url> -- consumer: 0
4241
----
4342

44-
. In a new terminal window, run `SimplePulsarProducer.java` to begin producing messages.
43+
. In a new terminal window, run `SimplePulsarProducer.java` to begin producing messages.
4544
+
4645
[source,bash]
4746
----
@@ -53,7 +52,7 @@ The confirmation message and a cursor appear to indicate the consumer is ready.
5352
[main] INFO com.datastax.pulsar.SimplePulsarProducer - Message 42372149 sent
5453
----
5554

56-
. The primary consumer begins consuming messages.
55+
. The primary consumer begins consuming messages.
5756
+
5857
[source,bash]
5958
----
@@ -76,7 +75,7 @@ The confirmation message and a cursor appear to indicate the consumer is ready.
7675

7776
=== Failover subscription video
7877

79-
Follow along with this video from our *Five Minutes About Pulsar* series to see failover subscriptions in action.
78+
Follow along with this video from our *Five Minutes About Pulsar* series to see failover subscriptions in action.
8079

8180
video::ckB87OLs5eM[youtube, list=PL2g2h-wyI4SqeKH16czlcQ5x4Q_z-X7_m, height=445px,width=100%]
8281

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

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
= Key_Shared subscriptions in Pulsar
2-
:page-aliases: docs@astra-streaming::astream-subscriptions-keyshared.adoc
32
:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
43

54
*Subscriptions* in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +
@@ -9,7 +8,7 @@ Pulsar's xref:astream-subscriptions-shared.adoc[shared subscription] model trade
98
*Keys* are generated with *hashing*, which converts arbitrary values like "topic-name" or JSON blobs into fixed integer values. These hashed values are then assigned to subscribed consumers in one of two ways:
109

1110
* *Auto hash* - uses *consistent hashing* to balance range values across available consumers, without requiring manual setup of hash ranges.
12-
* *Sticky hash* - the client manually assigns consumer range values. All hashes within a configured range go to one consumer.
11+
* *Sticky hash* - the client manually assigns consumer range values. All hashes within a configured range go to one consumer.
1312
1413
This document explains how to use Pulsar's Key_Shared subscription model to manage your topic consumption.
1514

@@ -19,28 +18,28 @@ include::partial$subscription-prereq.adoc[]
1918
== Key_Shared subscription example
2019

2120
To try out a Pulsar Key_Shared subscription, add `.subscriptionType(SubscriptionType.Key_Shared)` to the `pulsarConsumer` in `SimplePulsarConsumer.java`. +
22-
You must also tell Pulsar what `keySharedPolicy` this subscription will use. The example below uses the auto-hashing `keySharedPolicy`.
21+
You must also tell Pulsar what `keySharedPolicy` this subscription will use. The example below uses the auto-hashing `keySharedPolicy`.
2322

2423
[source,java]
2524
----
2625
pulsarConsumer = pulsarClient.newConsumer(Schema.JSON(DemoBean.class))
27-
.topic("persistent://"
28-
+ conf.getTenantName() + "/"
29-
+ conf.getNamespace() + "/"
26+
.topic("persistent://"
27+
+ conf.getTenantName() + "/"
28+
+ conf.getNamespace() + "/"
3029
+ conf.getTopicName())
3130
.startMessageIdInclusive()
3231
.subscriptionInitialPosition(SubscriptionInitialPosition.Earliest)
3332
.subscriptionName("SimplePulsarConsumer")
3433
.subscriptionType(SubscriptionType.Key_Shared)
3534
.keySharedPolicy(KeySharedPolicy.autoSplitHashRange())
36-
.subscribe();
35+
.subscribe();
3736
----
3837

39-
Running multiple consumers with auto-hashing balances the messaging load across all available consumers.
38+
Running multiple consumers with auto-hashing balances the messaging load across all available consumers.
4039

4140
=== Manually set stickyHashRange
4241

43-
You can manually set a hash range with `KeySharedPolicy.stickyHashRange()`.
42+
You can manually set a hash range with `KeySharedPolicy.stickyHashRange()`.
4443

4544
To test out sticky hashed Key_Shared subscriptions, you need to first import some additional classes.
4645

@@ -67,9 +66,9 @@ import org.apache.pulsar.client.api.HashingScheme;
6766
----
6867
pulsarProducer = pulsarClient
6968
.newProducer(Schema.JSON(DemoBean.class))
70-
.topic("persistent://"
71-
+ conf.getTenantName() + "/"
72-
+ conf.getNamespace() + "/"
69+
.topic("persistent://"
70+
+ conf.getTenantName() + "/"
71+
+ conf.getNamespace() + "/"
7372
+ conf.getTopicName())
7473
.batcherBuilder(BatcherBuilder.KEY_BASED)
7574
.hashingScheme(HashingScheme.JavaStringHash)
@@ -94,7 +93,7 @@ The confirmation message and a cursor appear to indicate the consumer is ready.
9493
[pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.ConsumerImpl - [persistent://<tenant_name>/<namespace>/in][SimplePulsarConsumer] Subscribed to topic on <service_url> -- consumer: 0
9594
----
9695

97-
. In a new terminal window, run `SimplePulsarProducer.java` to begin producing messages.
96+
. In a new terminal window, run `SimplePulsarProducer.java` to begin producing messages.
9897
+
9998
[source,bash]
10099
----
@@ -104,15 +103,15 @@ The confirmation message and a cursor appear to indicate the consumer is ready.
104103
[main] INFO com.datastax.pulsar.SimplePulsarProducer - Message 57467766 sent
105104
----
106105

107-
. The consumer begins receiving messages.
106+
. The consumer begins receiving messages.
108107
+
109108
[source,bash]
110109
----
111110
[main] INFO com.datastax.pulsar.SimplePulsarConsumer - Message received: {"show_id":55794190,"cast":"LeBron James, Anthony Davis, Kyrie Irving, Damian Lillard, Klay Thompson...","country":"United States","date_added":"July 16, 2021","description":"NBA superstar LeBron James teams up with Bugs Bunny and the rest of the Looney Tunes for this long-awaited sequel.","director":"Malcolm D. Lee","duration":"120 min","listed_in":"Animation, Adventure, Comedy","rating":"PG","release_year":2021,"title":"Space Jam: A New Legacy","type":"Movie"}
112111
[main] INFO com.datastax.pulsar.SimplePulsarConsumer - Message received: {"show_id":41791865,"cast":"LeBron James, Anthony Davis, Kyrie Irving, Damian Lillard, Klay Thompson...","country":"United States","date_added":"July 16, 2021","description":"NBA superstar LeBron James teams up with Bugs Bunny and the rest of the Looney Tunes for this long-awaited sequel.","director":"Malcolm D. Lee","duration":"120 min","listed_in":"Animation, Adventure, Comedy","rating":"PG","release_year":2021,"title":"Space Jam: A New Legacy","type":"Movie"}
113112
----
114113

115-
. Open a new terminal window and try to run `SimplePulsarConsumer.java`.
114+
. Open a new terminal window and try to run `SimplePulsarConsumer.java`.
116115
+
117116
[source,bash]
118117
----
@@ -136,7 +135,7 @@ video::_49wlA53L_8[youtube, list=PL2g2h-wyI4SqeKH16czlcQ5x4Q_z-X7_m, height=445p
136135

137136
== What's next?
138137

139-
For more on subscriptions, see:
138+
For more on subscriptions, see:
140139

141140
* xref:astream-subscriptions.adoc[Subscriptions in Pulsar]
142141
* xref:astream-subscriptions-exclusive.adoc[Exclusive subscriptions]

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

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
= Shared subscriptions in Pulsar
2-
:page-aliases: docs@astra-streaming::astream-subscriptions-shared.adoc
32
:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
43

54
*Subscriptions* in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +
65

76
A *shared* subscription allows *multiple consumers* to consume messages from a *single topic* in round-robin fashion. +
8-
More consumers in a shared subscription can increase your Pulsar deployment's rate of message consumption, but at the cost of losing message ordering guarantees and acknowledgement schemes.
7+
More consumers in a shared subscription can increase your Pulsar deployment's rate of message consumption, but at the cost of losing message ordering guarantees and acknowledgement schemes.
98

109
This document explains how to use Pulsar's shared subscription model to manage your topic consumption.
1110

@@ -14,14 +13,14 @@ include::partial$subscription-prereq.adoc[]
1413
[#example]
1514
== Shared subscription example
1615

17-
To try out a Pulsar shared subscription, add `.subscriptionType(SubscriptionType.Shared)` to the `pulsarConsumer` in `SimplePulsarConsumer.java`.
16+
To try out a Pulsar shared subscription, add `.subscriptionType(SubscriptionType.Shared)` to the `pulsarConsumer` in `SimplePulsarConsumer.java`.
1817

1918
[source,java]
2019
----
2120
pulsarConsumer = pulsarClient.newConsumer(Schema.JSON(DemoBean.class))
22-
.topic("persistent://"
23-
+ conf.getTenantName() + "/"
24-
+ conf.getNamespace() + "/"
21+
.topic("persistent://"
22+
+ conf.getTenantName() + "/"
23+
+ conf.getNamespace() + "/"
2524
+ conf.getTopicName())
2625
.startMessageIdInclusive()
2726
.subscriptionInitialPosition(SubscriptionInitialPosition.Earliest)
@@ -40,7 +39,7 @@ The confirmation message and a cursor appear to indicate the consumer is ready.
4039
[pulsar-client-io-1-1] INFO org.apache.pulsar.client.impl.ConsumerImpl - [persistent://<tenant_name>/<namespace>/in][SimplePulsarConsumer] Subscribed to topic on <service_url> -- consumer: 0
4140
----
4241

43-
. In a new terminal window, run `SimplePulsarProducer.java` to begin producing messages.
42+
. In a new terminal window, run `SimplePulsarProducer.java` to begin producing messages.
4443
+
4544
[source,bash]
4645
----
@@ -51,7 +50,7 @@ The confirmation message and a cursor appear to indicate the consumer is ready.
5150
[main] INFO com.datastax.pulsar.SimplePulsarProducer - Message 51277375 sent
5251
----
5352

54-
. The consumer begins receiving messages.
53+
. The consumer begins receiving messages.
5554
+
5655
[source,bash]
5756
----
@@ -75,7 +74,7 @@ Since this test uses shared subscriptions, you can attach multiple consumers to
7574

7675
== Shared subscription video
7776

78-
Follow along with this video from our *Five Minutes About Pulsar* series to see shared subscriptions in action.
77+
Follow along with this video from our *Five Minutes About Pulsar* series to see shared subscriptions in action.
7978

8079
video::mmukXqGsauA[youtube, list=PL2g2h-wyI4SqeKH16czlcQ5x4Q_z-X7_m, height=445px,width=100%]
8180

modules/ROOT/pages/astream-subscriptions.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
= Subscriptions in Pulsar
2-
:page-aliases: docs@astra-streaming::astream-subscriptions.adoc
32
:page-tag: pulsar-subscriptions,quickstart,admin,dev,pulsar
43

54
*Subscriptions* in Pulsar describe which consumers are consuming data from a topic and how they want to consume that data. +
65

7-
Subscriptions are managed in the broker as a collection of metadata about a topic and its subscribed consumers. This metadata includes:
6+
Subscriptions are managed in the broker as a collection of metadata about a topic and its subscribed consumers. This metadata includes:
87

98
* Topic name - which topic the consumer wants data from
109
* Subscription name - a string representing a qualified name for the subscription
1110
* Subscription type - which type of subscription is being used
12-
* Subscription cursor - a representation of the consumer's current place in the subscribed topic log
11+
* Subscription cursor - a representation of the consumer's current place in the subscribed topic log
1312
1413
For example, the Pulsar consumer below has a *shared* subscription starting at the *earliest* cursor position in `my-subscription` to `my-topic`:
1514

@@ -30,7 +29,7 @@ Read on to use Pulsar's four types of subscriptions to manage your topic consump
3029
* xref:astream-subscriptions-failover.adoc[Failover subscriptions]
3130
* xref:astream-subscriptions-keyshared.adoc[Key_shared subscriptions]
3231
33-
== What's next?
32+
== What's next?
3433

3534
* Follow our xref:getting-started:index.adoc[simple guide] to get started with Astra now.
3635
* For using Kafka with {product_name}, see xref:developing:astream-kafka.adoc[Starlight for Kafka].

modules/ROOT/pages/index.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
= What is DataStax {product_name}?
2-
:slug: what-is-datastax-astra-streaming
3-
:page-aliases: docs@astra-streaming::index.adoc
4-
:page-tag: astra-streaming,planner,admin,dev,pulsar
52
:navtitle: Astra Streaming
3+
:page-tag: astra-streaming,planner,admin,dev,pulsar
64

75
{product_name} is a cloud native data streaming and event stream processing
86
service tightly integrated into the {astra_ui} and powered by Apache Pulsar™.

modules/apis/pages/index.adoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
= API References
2-
:slug: astream-api
32
:description: Astra provides APIs to manage both DB and Streaming instances
4-
:keywords: datastax astra
5-
:meta-description: Astra provides APIs to manage both DB and Streaming instances
63
:page-tag: astra-streaming,dev,develop,pulsar
7-
:page-aliases: docs@astra-streaming::api.adoc, astra-streaming-docs::api.adoc, astra-streaming-docs::astream-use-devops.adoc
84

95
Management of Pulsar tenants and its resources are seperated into 2 APIs. The DevOps API is used to manage higher level objects associated with your account. The Pulsar Admin API is used to manage specific resources such as namespaces, topics, and subscriptions within a specific tenant.
106

0 commit comments

Comments
 (0)