Skip to content

Commit ada8913

Browse files
authored
DOC-4990, DOC-5076 Pricing, Style tweaks and Streaming Capacity Units terminology (#132)
* pricing link and SCU * style tweaks per doc-5076 * fix attribute * peer review
1 parent b4bed9e commit ada8913

20 files changed

+117
-113
lines changed

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
:navtitle: Manage roles and permissions
33
:page-tag: astra-streaming,security,secure,pulsar
44

5-
You manage role-based access control (RBAC) for {product} through your {astra-db} organization.
6-
For information about {astra-db} RBAC, including default roles, custom roles, permissions, and user management, see xref:astra-db-serverless:administration:manage-database-access.adoc[].
5+
You manage role-based access control (RBAC) for {product} through your {product-short} organization.
6+
For information about {product-short} RBAC, including default roles, custom roles, permissions, and user management, see xref:astra-db-serverless:administration:manage-database-access.adoc[].
77

88
== {product} permissions
99

@@ -13,7 +13,7 @@ Permissions specific to {product} include the following:
1313

1414
=== Default roles for {product}
1515

16-
There are no default {astra-db} roles specifically scoped to {product}.
16+
There are no default {product-short} roles specifically scoped to {product}.
1717
However, the following default roles have the *Manage Streaming* permission:
1818

1919
* *Organization Administrator*
@@ -37,22 +37,22 @@ Additional permissions might be required, depending on the tasks the role needs
3737
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.
3838
====
3939

40-
== Authentication and authorization in {pulsar-reg} and {astra-db}
40+
== Authentication and authorization in {pulsar-reg} and {product-short}
4141

4242
{pulsar-short} has the concept of https://pulsar.apache.org/docs/security-authorization/[clients with role tokens].
4343
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.
4444

4545
{product} uses the {company} version of {pulsar} (xref:luna-streaming::index.adoc[Luna Streaming]).
4646
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.
4747

48-
On a shared cluster, your {astra-db} organization has one or more tenants on a shared {pulsar-short} cluster.
49-
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).
48+
On a shared cluster, your {product-short} organization has one or more tenants on a shared {pulsar-short} cluster.
49+
Each of your tenants is secured by {pulsar-short} authentication and authorization models, as well as your {product-short} organization's authentication and authorization ({product-short} RBAC).
5050

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

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

5858
== See also

modules/ROOT/pages/index.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Using {product}, customers can quickly create {pulsar-short} instances,
88
manage their clusters, scale across cloud regions, and manage {pulsar-short} resources
99
such as topics, connectors, functions and subscriptions.
1010

11-
{product} takes advantage of the core capabilities built into {astra-db} such
11+
{product} takes advantage of the core capabilities built into {product-short} such
1212
as SSO, IAM and billing.
13-
Existing {astra-db} customers can augment their existing database capabilities
13+
Existing {product-short} customers can augment their existing database capabilities
1414
with pub/sub and streaming to address a wider range of use cases right away.
1515

1616
With {product}, customers now have powerful capabilities to help drive key

modules/apis/pages/index.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ You use two APIs to manage {pulsar-reg} tenants and their resources.
66

77
== {product} {devops-api}
88

9-
Use the xref:astra-streaming:apis:attachment$devops.html[{product} {devops-api}] to manage higher-level {product} objects associated with your {astra-db} organization, such as the Change Data Capture (CDC) settings, {pulsar-short} tenants, geo-replications, {pulsar-short} stats, and {pulsar-short} tokens.
9+
Use the xref:astra-streaming:apis:attachment$devops.html[{product} {devops-api}] to manage higher-level {product} objects associated with your {product-short} organization, such as the Change Data Capture (CDC) settings, {pulsar-short} tenants, geo-replications, {pulsar-short} stats, and {pulsar-short} tokens.
1010

11-
This API uses an {astra-db} application token for authentication.
11+
This API uses an {product-short} application token for authentication.
1212

1313
== {product} {pulsar-short} Admin API
1414

modules/developing/pages/astra-cli.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
:navtitle: {astra-cli}
33
:description: {astra-cli} provides a one-stop shop for managing your Astra resources through scripts or commands in your local terminal.
44

