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
31 changes: 23 additions & 8 deletions modules/developing/pages/astream-functions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,9 @@ 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 click the name of the tenant where you want to deploy a function.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click the name of the tenant where you want to deploy a function.

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

Expand Down Expand Up @@ -391,22 +393,33 @@ Your function should output the result of processing the message.
[#controlling-your-function]
=== Stop and start functions

In the {astra-ui}, on your tenant's *Functions* tab, you can use *Function Controls* to start, stop, and restart functions.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click the name of the tenant where you want to manage functions, and then click the *Functions* tab.

. Use *Function Controls* to start, stop, and restart functions.

=== Monitor functions

Functions produce logs to help you debug them.
In the {astra-ui}, on your tenant's *Functions* tab, you can view, refresh, copy, and download your functions' logs.

image::astream-function-log.png[Function Log]
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click the name of the tenant that you want to debug, and then click the *Functions* tab.

. From here, you can view, refresh, copy, and download your functions' logs.
+
image::astream-function-log.png[Function Log]
+
If you specified a log topic when deploying your function, function logs also output to that topic.

=== Edit functions

. In the {astra-ui}, on your tenant's *Functions* tab, click *Update Function*.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Edit the following settings as needed, and then click *Update*.
. Click the name of the tenant where your function is deployed, and then click the *Functions* tab.

. Click *Update Function*, edit the following settings as needed, and then click *Update*:
+
* Function code
* Output topic
Expand All @@ -423,8 +436,10 @@ If you need to change any other function settings, you must delete and redeploy
Deleting a function is permanent.
====

. In the {astra-ui}, on your tenant's *Functions* tab, select the function to delete.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click the name of the tenant where you want to delete a function, and then click the *Functions* tab.

. Click *Delete*.
. Click the function you want to delete, and then click *Delete*.

. To confirm deletion, enter the function's name, and then click *Delete*.
4 changes: 3 additions & 1 deletion modules/developing/pages/clients/spring-produce-consume.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,9 @@ Message received: Hello World
----
====

. 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.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click the name of your tenant, and then verify that the message appears in the specified namespace and topic.

== See also

Expand Down
4 changes: 3 additions & 1 deletion modules/developing/pages/configure-pulsar-env.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@ 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 click the name of your tenant.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click the name of your tenant.

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

Expand Down
4 changes: 3 additions & 1 deletion modules/developing/pages/gpt-schema-translator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +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 click the name of your tenant.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click the name of your tenant.

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

Expand Down
9 changes: 5 additions & 4 deletions modules/developing/pages/produce-consume-astra-portal.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ The following steps will use the "Try Me" feature of the {astra-ui} to interact

== Select the producer and consumer topics

. Navigate to the "Try Me" tab.
+
image:try-me-tab.png[Try me tab in {product}]
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click the name of your tenant.

. Click the **Try Me** tab.

. Choose the appropriate namespace and topic.
In this example, the name for both the producer and consumer is the same.
Expand All @@ -27,7 +29,6 @@ image:config-try-me.png[Config try me in {product}]
+
image:test-message-input.png[Send message in {product}]


A message is produced (sent) to your selected topic, and then the consumer consumes (retrieves) the message.
The result is a chat style write and read.

Expand Down
4 changes: 3 additions & 1 deletion modules/developing/pages/using-curl.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Depending on the API you use, you need certain information to form HTTP requests

== Get the tenant web service URL

. In the {astra-ui} navigation menu, click *Streaming*, and then click the name of your tenant.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click the name of your tenant.

. Click the *Connect* tab.

Expand Down
22 changes: 15 additions & 7 deletions modules/developing/partials/client-variables-table.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,33 @@

|`serviceUrl`
|The URL to connect to the {pulsar-short} cluster
|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*.
a|
. 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 *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*, and then get the name from the *Tenants* list.
a|
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
. 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*, click the name of your streaming tenant, and then click the *Namespace and Topics* tab.
Choose the target namespace from the list of namespaces.
a|
. 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.
. Choose the target namespace from the list of namespaces.

|`topicName`
|Topic name (not the full name)
|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.
a|
. 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.
. Expand the target namespace in the list of namespaces to view the names of the topics within.
Do _not_ use the *Full Name*.
|===
12 changes: 8 additions & 4 deletions modules/getting-started/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To learn more about the concept of tenancy, see the https://pulsar.apache.org/do
You can create a tenant in the {astra-ui} or programmatically.
For this quickstart, use the {astra-ui}.

. In the {astra-ui} navigation menu, click *Streaming*.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click *Create a Tenant*.

Expand Down Expand Up @@ -49,7 +49,9 @@ 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 click the name of your tenant.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click the name of your tenant.

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

Expand All @@ -72,7 +74,9 @@ 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 click the name of your tenant.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click the name of your tenant.

. Click the *Namespace And Topics* tab.

Expand All @@ -89,6 +93,6 @@ Disregard the https://pulsar.apache.org/docs/concepts-messaging/#partitioned-top
Your new topic is ready to produce and consume messages.
There are several different ways to do this:

* xref:developing:produce-consume-astra-portal.adoc[{astra-ui}]: Use {product}'s "Try Me" feature in the {astra-ui}.
* xref:developing:produce-consume-astra-portal.adoc[{astra-ui}]: Use {product}'s **Try Me** feature in the {astra-ui}.
* xref:developing:produce-consume-pulsar-client.adoc[{pulsar-short} Client]: Use the {pulsar-short} CLI to interact with the topic.
* xref:developing:clients/index.adoc[Runtime Clients]: Create a client application that interacts with {pulsar-short}.
4 changes: 3 additions & 1 deletion modules/operations/pages/astream-georeplication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,9 @@ key:[null], properties:[], content:hello-from-pulsar
key:[null], properties:[], content:hello-from-pulsar
----

. In the {astra-ui} navigation menu, click *Streaming*, click the name of your tenant, and then click the **Namespaces and Topics** tab.
. 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 **Namespaces and Topics** tab.

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

Expand Down
6 changes: 4 additions & 2 deletions modules/operations/pages/astream-scrape-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@ This doc will show you how to scrape an {product} tenant with Prometheus.

== Get the configuration file from {product}

. In the {astra-ui} navigation menu, click *Streaming*, and then click the name of your tenant.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. On the *Connect* tab, click *Prometheus* to generate a new configuration file:
. Click the name of your tenant, and then click the *Connect* tab.

. Click *Prometheus* to generate a new configuration file:
+
.prometheus.yml
[source,yaml,subs="+quotes"]
Expand Down
4 changes: 3 additions & 1 deletion modules/operations/pages/astream-token-gen.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ You need a {pulsar-short} JWT for actions related to {pulsar-short} tenants, nam

You can generate, copy, or delete {product} {pulsar-short} tokens for each of your {product} tenants:

. In the {astra-ui} navigation menu, click *Streaming*, and then click the name of the tenant for which you want to manage tokens.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click the name of your tenant where you want to manage tokens.

. Click the *Settings* tab.

Expand Down
8 changes: 5 additions & 3 deletions modules/operations/pages/monitoring/stream-audit-logs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To enable audit log streaming, you must do one of the following:
Audit log streaming requires a streaming tenant in the AWS `us-east-2` region.
You can create a new tenant with the xref:astra-streaming:getting-started:index.adoc[{product} quickstart] or use an existing {product} tenant.

. In the {astra-ui-link} navigation menu, click **Streaming**.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.

. Click the name of an existing tenant or create a streaming tenant in AWS `us-east-2`, and then create a namespace and topic in the tenant.
+
Expand All @@ -23,7 +23,7 @@ For more information about creating tenants, namespaces, and topics, see xref:as
. If necessary, create additional audit log topics, and then record the **Full Name** for each topic.
You can use topics to organize audit logs by event type or other criteria.

. In the {astra-ui-link} navigation menu, click **Streaming**, and then click the name of your audit log streaming tenant.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], select *Streaming*, and then click the name of your audit log streaming tenant.

