Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions modules/ROOT/pages/astream-org-permissions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
:navtitle: Manage roles and permissions
:page-tag: astra-streaming,security,secure,pulsar

You manage role-based access control (RBAC) for {product} through your {astra-db} organization.
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[].
You manage role-based access control (RBAC) for {product} through your {product-short} organization.
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[].

== {product} permissions

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

=== Default roles for {product}

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

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

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

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

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

On a shared cluster, your {astra-db} organization has one or more tenants on a shared {pulsar-short} cluster.
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).
On a shared cluster, your {product-short} organization has one or more tenants on a shared {pulsar-short} cluster.
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).

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

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

== See also
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Using {product}, customers can quickly create {pulsar-short} instances,
manage their clusters, scale across cloud regions, and manage {pulsar-short} resources
such as topics, connectors, functions and subscriptions.

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

With {product}, customers now have powerful capabilities to help drive key
Expand Down
4 changes: 2 additions & 2 deletions modules/apis/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ You use two APIs to manage {pulsar-reg} tenants and their resources.

== {product} {devops-api}

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.
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.

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

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

Expand Down
6 changes: 3 additions & 3 deletions modules/developing/pages/astra-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
:navtitle: {astra-cli}
:description: {astra-cli} provides a one-stop shop for managing your Astra resources through scripts or commands in your local terminal.

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:
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:

* Creation and management of {astra-db} databases, {astra_stream} tenants, and their associated artifacts.
* Querying and data loading.
* Organization and user management.
* Security and token configuration.

{astra-cli} commands are available for {astra-db} and {astra_stream}.
{astra-cli} commands are available for {product-short} and {astra_stream}.
They're designed to get you working quickly, with an emphasis on automation.

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

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

For more information, see the following:

Expand Down
14 changes: 7 additions & 7 deletions modules/developing/pages/astream-functions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Functions are implemented using https://pulsar.apache.org/docs/en/functions-over

[IMPORTANT]
====
Custom functions require a xref:operations:astream-pricing.adoc[paid {product} plan].
Custom functions require a xref:operations:astream-pricing.adoc[paid {product-short} plan].

Organizations on the *Free* plan can use xref:streaming-learning:functions:index.adoc[transform functions] only.
====
Expand Down Expand Up @@ -249,7 +249,7 @@ bin/pulsar-admin functions create --function-config-file **PATH_TO_FUNCTION_CONF
====
A response of `Created Successfully!` indicates the function is deployed and ready to accept messages.

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].
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].
Organizations on the *Free* plan can use xref:streaming-learning:functions:index.adoc[transform functions] only.
====
+
Expand Down Expand Up @@ -287,7 +287,7 @@ See <<controlling-your-function,Controlling your function>> for more information

== Deploy functions in the {astra-ui}

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

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

Expand All @@ -311,7 +311,7 @@ Upload your own code::

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

. Select input topics.

. (Optional) Select output and log topics.
. Optional: Select output and log topics.

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

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

. Click *Create*.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Message received: Hello World
----
====

. In the {astra-ui}, go to your tenant to verify that the message appears in the specified namespace and topic.
. 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.

== See also

Expand Down
2 changes: 1 addition & 1 deletion modules/developing/pages/configure-pulsar-env.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The executables in `/bin` use the configurations in `/conf` to run commands.
Each tenant you create in {product} comes with its own custom configuration for SSO, endpoints, and so on.
You must download the tenant configuration from {product}, and then overwrite the `./conf/client.conf` file.

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

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

Expand Down
4 changes: 2 additions & 2 deletions modules/developing/pages/gpt-schema-translator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ The {gpt-schema-translator} is available for the {astra-db} sink connector only.
This example uses a JSON schema for a {pulsar-short} topic, and a CQL schema for an {astra-db} table.
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.

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

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

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

Expand Down
8 changes: 4 additions & 4 deletions modules/developing/pages/using-curl.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ Each API supports different functionalities.
Depending on the API you use, you need certain information to form HTTP requests:

* 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.
* To use the {devops-api}s, you need an xref:operations:astream-token-gen.adoc[{astra-db} application token].
* To use the {devops-api}s, you need an xref:operations:astream-token-gen.adoc[{product-short} application token].

== Get the tenant web service URL

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

. Click the *Connect* tab.

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

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

For information about creating {pulsar-short} tokens, see xref:operations:astream-token-gen.adoc[].
Expand Down
11 changes: 5 additions & 6 deletions modules/developing/partials/client-variables-table.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,25 @@

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

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

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

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

|`topicName`
|Topic name (not the full name)
|In the {astra-ui} navigation menu, click *Streaming*, select your streaming tenant, and then click the *Namespace and Topics* tab.
|In the {astra-ui} navigation menu, click *Streaming*, click the name of your streaming tenant, and then click the *Namespace and Topics* tab.
Expand the target namespace in the list of namespaces to view the names of the topics within.
Do _not_ use the *Full Name*.
|===
6 changes: 3 additions & 3 deletions modules/getting-started/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ You can create namespaces in the {astra-ui} or programmatically.
For this quickstart, use the {astra-ui}.
For information about the {pulsar-short} CLI or APIs, see xref:developing:configure-pulsar-env.adoc[] and xref:developing:using-curl.adoc[].

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

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

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

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

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

. Click the *Namespace And Topics* tab.

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

. Enter a topic name, and then click *Add Topic*.
+
Expand Down
4 changes: 2 additions & 2 deletions modules/operations/pages/astream-georeplication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This means you can enable asynchronous geo-replication on topics where it is nee

To enable geo-replication in {product}, follow these steps:

. In your {product} tenant, select **Namespaces and Topics** to list your tenant's current namespaces and topics.
. In your {product} tenant, click **Namespaces and Topics** to view a list of your tenant's current namespaces and topics.

. Select **Modify namespace** in the namespace you want to replicate *from*.

Expand Down Expand Up @@ -131,7 +131,7 @@ key:[null], properties:[], content:hello-from-pulsar
key:[null], properties:[], content:hello-from-pulsar
----

. In the {astra-ui}, go to your tenant's **Namespaces and Topics** tab.
. In the {astra-ui} navigation menu, click *Streaming*, click the name of your tenant, and then click the **Namespaces and Topics** tab.

. Make sure `persistent://**TENANT_NAME**/**NAMESPACE_NAME**/**TOPIC_NAME**` is visible and shows traffic across all regions.

Expand Down
26 changes: 13 additions & 13 deletions modules/operations/pages/astream-limits.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
{product} includes guardrails and limits to ensure best practices, foster availability, and promote optimal configurations for your databases.

Unless otherwise noted, the following limits apply to shared clusters.
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].
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].

== {product} guardrails

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

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

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

Expand All @@ -30,32 +30,32 @@ a|
|Number of topics per namespace
a|
* Shared clusters: 100
* Dedicated clusters: 5000
* Streaming Capacity Units: 5000
|

|Max message size
a|
* Shared clusters: 5MB
* Dedicated clusters: Customizable
* Streaming Capacity Units: Customizable
|

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

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

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

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

|Number of consumers per topic
a|
* Shared clusters: 50
* Dedicated clusters: 500
* Streaming Capacity Units: 500
|

|Number of subscriptions per topic
a|
* Shared clusters: 50
* Dedicated clusters: 500
* Streaming Capacity Units: 500
|

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

|Shared
|Shared clusters
|0.25 core
|500MB
|Varies by plan

|Dedicated
|Streaming Capacity Units (dedicated clusters)
|0.50 core
|1GB
|5000
Expand Down
Loading