Skip to content

Commit 72455f0

Browse files
committed
remove tabs in prep for migration
1 parent 803f8e5 commit 72455f0

File tree

8 files changed

+112
-240
lines changed

8 files changed

+112
-240
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
2+
3+
. Click the name of the tenant where you want to deploy a function.
4+
5+
. On the *Functions* tab, click *Create Function*.
6+
7+
. Enter a function name.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
. Select the namespace and one or more input topics for the function.
2+
3+
. If needed, select an output namespace and topics.
4+
+
5+
Whether you need to specify an output topic depends on the function's logic.
6+
For example, the `cast` xref:developing:astream-functions-transform.adoc[transform function] needs an output topic to receive the transformed messages.
7+
8+
. Optional: Select a log topic.
9+
+
10+
The log topic is a separate output topic for messages containing additional `loglevel`, `fqn`, and `instance` properties.
11+
12+
. Optional: Configure advanced settings:
13+
+
14+
* *Instances*: Enter a number of sink instances to run.
15+
* *Processing Guarantee*: Select one of the following:
16+
** *ATLEAST_ONCE* (default): Each message sent to the function can be processed one or more times.
17+
** *ATMOST_ONCE*: Each message sent to the function is processed 0 or 1 times.
18+
This means there is a change that a message is not processed.
19+
** *EFFECTIVELY_ONCE*: Each message sent to the function has only one output associated with it.
20+
* *Timeout*: Set a timeout limit.
21+
* *Auto Acknowledge*: Enable or disable automatic message acknowledgment.
22+
23+
. If needed, provide a JSON-formatted config key for your function.
24+
This configuration depends on your function code.
25+
26+
. Click *Create*.
27+
28+
. Confirm your function was created on the *Functions* tab.
29+
+
30+
You can also verify the function deployment with the {pulsar-short} CLI:
31+
+
32+
[source,shell]
33+
----
34+
./bin/pulsar-admin functions list --tenant $TENANT
35+
----
36+
37+
Once created, the function starts processing messages from the input topics according to its logic.

modules/apis/pages/index.adoc

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -400,33 +400,26 @@ eyJhbGciOiJSUzI1NiIsI...
400400
Create a new {pulsar-short} token (JWT) for a given tenant and cluster.
401401
You can get the cluster name from <<get-tenant-details>>.
402402

403-
[tabs]
404-
======
405403
v2 endpoint::
406-
+
407-
--
408404
The `v2/streaming/tenants/$TENANT/tokens` endpoint returns a raw string JWT with an unlimited lifetime:
409-
405+
+
410406
[source,curl]
411407
----
412408
curl -sS --fail -L -X POST "https://api.astra.datastax.com/v2/streaming/tenants/$TENANT/tokens" \
413409
--header "Authorization: Bearer $ASTRA_TOKEN" \
414410
--header "X-DataStax-Pulsar-Cluster: $CLUSTER"
415411
----
416-
412+
+
417413
.Result
418414
[source,json]
419415
----
420416
Output: new raw string JWT
421417
eyJhbGciOiJSUzI1NiIsI...
422418
----
423-
--
424419

425420
v3 endpoint::
426-
+
427-
--
428421
The `v3/streaming/tenants/$TENANT/tokens` endpoint returns a JSON response and accepts additional token parameters:
429-
422+
+
430423
[source,curl,subs="+quotes"]
431424
----
432425
curl -sS --fail -L -X POST "https://api.astra.datastax.com/v3/streaming/tenants/$TENANT/tokens" \
@@ -438,13 +431,13 @@ curl -sS --fail -L -X POST "https://api.astra.datastax.com/v3/streaming/tenants/
438431
"type": "**TYPE**"
439432
}'
440433
----
441-
434+
+
442435
Replace the following:
443-
436+
+
444437
* **`EXPIRATION`**: The token lifetime expressed as a number and unit, such as `1d` for one day.
445438
* **`ROLE`**: A string describing the token's role.
446439
* **`TYPE`**: The token's privilege level, either `admin` or `non-admin`.
447-
440+
+
448441
.Result
449442
[source,json]
450443
----
@@ -454,8 +447,6 @@ Replace the following:
454447
"token": "eyJhbGciOiJSUzI1NiIsI..."
455448
}
456449
----
457-
--
458-
======
459450

