|
| 1 | += Create and manage {product} tenants, namespaces, and topic |
| 2 | +:navtitle: Manage tenants, namespaces, and topics |
| 3 | + |
| 4 | +This page summarizes how to create, view, edit, and delete {product} streaming tenants, namespaces, and topics. |
| 5 | +The primary actions can be performed programmatically and in the {astra-ui}. |
| 6 | +However, some details are available in the {astra-ui} only. |
| 7 | + |
| 8 | +[TIP] |
| 9 | +==== |
| 10 | +If you're new to {product}, try the xref:getting-started:index.adoc[{product} quickstart] to learn about creating tenants, namespaces, and topics. |
| 11 | +==== |
| 12 | + |
| 13 | +== Create a tenant |
| 14 | + |
| 15 | +[tabs] |
| 16 | +====== |
| 17 | +{astra-ui}:: |
| 18 | ++ |
| 19 | +-- |
| 20 | +. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*. |
| 21 | +
|
| 22 | +. Click *Create tenant*. |
| 23 | +
|
| 24 | +. Enter a name for the streaming tenant. |
| 25 | +
|
| 26 | +. Select a xref:astra-streaming:operations:astream-regions.adoc[cloud provider and region that supports {astra-stream}]. |
| 27 | ++ |
| 28 | +Not all {astra-db} regions support {product}. |
| 29 | +If your preferred region isn't available, contact your {company} account representative or {support_url}[{company} Support]. |
| 30 | +
|
| 31 | +. Click *Create tenant*. |
| 32 | ++ |
| 33 | +-- |
| 34 | +
|
| 35 | +API:: |
| 36 | ++ |
| 37 | +-- |
| 38 | +Use `xref:apis:api-operations.adoc#create-a-tenant[POST 'https://api.astra.datastax.com/v2/streaming/tenants']`. |
| 39 | +-- |
| 40 | +
|
| 41 | +CLI:: |
| 42 | ++ |
| 43 | +-- |
| 44 | +Use `xref:astra-cli:commands:astra-streaming-create.adoc[astra streaming create]`. |
| 45 | +-- |
| 46 | +====== |
| 47 | + |
| 48 | +== View and edit a tenant, namespace, or topic |
| 49 | + |
| 50 | +After you create a tenant, you can inspect the tenant, create and manage namespaces and topics, and configure tenant settings. |
| 51 | + |
| 52 | +=== Get tenant information |
| 53 | + |
| 54 | +[tabs] |
| 55 | +====== |
| 56 | +{astra-ui}:: |
| 57 | ++ |
| 58 | +-- |
| 59 | +. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*. |
| 60 | +
|
| 61 | +. Click the name of your tenant. |
| 62 | +
|
| 63 | +. Click any of the tabs to access tenant information and settings, such as **Connect** or **Sinks**. |
| 64 | +-- |
| 65 | +
|
| 66 | +API:: |
| 67 | ++ |
| 68 | +-- |
| 69 | +Use `xref:apis:api-operations.adoc#get-tenant-information[GET 'https://api.astra.datastax.com/v2/streaming/tenants']`. |
| 70 | +-- |
| 71 | +
|
| 72 | +CLI:: |
| 73 | ++ |
| 74 | +-- |
| 75 | +Use `xref:astra-cli:commands:astra-streaming-get.adoc[astra streaming get]`. |
| 76 | +-- |
| 77 | +====== |
| 78 | + |
| 79 | +=== Manage namespaces |
| 80 | + |
| 81 | +[tabs] |
| 82 | +====== |
| 83 | +{astra-ui}:: |
| 84 | ++ |
| 85 | +-- |
| 86 | +. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*. |
| 87 | +
|
| 88 | +. Click the name of your tenant, and then click the *Namespace And Topics* tab to manage namespaces: |
| 89 | ++ |
| 90 | +* **Create a namespace**: Click *Create Namespace*, enter a namespace name, and then click *Create Namespace*. |
| 91 | +* **Configure replication**: See xref:operations:astream-georeplication.adoc[]. |
| 92 | +* **Delete a namespace**: Find the namespace you want to delete, click **Modify Namespace**, find the **Delete This Namespace** section, and then click *Delete Namespace*. |
| 93 | +* **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. |
| 94 | +-- |
| 95 | +
|
| 96 | +API:: |
| 97 | ++ |
| 98 | +-- |
| 99 | +See xref:apis:api-operations.adoc#pulsar-api-namespace-operations[Pulsar Admin API namespace operations]. |
| 100 | +-- |
| 101 | +====== |
| 102 | + |
| 103 | +=== Manage topics |
| 104 | + |
| 105 | + |
| 106 | +[tabs] |
| 107 | +====== |
| 108 | +{astra-ui}:: |
| 109 | ++ |
| 110 | +-- |
| 111 | +. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*. |
| 112 | +
|
| 113 | +. Click the name of your tenant, and then click the *Namespace And Topics* tab to manage topics: |
| 114 | ++ |
| 115 | +* **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*. |
| 116 | +* **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**. |
| 117 | +* **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*. |
| 118 | +-- |
| 119 | +
|
| 120 | +API:: |
| 121 | ++ |
| 122 | +-- |
| 123 | +See xref:apis:api-operations.adoc#pulsar-admin-api-topic-operations[Pulsar Admin API topic operations]. |
| 124 | +-- |
| 125 | +====== |
| 126 | + |
| 127 | +== Terminate a tenant |
| 128 | + |
| 129 | +[WARNING] |
| 130 | +==== |
| 131 | +Terminating a tenant is a destructive operation that permanently deletes the tenant and all associated sinks, topics, messages, and namespaces. |
| 132 | +==== |
| 133 | + |
| 134 | +[tabs] |
| 135 | +====== |
| 136 | +{astra-ui}:: |
| 137 | ++ |
| 138 | +-- |
| 139 | +. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*. |
| 140 | +
|
| 141 | +. Find the tenant that you want to delete, click icon:ellipsis-vertical[name="More"], and then select **Terminate**. |
| 142 | +-- |
| 143 | +
|
| 144 | +API:: |
| 145 | ++ |
| 146 | +-- |
| 147 | +Use `xref:apis:api-operations.adoc#delete-a-tenant[DELETE 'https://api.astra.datastax.com/v2/streaming/tenants/**TENANT_NAME**/clusters/**CLUSTER_NAME**']`. |
| 148 | +-- |
| 149 | +
|
| 150 | +CLI:: |
| 151 | ++ |
| 152 | +-- |
| 153 | +Use `xref:astra-cli:commands:astra-streaming-delete.adoc[astra streaming delete]`. |
| 154 | +-- |
| 155 | +====== |
0 commit comments