You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/astream-faq.adoc
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,17 +28,17 @@ The pricing model also makes {product} accessible to mid market and small/medium
28
28
29
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.
30
30
31
-
== What is CDC for {astra_db}?
31
+
== What is CDC for {astra-db}?
32
32
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.
33
+
Change Data Capture (CDC) for {astra-db} uses a {pulsar-short} IO source connector that processes changes from the {cass-short} Change Agent through a {pulsar-short} topic.
34
34
For more information, see xref:developing:astream-cdc.adoc[].
35
35
36
36
== What are tenants, namespaces, topics, and sinks?
37
37
38
38
*Tenants* are an isolated administrative unit for which an authorization scheme can be set and a set of clusters can be defined.
39
39
Each tenant can have multiple *namespaces*, a logical container for creating and managing a hierarchy of topics.
40
40
A *topic* is a named channel for transmitting messages from producers to consumers.
41
-
A *sink* feeds data from {product} to an external system, such as {cassandra} or Elasticsearch.
41
+
A *sink* feeds data from {product} to an external system, such as {cass-reg} or Elasticsearch.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/astream-org-permissions.adoc
+12-11Lines changed: 12 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,19 @@
1
-
= Manage roles and permissions
1
+
= Manage {product} roles and permissions
2
+
:navtitle: Manage roles and permissions
2
3
:page-tag: astra-streaming,security,secure,pulsar
3
4
4
-
You manage role-based access control (RBAC) for {product} through your {astra_db} organization.
5
-
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 {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[].
6
7
7
8
== {product} permissions
8
9
9
10
Permissions specific to {product} include the following:
There are no default {astra_db} roles specifically scoped to {product}.
16
+
There are no default {astra-db} roles specifically scoped to {product}.
16
17
However, the following default roles have the *Manage Streaming* permission:
17
18
18
19
* *Organization Administrator*
@@ -26,8 +27,8 @@ For information about permissions assigned to default roles, see xref:astra-db-s
26
27
27
28
If you xref:astra-db-serverless:administration:manage-database-access.adoc#custom-roles[create custom roles] for {product}, those roles must have the following permissions, at minimum:
28
29
29
-
* *Manage Streaming* (`org-stream-manage`): View and manage {product} in the {astra_ui}.
30
-
* *View DB* (`org-db-view`): View the {astra_ui} in general.
30
+
* *Manage Streaming* (`org-stream-manage`): View and manage {product} in the {astra-ui}.
31
+
* *View DB* (`org-db-view`): View the {astra-ui} in general.
31
32
32
33
Additional permissions might be required, depending on the tasks the role needs to perform.
33
34
@@ -36,22 +37,22 @@ Additional permissions might be required, depending on the tasks the role needs
36
37
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.
37
38
====
38
39
39
-
== Authentication and authorization in {pulsar-reg} and {astra_db}
40
+
== Authentication and authorization in {pulsar-reg} and {astra-db}
40
41
41
42
{pulsar-short} has the concept of https://pulsar.apache.org/docs/security-authorization/[clients with role tokens].
42
43
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.
43
44
44
45
{product} uses the {company} version of {pulsar} (xref:luna-streaming::index.adoc[Luna Streaming]).
45
46
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.
46
47
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).
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).
49
50
50
51
{product} shared clusters are created and administered by {product} administrators.
51
52
Each tenant is assigned a custom role and permissions limited to that tenant only.
52
53
All tokens created within a tenant are assigned roles similar to the assigning tenant.
53
54
54
-
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 {astra-db} application tokens or {pulsar-short} JWT, depending on the operation you need to perform.
55
56
For more information, see xref:operations:astream-token-gen.adoc[].
Copy file name to clipboardExpand all lines: modules/apis/pages/api-operations.adoc
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,19 @@
1
1
= API operations
2
2
3
3
//TODO: Needs more work and clean up of all source blocks.
4
-
This {product} workbook is a comprehensive guide that provides detailed examples and practices for managing the {product} platform using the DevOps APIs.
4
+
This {product} workbook is a comprehensive guide that provides detailed examples and practices for managing the {product} platform using the {devops-api}s.
5
5
It provides details on the most commonly used APIs for managing {product} and {pulsar-reg} instances.
6
6
These details include required parameters and the expected output from the API.
7
7
The workbook is designed to fill the gap between detailed API reference docs and HowTo guides.
8
-
The result is to help customers in operating and managing {product} and provide guidance on how to use DevOps API to automate many common tasks.
8
+
The result is to help customers in operating and managing {product} and provide guidance on how to use {devops-api}s to automate many common tasks.
9
9
10
10
The workbook covers a wide range of topics, including provisioning of resources, monitoring, and troubleshooting. It provides instructions for various operations, such as creating a new tenant, namespace, topics, geo-replication, and access tokens, to setting up monitoring and alerting, and troubleshooting common issues.
11
11
12
-
Overall, this {product} Workbook is a valuable resource for customers who want to leverage the benefits of {product} and manage their streaming environment effectively with DevOps APIs. By following the best practices and guidelines outlined in the workbook, customers can ensure that their streaming applications are secure, performant, and reliable.
12
+
Overall, this {product} Workbook is a valuable resource for customers who want to leverage the benefits of {product} and manage their streaming environment effectively with {devops-api}s. By following the best practices and guidelines outlined in the workbook, customers can ensure that their streaming applications are secure, performant, and reliable.
13
13
14
14
== Prerequisites
15
15
16
-
* An active {astra_db} account with access to {product}
16
+
* An active {product-short} account with access to {product}
17
17
* Credentials and values required to xref:developing:using-curl.adoc[form HTTP requests]
18
18
19
19
=== Set environment variables
@@ -42,9 +42,9 @@ The examples in this guide use environment variables for these values.
42
42
Additionally, some examples in this guide use `python3 -mjson.tool` to format the JSON response.
43
43
This is optional; it is not required to execute API requests.
44
44
45
-
== {product} DevOps API tenant operations
45
+
== {product} {devops-api} tenant operations
46
46
47
-
The following examples demonstrate how to use the {product} DevOps API to manage {product} resources.
47
+
The following examples demonstrate how to use the {product} {devops-api} to manage {product} resources.
Copy file name to clipboardExpand all lines: modules/apis/pages/index.adoc
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,11 @@
4
4
5
5
You use two APIs to manage {pulsar-reg} tenants and their resources.
6
6
7
-
== {product}DevOps API
7
+
== {product}{devops-api}
8
8
9
-
Use the xref:astra-streaming:apis:attachment$devops.html[{product} DevOps API] to manage higher-level objects associated with your account, 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 {astra-db} organization, such as the change data capture (CDC) settings, {pulsar-short} tenants, geo-replications, {pulsar-short} stats, and {pulsar-short} tokens.
10
10
11
-
This API uses an {astra_db} application token for authentication.
11
+
This API uses an {astra-db} application token for authentication.
:description: {astra_cli} provides a one-stop shop for managing your Astra resources through scripts or commands in your local terminal.
1
+
= {astra-cli} overview
2
+
:navtitle: {astra-cli}
3
+
:description: {astra-cli} provides a one-stop shop for managing your Astra resources through scripts or commands in your local terminal.
4
4
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[{astra-db} Command-Line Interface ({astra-cli})] is a set of commands you can use to create and manage {astra-db} and {product} resources:
6
6
7
-
* Creation and management of {astra_db} databases, {astra_stream} tenants, and their associated artifacts.
7
+
* Creation and management of {astra-db} databases, {astra_stream} tenants, and their associated artifacts.
8
8
* Querying and data loading.
9
9
* Organization and user management.
10
10
* Security and token configuration.
11
11
12
-
{astra_cli} commands are available for {astra_db} and {astra_stream}.
12
+
{astra-cli} commands are available for {astra-db} and {astra_stream}.
13
13
They're designed to get you working quickly, with an emphasis on automation.
14
14
15
15
For example, the following command creates an {pulsar-reg} tenant:
:description: CDC for {astra_db} automatically captures changes in real time, de-duplicates the changes, and streams the clean set of changed data
2
+
:description: CDC for {astra-db} automatically captures changes in real time, de-duplicates the changes, and streams the clean set of changed data
3
3
4
4
[IMPORTANT]
5
5
====
6
-
Enabling CDC for {astra_db} databases incurs billed charges based on your {product} usage.
6
+
Enabling CDC for {astra-db} databases incurs billed charges based on your {product} usage.
7
7
See https://www.datastax.com/pricing/astra-streaming[{product} pricing] and https://www.datastax.com/products/datastax-astra/cdc-for-astra-db[CDC metering rates].
8
8
====
9
9
10
-
CDC for {astra_db} automatically captures changes in real time, de-duplicates the changes, and streams the clean set of changed data into {product} where it can be processed by client applications or sent to downstream systems.
10
+
CDC for {astra-db} automatically captures changes in real time, de-duplicates the changes, and streams the clean set of changed data into {product} where it can be processed by client applications or sent to downstream systems.
11
11
12
12
{product} processes data changes via an {pulsar-reg} topic. By design, the Change Data Capture (CDC) component is simple, with a 1:1 correspondence between the table and a single {pulsar-short} topic.
13
13
14
-
For instructions and more information about CDC for {astra_db}, see xref:astra-db-serverless:databases:change-data-capture.adoc[].
14
+
For instructions and more information about CDC for {astra-db}, see xref:astra-db-serverless:databases:change-data-capture.adoc[].
0 commit comments