460451
=== Delete a {pulsar-short} token
461452

modules/developing/pages/astream-cdc.adoc

Lines changed: 25 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -269,11 +269,7 @@ After you <<create-tenant,create a tenant>> and <<create-table,create tables>>,
269269

270270
For <<multi-region-cdc,multi-region databases>>, you must use the xref:astra-db-serverless:api-reference:devops-api.adoc[{product-short} {devops-api}] to enable CDC in secondary regions.
271271

272-
[tabs]
273-
======
274-
{astra-ui}::
275-
+
276-
--
272+
==== Enable CDC in the {astra-ui}::
277273
. In the {astra-ui}, click the name of the database where you want to enable CDC.
278274
+
279275
If you created the demo table in <<create-table>>, select the database where you created that table.
@@ -291,11 +287,9 @@ If you created the demo table in <<create-table>>, select the database where you
291287
Enabling CDC on any table disables the *Add a region* functionality in the {astra-ui} for that database.
292288
You must use the {product-short} {devops-api} to add a region after enabling CDC.
293289
====
294-
--
295290

296-
{product-short} {devops-api}::
297-
+
298-
--
291+
==== Enable CDC with the {product-short} {devops-api}
292+
299293
[IMPORTANT]
300294
====
301295
CDC for multi-region {astra-db} {db-serverless-vector} databases is available only to qualified participants in this private preview release.
@@ -307,10 +301,9 @@ If you're interested in this private preview feature, contact your {company} acc
307301

308302
Use the {product-short} {devops-api} to enable CDC on one or more tables in the same database in the same request.
309303

310-
You can use these endpoints to enable CDC in single-region and multi-region databases.
304+
You can use the following endpoints to enable CDC in single-region and multi-region databases.
305+
To check the CDC configuration for a database or table, see <<get-cdc>>.
311306

312-
[tabs]
313-
====
314307
Enable CDC after deploying a region::
315308
+
316309
Use these steps to enable CDC in a single-region database or in previously-deployed regions of a multi-region database.
@@ -431,11 +424,8 @@ The tenant must be in the same region as specified in `region`.
431424
+
432425
All tables replicated to the new region automatically have CDC enabled.
433426
The `astracdc` namespace and CDC topics for each table are created in the specified regional tenant.
434-
====
435427

436-
To check the CDC configuration for a database or table, see <<get-cdc>>.
437-
--
438-
======
428+
==== CDC topics
439429

440430
When you enable CDC on a database for the first time, {astra-db} automatically creates an `astracdc` namespace in your streaming tenant.
441431
For each table where you enable CDC, {astra-db} creates two topics in the `astracdc` namespace:
@@ -789,23 +779,16 @@ However, be aware of the following limitations:
789779

790780
You can check your active CDC configurations in the {astra-ui} or with the {product-short} {devops-api}.
791781

792-
[tabs]
793-
======
794-
{astra-ui}::
795-
+
796-
--
782+
=== Check CDC status in the {astra-ui}
783+
797784
. In the {astra-ui}, click the name of the database that you want to inspect.
798785

799786
. Click the *CDC* tab, and then review the list of tables where you have enabled CDC.
800787

801788
. Click a table's name to inspect the table's CDC configuration.
802-
--
803789

