From e2623c54696f2c8abf7f5663f3ed9251ceaad488 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 13 Jan 2026 15:48:49 -0800 Subject: [PATCH 1/2] add a basic tenant operations page --- modules/ROOT/nav.adoc | 16 +- .../pages/astream-georeplication.adoc | 25 ++- .../pages/create-delete-tenants.adoc | 153 ++++++++++++++++++ 3 files changed, 174 insertions(+), 20 deletions(-) create mode 100644 modules/operations/pages/create-delete-tenants.adoc diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index e583dcd..743b964 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -29,31 +29,33 @@ * xref:streaming-learning:pulsar-io:connectors/index.adoc[IO connectors] .Operations +* xref:operations:create-delete-tenants.adoc[] * xref:operations:astream-limits.adoc[] -* xref:operations:astream-pricing.adoc[] * xref:operations:astream-regions.adoc[] * xref:operations:astream-georeplication.adoc[] -* xref:developing:astra-cli.adoc[] * Monitor streaming tenants ** xref:operations:monitoring/index.adoc[] ** xref:operations:astream-scrape-metrics.adoc[] ** xref:operations:monitoring/integration.adoc[] ** xref:operations:monitoring/new-relic.adoc[] -** xref:operations:monitoring/stream-audit-logs.adoc[] ** Grafana dashboards *** xref:operations:monitoring/metrics.adoc[] *** xref:operations:monitoring/overview-dashboard.adoc[] *** xref:operations:monitoring/namespace-dashboard.adoc[] *** xref:operations:monitoring/topic-dashboard.adoc[] -* Administration -** xref:operations:astream-token-gen.adoc[] -** xref:operations:private-connectivity.adoc[] -** xref:ROOT:astream-org-permissions.adoc[] + +.Administration +* xref:operations:astream-token-gen.adoc[] +* xref:operations:private-connectivity.adoc[] +* xref:ROOT:astream-org-permissions.adoc[] +* xref:operations:astream-pricing.adoc[] +* xref:operations:monitoring/stream-audit-logs.adoc[] .API references * xref:apis:index.adoc[] * xref:developing:using-curl.adoc[] * xref:apis:api-operations.adoc[] +* xref:developing:astra-cli.adoc[] .Frequently asked questions * xref:ROOT:astream-faq.adoc[] diff --git a/modules/operations/pages/astream-georeplication.adoc b/modules/operations/pages/astream-georeplication.adoc index 3bfbf5e..d306084 100644 --- a/modules/operations/pages/astream-georeplication.adoc +++ b/modules/operations/pages/astream-georeplication.adoc @@ -32,25 +32,24 @@ 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, click **Namespaces and Topics** to view a list of your tenant's current namespaces and topics. +. In your {product} tenant, click the **Namespaces and Topics** tab. -. Select **Modify namespace** in the namespace you want to replicate *from*. +. Find the namespace that you want to use as the origin of the replicated data, and then click **Modify Namespace**. -. Select Replication, and select **Add Region**. +. Click the **Replication** tab, and then click **Add Region**. -. Select the **Cloud Provider** and **Region** you want to replicate *to*, and select **Create Replication**. +. Select the target **Cloud Provider** and **Region** where you want to send the replicated data. -. The new replication is created: - -* A new streaming tenant is replicated in the selected region and provider. - -* The new replication's *Provider*, *Region*, and *Replication Direction* are listed in **Namespace Replication*. - -* The **Replication direction** value can be **Replicate to**, **Replicate from**, or **Bidirectional**. +. Click **Create Replication** to create the replica: ++ +* A new streaming tenant is created in the selected provider and region. +* All existing data from the original namespace is duplicated to the replica, and replication is maintained going forward. +* The replica's *Provider*, *Region*, and *Replication Direction* are listed under each namespace's **Replication** tab. +* The **Replication direction** can be **Replicate to**, **Replicate from**, or **Bidirectional**. -To control retention, backlog, and schema policies, visit the **Settings** tab. +To control retention, backlog, and schema policies, go to the namespace's **Settings** tab. -To disable replication on a namespace, select **Disable Replication**. +To disable replication on a namespace, click **Disable Replication**. [#test] == Test georeplicated clusters diff --git a/modules/operations/pages/create-delete-tenants.adoc b/modules/operations/pages/create-delete-tenants.adoc new file mode 100644 index 0000000..f4c700d --- /dev/null +++ b/modules/operations/pages/create-delete-tenants.adoc @@ -0,0 +1,153 @@ += Create and manage {product} tenants +:navtitle: Manage tenants, namespaces, and topics + +This page explains how to create and delete {product} streaming tenants programmatically and in the {astra-ui}. + +[TIP] +==== +If you're new to {product}, try the xref:getting-started:index.adoc[{product} quickstart] to learn about creating tenants, namespaces, and topics. +==== + +== Create a tenant + +[tabs] +====== +{astra-ui}:: ++ +-- +. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*. + +. Click *Create tenant*. + +. Enter a name for the streaming tenant. + +. Select a xref:astra-streaming:operations:astream-regions.adoc[cloud provider and region that supports {astra-stream}]. ++ +Not all {astra-db} regions support {product}. +If your preferred region isn't available, contact your {company} account representative or {support_url}[{company} Support]. + +. Click *Create tenant*. ++ +-- + +API:: ++ +-- +Use `xref:apis:api-operations.adoc#create-a-tenant[POST 'https://api.astra.datastax.com/v2/streaming/tenants']`. +-- + +CLI:: ++ +-- +Use `xref:astra-cli:commands:astra-streaming-create.adoc[astra streaming create]`. +-- +====== + +== View and edit a tenant, namespace, or topic + +After you create a tenant, you can inspect the tenant, create and manage namespaces and topics, and configure tenant settings. + +=== Get tenant information + +[tabs] +====== +{astra-ui}:: ++ +-- +. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*. + +. Click the name of your tenant. + +. Click any of the tabs to access tenant information and settings, such as **Connect** or **Sinks**. +-- + +API:: ++ +-- +Use `xref:apis:api-operations.adoc#get-tenant-information[GET 'https://api.astra.datastax.com/v2/streaming/tenants']`. +-- + +CLI:: ++ +-- +Use `xref:astra-cli:commands:astra-streaming-get.adoc[astra streaming get]`. +-- +====== + +=== Manage namespaces + +[tabs] +====== +{astra-ui}:: ++ +-- +. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*. + +. Click the name of your tenant, and then click the *Namespace And Topics* tab to manage namespaces: ++ +* **Create a namespace**: Click *Create Namespace*, enter a namespace name, and then click *Create Namespace*. +* **Configure replication**: See xref:operations:astream-georeplication.adoc[]. +* **Delete a namespace**: Find the namespace you want to delete, click **Modify Namespace**, find the **Delete This Namespace** section, and then click *Delete Namespace*. +* **Return to all namespaces**: When modifying an individual namespace, click **Back to Namespaces** to return to the list of all namespaces in the current tenant. +-- + +API:: ++ +-- +See xref:apis:api-operations.adoc#pulsar-api-namespace-operations[Pulsar Admin API namespace operations]. +-- +====== + +=== Manage topics + + +[tabs] +====== +{astra-ui}:: ++ +-- +. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*. + +. Click the name of your tenant, and then click the *Namespace And Topics* tab to manage topics: ++ +* **Create a topic**: Find the namespace where you want to create the topic, click *Add Topic*, enter a topic name, and then click *Add Topic*. +* **Inspect and configure a topic**: Click icon:chevron-down[name="Expand"] to view the list of topics in a specific namespace, click the name of the topic you want to manage, and then use the tabs to access the topic's information and settings, such as **Subscriptions** and **Consumers**. +* **Delete a topic**: Click icon:chevron-down[name="Expand"] to view the list of topics in a specific namespace, find the topic you want to delete, click icon:ellipsis[name="More"], and then select *Delete Topic*. +-- + +API:: ++ +-- +See xref:apis:api-operations.adoc#pulsar-admin-api-topic-operations[Pulsar Admin API topic operations]. +-- +====== + +== Terminate a tenant + +[WARNING] +==== +Terminating a tenant is a destructive operation that permanently deletes the tenant and all associated sinks, topics, messages, and namespaces. +==== + +[tabs] +====== +{astra-ui}:: ++ +-- +. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*. + +. Find the tenant that you want to delete, click icon:ellipsis-vertical[name="More"], and then select **Terminate**. +-- + +API:: ++ +-- +Use `xref:apis:api-operations.adoc#delete-a-tenant[DELETE 'https://api.astra.datastax.com/v2/streaming/tenants/**TENANT_NAME**/clusters/**CLUSTER_NAME**']`. +-- + +CLI:: ++ +-- +Use `xref:astra-cli:commands:astra-streaming-delete.adoc[astra streaming delete]`. +-- +====== \ No newline at end of file From 9d811b80d8c5b5a3dc94896e06667efa31ac80d8 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 13 Jan 2026 16:00:30 -0800 Subject: [PATCH 2/2] edit title and intro --- modules/operations/pages/create-delete-tenants.adoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/modules/operations/pages/create-delete-tenants.adoc b/modules/operations/pages/create-delete-tenants.adoc index f4c700d..fe8c7d2 100644 --- a/modules/operations/pages/create-delete-tenants.adoc +++ b/modules/operations/pages/create-delete-tenants.adoc @@ -1,7 +1,9 @@ -= Create and manage {product} tenants += Create and manage {product} tenants, namespaces, and topic :navtitle: Manage tenants, namespaces, and topics -This page explains how to create and delete {product} streaming tenants programmatically and in the {astra-ui}. +This page summarizes how to create, view, edit, and delete {product} streaming tenants, namespaces, and topics. +The primary actions can be performed programmatically and in the {astra-ui}. +However, some details are available in the {astra-ui} only. [TIP] ====