. On the *Connect* tab, click **Download client.conf**.

Expand All @@ -37,7 +37,9 @@ You can use topics to organize audit logs by event type or other criteria.

You can use the {devops-api-ref-url}#tag/Organization-Operations/operation/configureTelemetry[{product-short} {devops-api} telemetry endpoint] to configure audit log streaming instead of providing the configuration details to {company} Support.

. In the {astra-ui-link}, create an xref:astra-db-serverless:administration:manage-application-tokens.adoc[{product-short} application token] with the **Organization Administrator** role.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Admin*.

. Click **Tokens**, and then create an xref:astra-db-serverless:administration:manage-application-tokens.adoc[{product-short} application token] with the **Organization Administrator** role.

. Create the audit log streaming configuration using the values from the tenant's `client.conf` file and your {pulsar-short} configuration:
+
Expand Down
2 changes: 1 addition & 1 deletion modules/operations/pages/private-connectivity.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To use a private link service or private endpoint for {product}, do the followin

. Get the name of the {product} clusters where you want to enable private connectivity.
+
In the {astra-ui-link}, click *Streaming*, and then find cluster names in the *Tenants* list.
. In the {astra-ui-link} header, click icon:grip[name="Applications"], select *Streaming*, and then find cluster names in the *Tenants* list.

. Get your cloud provider resource identifier:
+
Expand Down