5-
The xref:astra-cli:ROOT:index.adoc[{astra-db} Command-Line Interface ({astra-cli})] is a set of commands you can use to create and manage {astra-db} and {product} resources:
5+
The xref:astra-cli:ROOT:index.adoc[{product-short} Command-Line Interface ({astra-cli})] is a set of commands you can use to create and manage {product-short} and {product} resources:
66

77
* Creation and management of {astra-db} databases, {astra_stream} tenants, and their associated artifacts.
88
* Querying and data loading.
99
* Organization and user management.
1010
* Security and token configuration.
1111
12-
{astra-cli} commands are available for {astra-db} and {astra_stream}.
12+
{astra-cli} commands are available for {product-short} and {astra_stream}.
1313
They're designed to get you working quickly, with an emphasis on automation.
1414

1515
For example, the following command creates an {pulsar-reg} tenant:
@@ -21,7 +21,7 @@ astra streaming create **TENANT_NAME** \
2121
--plan **PLAN_TYPE** --namespace **TENANT_INITIAL_NAMESPACE_NAME**
2222
----
2323

24-
You can use {astra-cli} instead of or in addition to the {astra-ui} and {astra-db} APIs.
24+
You can use {astra-cli} instead of or in addition to the {astra-ui} and {product-short} APIs.
2525

2626
For more information, see the following:
2727

modules/developing/pages/astream-functions.adoc

+7-7
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Functions are implemented using https://pulsar.apache.org/docs/en/functions-over
1212

1313
[IMPORTANT]
1414
====
15-
Custom functions require a xref:operations:astream-pricing.adoc[paid {product} plan].
15+
Custom functions require a xref:operations:astream-pricing.adoc[paid {product-short} plan].
1616
1717
Organizations on the *Free* plan can use xref:streaming-learning:functions:index.adoc[transform functions] only.
1818
====
@@ -249,7 +249,7 @@ bin/pulsar-admin functions create --function-config-file **PATH_TO_FUNCTION_CONF
249249
====
250250
A response of `Created Successfully!` indicates the function is deployed and ready to accept messages.
251251

252-
If the response is `402 Payment Required` with `Reason: only qualified organizations can create functions`, then you must upgrade to a xref:operations:astream-pricing.adoc[paid {product} plan].
252+
If the response is `402 Payment Required` with `Reason: only qualified organizations can create functions`, then you must upgrade to a xref:operations:astream-pricing.adoc[paid {product-short} plan].
253253
Organizations on the *Free* plan can use xref:streaming-learning:functions:index.adoc[transform functions] only.
254254
====
255255
+
@@ -287,7 +287,7 @@ See <<controlling-your-function,Controlling your function>> for more information
287287

288288
== Deploy functions in the {astra-ui}
289289

290-
. In the {astra-ui} navigation menu, click *Streaming*, and then select a tenant.
290+
. In the {astra-ui} navigation menu, click *Streaming*, and then click the name of the tenant where you want to deploy a function.
291291

292292
. On the *Functions* tab, click *Create Function*.
293293

@@ -311,7 +311,7 @@ Upload your own code::
311311
312312
.. Based on the uploaded file, select the specific class (function) to deploy.
313313
+
314-
{astra-db} generates a list of acceptable classes detected in the code.
314+
{product-short} generates a list of acceptable classes detected in the code.
315315
A file can contain multiple classes, but only one is used per deployment.
316316
+
317317
For Python scripts, the class name is the Python filename (without the extension) and the class to execute.
@@ -336,9 +336,9 @@ For more information, see xref:streaming-learning:functions:index.adoc[] and xre
336336

337337
. Select input topics.
338338

339-
. (Optional) Select output and log topics.
339+
. Optional: Select output and log topics.
340340

341-
. (Optional) Configure advanced settings:
341+
. Optional: Configure advanced settings.
342342
+
343343
* *Instances*: Enter a number of sink instances to run.
344344
* *Processing Guarantee*: Select one of the following:
@@ -349,7 +349,7 @@ This means there is a change that a message is not processed.
349349
* *Timeout*: Set a timeout limit.
350350
* *Auto Acknowledge*: Enable or disable automatic message acknowledgment.
351351

