Skip to content

Commit 7433661

Browse files
authored
DOC-4942 - Astra FTUX for Astra Streaming docs (#145)
* ftux for streaming docs * fix icons
1 parent 01de7bf commit 7433661

13 files changed

Lines changed: 79 additions & 35 deletions

modules/developing/pages/astream-functions.adoc

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,9 @@ See <<controlling-your-function,Controlling your function>> for more information
287287

288288
== Deploy functions in the {astra-ui}
289289

290-
. In the {astra-ui} navigation menu, click *Streaming*, and then click the name of the tenant where you want to deploy a function.
290+
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
291+
292+
. Click the name of the tenant where you want to deploy a function.
291293

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

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

394-
In the {astra-ui}, on your tenant's *Functions* tab, you can use *Function Controls* to start, stop, and restart functions.
396+
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
397+
398+
. Click the name of the tenant where you want to manage functions, and then click the *Functions* tab.
399+
400+
. Use *Function Controls* to start, stop, and restart functions.
395401

396402
=== Monitor functions
397403

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

401-
image::astream-function-log.png[Function Log]
406+
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
407+
408+
. Click the name of the tenant that you want to debug, and then click the *Functions* tab.
402409

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

405416
=== Edit functions
406417

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

409-
. Edit the following settings as needed, and then click *Update*.
420+
. Click the name of the tenant where your function is deployed, and then click the *Functions* tab.
421+
422+
. Click *Update Function*, edit the following settings as needed, and then click *Update*:
410423
+
411424
* Function code
412425
* Output topic
@@ -423,8 +436,10 @@ If you need to change any other function settings, you must delete and redeploy
423436
Deleting a function is permanent.
424437
====
425438

426-
. In the {astra-ui}, on your tenant's *Functions* tab, select the function to delete.
439+
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
440+
441+
. Click the name of the tenant where you want to delete a function, and then click the *Functions* tab.
427442

428-
. Click *Delete*.
443+
. Click the function you want to delete, and then click *Delete*.
429444

430445
. To confirm deletion, enter the function's name, and then click *Delete*.

modules/developing/pages/clients/spring-produce-consume.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,9 @@ Message received: Hello World
101101
----
102102
====
103103

104-
. 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.
104+
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
105+
106+
. Click the name of your tenant, and then verify that the message appears in the specified namespace and topic.
105107

106108
== See also
107109

modules/developing/pages/configure-pulsar-env.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@ The executables in `/bin` use the configurations in `/conf` to run commands.
4444
Each tenant you create in {product} comes with its own custom configuration for SSO, endpoints, and so on.
4545
You must download the tenant configuration from {product}, and then overwrite the `./conf/client.conf` file.
4646

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

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

modules/developing/pages/gpt-schema-translator.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ The {gpt-schema-translator} is available for the {astra-db} sink connector only.
2323
This example uses a JSON schema for a {pulsar-short} topic, and a CQL schema for an {astra-db} table.
2424
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.
2525

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

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

modules/developing/pages/produce-consume-astra-portal.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ The following steps will use the "Try Me" feature of the {astra-ui} to interact
99

1010
== Select the producer and consumer topics
1111

12-
. Navigate to the "Try Me" tab.
13-
+
14-
image:try-me-tab.png[Try me tab in {product}]
12+
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
13+
14+
. Click the name of your tenant.
15+
16+
. Click the **Try Me** tab.
1517

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

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

modules/developing/pages/using-curl.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ Depending on the API you use, you need certain information to form HTTP requests
1212
1313
== Get the tenant web service URL
1414

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

1719
. Click the *Connect* tab.
1820

modules/developing/partials/client-variables-table.adoc

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,33 @@
44

55
|`serviceUrl`
66
|The URL to connect to the {pulsar-short} cluster
7-
|In the {astra-ui} navigation menu, click *Streaming*, and then click the name of your streaming tenant.
8-
On the *Connect* tab, in the *Tenant Details* section, get the *Broker Service URL*.
7+
a|
8+
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
9+
. Click the name of your tenant, and then click the *Connect* tab.
10+
. In the *Tenant Details* section, get the *Broker Service URL*.
911

1012
|`pulsarToken`
1113
|The token for {pulsar-short} cluster authentication
1214
|For information about creating {pulsar-short} tokens, see xref:operations:astream-token-gen.adoc[].
1315

1416
|`tenantName`
1517
|The name of your streaming tenant
16-
|In the {astra-ui} navigation menu, click *Streaming*, and then get the name from the *Tenants* list.
18+
a|
19+
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
20+
. Get the name from the *Tenants* list.
1721

1822
|`namespace`
1923
|The segmented area for certain topics in your streaming tenant
20-
|In the {astra-ui} navigation menu, click *Streaming*, click the name of your streaming tenant, and then click the *Namespace and Topics* tab.
21-
Choose the target namespace from the list of namespaces.
24+
a|
25+
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
26+
. Click the name of your tenant, and then click the *Namespace and Topics* tab.
27+
. Choose the target namespace from the list of namespaces.
2228

2329
|`topicName`
2430
|Topic name (not the full name)
25-
|In the {astra-ui} navigation menu, click *Streaming*, click the name of your streaming tenant, and then click the *Namespace and Topics* tab.
26-
Expand the target namespace in the list of namespaces to view the names of the topics within.
31+
a|
32+
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
33+
. Click the name of your tenant, and then click the *Namespace and Topics* tab.
34+
. Expand the target namespace in the list of namespaces to view the names of the topics within.
2735
Do _not_ use the *Full Name*.
2836
|===

modules/getting-started/pages/index.adoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To learn more about the concept of tenancy, see the https://pulsar.apache.org/do
2020
You can create a tenant in the {astra-ui} or programmatically.
2121
For this quickstart, use the {astra-ui}.
2222

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

2525
. Click *Create a Tenant*.
2626

@@ -49,7 +49,9 @@ You can create namespaces in the {astra-ui} or programmatically.
4949
For this quickstart, use the {astra-ui}.
5050
For information about the {pulsar-short} CLI or APIs, see xref:developing:configure-pulsar-env.adoc[] and xref:developing:using-curl.adoc[].
5151

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

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

@@ -72,7 +74,9 @@ To learn more about topics, see the https://pulsar.apache.org/docs/concepts-mess
7274

7375
As in the previous steps, you can create topics in the {astra-ui} or programmatically.
7476

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

7781
. Click the *Namespace And Topics* tab.
7882

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

92-
* xref:developing:produce-consume-astra-portal.adoc[{astra-ui}]: Use {product}'s "Try Me" feature in the {astra-ui}.
96+
* xref:developing:produce-consume-astra-portal.adoc[{astra-ui}]: Use {product}'s **Try Me** feature in the {astra-ui}.
9397
* xref:developing:produce-consume-pulsar-client.adoc[{pulsar-short} Client]: Use the {pulsar-short} CLI to interact with the topic.
9498
* xref:developing:clients/index.adoc[Runtime Clients]: Create a client application that interacts with {pulsar-short}.

modules/operations/pages/astream-georeplication.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,9 @@ key:[null], properties:[], content:hello-from-pulsar
131131
key:[null], properties:[], content:hello-from-pulsar
132132
----
133133
134-
. In the {astra-ui} navigation menu, click *Streaming*, click the name of your tenant, and then click the **Namespaces and Topics** tab.
134+
. In the {astra-ui-link} header, click icon:grip[name="Applications"], and then select *Streaming*.
135+
136+
. Click the name of your tenant, and then click the **Namespaces and Topics** tab.
135137
136138
. Make sure `persistent://**TENANT_NAME**/**NAMESPACE_NAME**/**TOPIC_NAME**` is visible and shows traffic across all regions.
137139

modules/operations/pages/astream-scrape-metrics.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ This doc will show you how to scrape an {product} tenant with Prometheus.
1111

1212
== Get the configuration file from {product}
1313

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

16-
. On the *Connect* tab, click *Prometheus* to generate a new configuration file:
16+
. Click the name of your tenant, and then click the *Connect* tab.
17+
18+
. Click *Prometheus* to generate a new configuration file:
1719
+
1820
.prometheus.yml
1921
[source,yaml,subs="+quotes"]

0 commit comments

Comments
 (0)