804-
{product-short} {devops-api}::
805-
+
806-
--
807-
[tabs]
808-
====
790+
=== Check CDC status with the {product-short} {devops-api}
791+
809792
By database::
810793
+
811794
Use `{devops-api-ref-url}#tag/Database-Operations/operation/getCDC[GET /v3/databases/**DB_ID**/cdc]` to get CDC configuration details for an entire database:
@@ -889,9 +872,6 @@ For multi-region databases with CDC enabled in multiple regions, the `regions` a
889872
}
890873
]
891874
----
892-
====
893-
--
894-
======
895875

896876
[#put-cdc]
897877
=== Update a database's CDC configuration
@@ -1036,23 +1016,30 @@ CDC is automatically disabled if you drop a table, terminate a database, or remo
10361016
You can remove a table's CDC configuration without deleting the table.
10371017
For multi-region databases, this disables CDC for the table across all regions.
10381018

1039-
[tabs]
1040-
======
1041-
{astra-ui}::
1019+
Disabling CDC doesn't remove the associated namespace, topics, or {astra-stream} tenant:
1020+
1021+
* If you reenable CDC for the same table, the existing topics are reused with the existing records.
1022+
1023+
* If you want to discard a table's CDC records, you must manually remove the associated {astra-stream} artifacts after disabling CDC:
10421024
+
1043-
--
1025+
** If you remove CDC from a table, then you can delete the table's `data-` and `log-` topics from the `astracdc` namespace in the {astra-stream} tenant.
1026+
For multi-region databases, make sure that you delete the topics in the tenant for each region where the database is deployed
1027+
** If you remove CDC from all tables in a region, and you no longer need CDC in that region, then you can delete the `astracdc` namespace from the {astra-stream} tenant in that region.
1028+
Deleting the namespace also deletes the topics within that namespace.
1029+
** If you remove CDC from all of a database's tables, and you no longer need an {astra-stream} tenant for any reason, you can delete the entire tenant.
1030+
1031+
==== Disable CDC with the {astra-ui}
1032+
10441033
. In the {astra-ui}, click the name of the database where you want to disable CDC.
10451034

10461035
. Click the *CDC* tab.
10471036

10481037
. In the *Change Data Capture* list, click the table's name.
10491038

10501039
. Click *Disable* to remove the table's CDC configuration.
1051-
--
10521040

1053-
{product-short} {devops-api}::
1054-
+
1055-
--
1041+
==== Disable CDC with the {product-short} {devops-api}::
1042+
10561043
Use `{devops-api-ref-url}#tag/Database-Operations/operation/deleteCDC[DELETE /v3/databases/**DB_ID**/cdc]` to disable CDC for a table:
10571044

10581045
[source,curl,subs="+quotes"]
@@ -1083,20 +1070,6 @@ If you want to disable CDC for multiple tables at once, include an object for ea
10831070
You can use `PUT /v3/databases/**DB_ID**/cdc` to make multiple changes to a database's CDC configuration in one request, including additions, changes, and removals of tables and regions.
10841071
For more information, see <<put-cdc>>.
10851072
====
1086-
--
1087-
======
1088-
1089-
Disabling CDC doesn't remove the associated namespace, topics, or {astra-stream} tenant:
1090-
1091-
* If you reenable CDC for the same table, the existing topics are reused with the existing records.
1092-
1093-
* If you want to discard a table's CDC records, you must manually remove the associated {astra-stream} artifacts after disabling CDC:
1094-
+
1095-
** If you remove CDC from a table, then you can delete the table's `data-` and `log-` topics from the `astracdc` namespace in the {astra-stream} tenant.
1096-
For multi-region databases, make sure that you delete the topics in the tenant for each region where the database is deployed
1097-
** If you remove CDC from all tables in a region, and you no longer need CDC in that region, then you can delete the `astracdc` namespace from the {astra-stream} tenant in that region.
1098-
Deleting the namespace also deletes the topics within that namespace.
1099-
** If you remove CDC from all of a database's tables, and you no longer need an {astra-stream} tenant for any reason, you can delete the entire tenant.
11001073

11011074
== See also
11021075

0 commit comments

Comments
 (0)