352-
. (Optional) Provide a config key, if required.
352+
. Optional: Provide a config key, if required.
353353
For more information, see the https://pulsar.apache.org/functions-rest-api/#operation/registerFunction[{pulsar-short} documentation].
354354

355355
. Click *Create*.

modules/developing/pages/clients/spring-produce-consume.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Message received: Hello World
101101
----
102102
====
103103

104-
. In the {astra-ui}, go to your tenant to verify that the message appears in the specified namespace and topic.
104+
. In the {astra-ui} navigation menu, click *Streaming*, click the name of your tenant, and then verify that the message appears in the specified namespace and topic.
105105

106106
== See also
107107

modules/developing/pages/configure-pulsar-env.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The executables in `/bin` use the configurations in `/conf` to run commands.
4141
Each tenant you create in {product} comes with its own custom configuration for SSO, endpoints, and so on.
4242
You must download the tenant configuration from {product}, and then overwrite the `./conf/client.conf` file.
4343

44-
. In the {astra-ui} navigation menu, click *Streaming*, and then select your tenant.
44+
. In the {astra-ui} navigation menu, click *Streaming*, and then click the name of your tenant.
4545

4646
. Click the *Connect* tab, in the *{pulsar-short} CLI* section, click *Download client.conf*.
4747

modules/developing/pages/gpt-schema-translator.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ The {gpt-schema-translator} is available for the {astra-db} sink connector only.
2323
This example uses a JSON schema for a {pulsar-short} topic, and a CQL schema for an {astra-db} table.
2424
The {gpt-schema-translator} generates a mapping between the two schemas that the {astra-db} sink connector can use to write data from the {pulsar-short} topic to the {astra-db} table.
2525

26-
. In the {astra-ui} navigation menu, click *Streaming*, and then select your tenant.
26+
. In the {astra-ui} navigation menu, click *Streaming*, and then click the name of your tenant.
2727

28-
. On the *Namespaces and Topics* tab, locate the topic that you want to map to a table, and then click *Create mapping*.
28+
. On the *Namespaces and Topics* tab, find the topic that you want to map to a table, and then click *Create mapping*.
2929

3030
. Select your database's keyspace, and then enter the name of the table that you want to map to.
3131

modules/developing/pages/using-curl.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ Each API supports different functionalities.
88
Depending on the API you use, you need certain information to form HTTP requests:
99

1010
* To use the {product} {pulsar-short} Admin API and {pulsar-short} REST APIs, you need the tenant's Web Service URL and {pulsar-short} token.
11-
* To use the {devops-api}s, you need an xref:operations:astream-token-gen.adoc[{astra-db} application token].
11+
* To use the {devops-api}s, you need an xref:operations:astream-token-gen.adoc[{product-short} application token].
1212
1313
== Get the tenant web service URL
1414

15-
. In the {astra-ui} navigation menu, click *Streaming*, and then select your tenant.
15+
. In the {astra-ui} navigation menu, click *Streaming*, and then click the name of your tenant.
1616

1717
. Click the *Connect* tab.
1818

19-
. Locate the *Tenant Details* section.
19+
. Find the *Tenant Details* section.
2020
Here you can find the essential information you need to communicate with your {pulsar-short} tenant, including the *Web Service URL*.
2121
+
2222
image:tenant-details.png[Tenant details in {product}]
@@ -33,7 +33,7 @@ Broker Service URLs start with `pulsar(+ssl)`.
3333

3434
[IMPORTANT]
3535
====
36-
An xref:operations:astream-token-gen.adoc[{astra-db} application token] is _not_ the same as a {pulsar-short} token.
36+
An xref:operations:astream-token-gen.adoc[{product-short} application token] is _not_ the same as a {pulsar-short} token.
3737
====
3838

3939
For information about creating {pulsar-short} tokens, see xref:operations:astream-token-gen.adoc[].

modules/developing/partials/client-variables-table.adoc

+5-6
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,25 @@
44

55
|`serviceUrl`
66
|The URL to connect to the {pulsar-short} cluster
7-
|In the {astra-ui} navigation menu, click *Streaming*, select your streaming tenant, and then click the *Connect* tab.
8-
In the *Details* section, get the *Broker Service URL*.
7+
|In the {astra-ui} navigation menu, click *Streaming*, and then click the name of your streaming tenant.
8+
On the *Connect* tab, in the *Tenant Details* section, get the *Broker Service URL*.
99

1010
|`pulsarToken`
1111
|The token for {pulsar-short} cluster authentication
1212
|For information about creating {pulsar-short} tokens, see xref:operations:astream-token-gen.adoc[].
1313

1414
|`tenantName`
1515
|The name of your streaming tenant
16-
|In the {astra-ui} navigation menu, click *Streaming*, select your streaming tenant.
17-
In the *Details* section, get the *Name*.
16+
|In the {astra-ui} navigation menu, click *Streaming*, and then get the name from the *Tenants* list.
1817

1918
|`namespace`
2019
|The segmented area for certain topics in your streaming tenant
21-
|In the {astra-ui} navigation menu, click *Streaming*, select your streaming tenant, and then click the *Namespace and Topics* tab.
20+
|In the {astra-ui} navigation menu, click *Streaming*, click the name of your streaming tenant, and then click the *Namespace and Topics* tab.
2221
Choose the target namespace from the list of namespaces.
2322

2423
|`topicName`
2524
|Topic name (not the full name)
26-
|In the {astra-ui} navigation menu, click *Streaming*, select your streaming tenant, and then click the *Namespace and Topics* tab.
25+
|In the {astra-ui} navigation menu, click *Streaming*, click the name of your streaming tenant, and then click the *Namespace and Topics* tab.
2726
Expand the target namespace in the list of namespaces to view the names of the topics within.
2827
Do _not_ use the *Full Name*.
2928
|===

modules/getting-started/pages/index.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ You can create namespaces in the {astra-ui} or programmatically.
4949
For this quickstart, use the {astra-ui}.
5050
For information about the {pulsar-short} CLI or APIs, see xref:developing:configure-pulsar-env.adoc[] and xref:developing:using-curl.adoc[].
5151

52-
. In the {astra-ui} navigation menu, click *Streaming*, and then select your tenant.
52+
. In the {astra-ui} navigation menu, click *Streaming*, and then click the name of your tenant.
5353

5454
. Click the *Namespace And Topics* tab, and then click *Create Namespace*.
5555

@@ -72,11 +72,11 @@ To learn more about topics, see the https://pulsar.apache.org/docs/concepts-mess
7272

7373
As in the previous steps, you can create topics in the {astra-ui} or programmatically.
7474

75-
. In the {astra-ui} navigation menu, click *Streaming*, and then select your tenant.
75+
. In the {astra-ui} navigation menu, click *Streaming*, and then click the name of your tenant.
7676

7777
. Click the *Namespace And Topics* tab.
7878

79-
. Locate a namespace where you want to create a topic, and then click *Add Topic*.
79+
. Find the namespace where you want to create a topic, and then click *Add Topic*.
8080

8181
. Enter a topic name, and then click *Add Topic*.
8282
+

modules/operations/pages/astream-georeplication.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ This means you can enable asynchronous geo-replication on topics where it is nee
3232
3333
To enable geo-replication in {product}, follow these steps:
3434
35-
. In your {product} tenant, select **Namespaces and Topics** to list your tenant's current namespaces and topics.
35+
. In your {product} tenant, click **Namespaces and Topics** to view a list of your tenant's current namespaces and topics.
3636
3737
. Select **Modify namespace** in the namespace you want to replicate *from*.
3838
@@ -131,7 +131,7 @@ key:[null], properties:[], content:hello-from-pulsar
131131
key:[null], properties:[], content:hello-from-pulsar
132132
----
133133
134-
. In the {astra-ui}, go to your tenant's **Namespaces and Topics** tab.
134+
. In the {astra-ui} navigation menu, click *Streaming*, click the name of your tenant, and then click the **Namespaces and Topics** tab.
135135
136136
. Make sure `persistent://**TENANT_NAME**/**NAMESPACE_NAME**/**TOPIC_NAME**` is visible and shows traffic across all regions.
137137

modules/operations/pages/astream-limits.adoc

+13-13
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
{product} includes guardrails and limits to ensure best practices, foster availability, and promote optimal configurations for your databases.
55

66
Unless otherwise noted, the following limits apply to shared clusters.
7-
In general, xref:operations:astream-pricing.adoc#dedicated-clusters[dedicated clusters] have more relaxed limits than shared clusters, and some limits can be changed by contacting {support_url}[{company} Support].
7+
In general, xref:operations:astream-pricing.adoc#dedicated-clusters[Streaming Capacity Units] have more relaxed limits than shared clusters, and some limits can be changed by contacting {support_url}[{company} Support].
88

99
== {product} guardrails
1010

1111
Guardrails are provisioned in the default settings for {product}.
1212
You can't directly change these guardrails.
13-
For dedicated clusters, some guardrails can be changed by contacting {support_url}[{company} Support].
13+
For Streaming Capacity Units, some guardrails can be changed by contacting {support_url}[{company} Support].
1414

1515
[cols="1,1,1"]
1616
|===
@@ -19,7 +19,7 @@ For dedicated clusters, some guardrails can be changed by contacting {support_ur
1919
|Number of tenants per organization
2020
a|
2121
* Shared clusters: 10
22-
* Dedicated clusters: Unlimited
22+
* Streaming Capacity Units: Unlimited
2323

2424
|This limit can't be changed for shared clusters.
2525

@@ -30,32 +30,32 @@ a|
3030
|Number of topics per namespace
3131
a|
3232
* Shared clusters: 100
33-
* Dedicated clusters: 5000
33+
* Streaming Capacity Units: 5000
3434
|
3535

3636
|Max message size
3737
a|
3838
* Shared clusters: 5MB
39-
* Dedicated clusters: Customizable
39+
* Streaming Capacity Units: Customizable
4040
|
4141

4242
|Max throughput per topic for consumers
4343
a|
4444
* Shared clusters: 5000 messages per second, 25MB per second
45-
* Dedicated clusters: Customizable
45+
* Streaming Capacity Units: Customizable
4646
|This limit applies to non-partitioned topics and individual partitions of partitioned topics.
4747

4848
|Max throughput per topic for producers
4949
a|
5050
* Shared clusters: 5000 messages per second, 25MB per second
51-
* Dedicated clusters: Customizable
51+
* Streaming Capacity Units: Customizable
5252
|This limit applies to non-partitioned topics and individual partitions of partitioned topics, regardless of the number of producers to a topic.
5353
If there are multiple producers to a topic, they can produce a _combined maximum_ of 5000 messages per second.
5454

5555
|Max throughput per topic for subscriptions
5656
a|
5757
* Shared clusters: 5000 messages per second, 25MB per second
58-
* Dedicated clusters: Customizable
58+
* Streaming Capacity Units: Customizable
5959
|This limit applies to non-partitioned topics and individual partitions of partitioned topics, regardless of the number of subscribers to a topic.
6060
If there are multiple subscriptions to a topic, they can dispatch a _combined maximum_ of 5000 messages per second.
6161

@@ -70,19 +70,19 @@ If there are multiple subscriptions to a topic, they can dispatch a _combined ma
7070
|Number of producers per topic
7171
a|
7272
* Shared clusters: 50
73-
* Dedicated clusters: 500
73+
* Streaming Capacity Units: 500
7474
|
7575

7676
|Number of consumers per topic
7777
a|
7878
* Shared clusters: 50
79-
* Dedicated clusters: 500
79+
* Streaming Capacity Units: 500
8080
|
8181

8282
|Number of subscriptions per topic
8383
a|
8484
* Shared clusters: 50
85-
* Dedicated clusters: 500
85+
* Streaming Capacity Units: 500
8686
|
8787

8888
|Max unacknowledged messages per consumer
@@ -314,12 +314,12 @@ The default settings are as follows:
314314
|===
315315
|Cluster type |CPU per instance |RAM per instance |Maximum function instances per namespace
316316

317-
|Shared
317+
|Shared clusters
318318
|0.25 core
319319
|500MB
320320
|Varies by plan
321321

322-
|Dedicated
322+
|Streaming Capacity Units (dedicated clusters)
323323
|0.50 core
324324
|1GB
325325
|5000

0 commit comments

Comments
 (0)