Skip to content

Commit d827ff4

Browse files
authored
Update Console screenshots (#1473)
1 parent 9217a39 commit d827ff4

File tree

6 files changed

+31
-20
lines changed

6 files changed

+31
-20
lines changed
1.6 KB
Loading
28 KB
Loading

modules/console/images/topic.png

2.19 KB
Loading

modules/get-started/pages/quick-start.adoc

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,9 @@ include::test-resources:attachment$docker-compose/bootstrap.yml[]
132132
======
133133
<3> Start Docker Compose.
134134

135+
// (step {"runShell": {"command": "docker compose down -v", "workingDirectory": "../docker-compose", "timeout": 60000, "exitCodes": [0,1]}})
135136
// (step {"runShell": {"command": "docker pull docker.redpanda.com/redpandadata/${REDPANDA_DOCKER_REPO:-redpanda}:${REDPANDA_VERSION:-latest} && docker pull docker.redpanda.com/redpandadata/${CONSOLE_DOCKER_REPO:-console}:${REDPANDA_CONSOLE_VERSION:-latest}", "workingDirectory": "../docker-compose", "timeout": 100000, "exitCodes": [0,1]}})
136-
// (step {"runShell": {"command": "docker compose up -d --wait", "workingDirectory": "../docker-compose", "timeout": 100000, "exitCodes": [0]}})
137+
// (step {"runShell": {"command": "docker compose up -d --wait", "workingDirectory": "../docker-compose", "timeout": 150000, "exitCodes": [0]}})
137138
// (step {"wait": 20000})
138139

139140
When the containers are running, you have:
@@ -182,13 +183,13 @@ image::console:overview.png[]
182183
// (step {"wait": 30000})
183184
// (step {"goTo": "http://localhost:8080/overview"})
184185
// (step {"wait": 30000})
185-
// (step {"screenshot": {"path": "../../modules/console/images/overview.png", "overwrite": "aboveVariation", "maxVariation": 10}})
186+
// (step {"screenshot": {"path": "../../modules/console/images/overview.png", "overwrite": "always"}})
186187

187188
To view details about a specific broker, click *View* at the end of the row in the *Broker Details* table.
188189

189190
// (step {"find": {"selector": ".chakra-table tbody tr:last-child td:last-child button", "elementText": "View", "click": true}})
190191
// (step {"wait": 15000})
191-
// (step {"screenshot": {"path": "../../modules/console/images/broker-overview.png", "overwrite": "aboveVariation", "maxVariation": 10}})
192+
// (step {"screenshot": {"path": "../../modules/console/images/broker-overview.png", "overwrite": "always"}})
192193

193194
image::console:broker-overview.png[]
194195

@@ -212,12 +213,12 @@ Suppose you're asked to find all transactions related to the `.edu` domain. You
212213
// (step {"goTo": "http://localhost:8080/topics/transactions"})
213214
// (step {"wait": 5000})
214215
. Click *Add filter* > *JavaScript Filter*.
215-
// (step {"screenshot": {"path": "../../modules/console/images/topic.png", "overwrite": "aboveVariation", "maxVariation": 10}})
216+
// (step {"screenshot": {"path": "../../modules/console/images/topic.png", "overwrite": "always"}})
216217
// (step {"find": {"selector": "[data-testid='add-topic-filter']", "elementText": "Add filter", "click": true, "timeout": 10000}})
217218
// (step {"find": {"selector": "[data-testid='add-topic-filter-javascript']", "elementText": "JavaScript Filter", "click": true, "timeout": 10000}})
218219
. Give your filter a name, such as "Find .edu domains".
219220
// (step {"find": {"selector": "[data-testid='add-javascript-filter-name']", "click": true, "type": "Find .edu domains", "timeout": 10000}})
220-
// (step {"screenshot": {"path": "../../modules/console/images/js-filter.png", "overwrite": "aboveVariation", "maxVariation": 30}})
221+
// (step {"screenshot": {"path": "../../modules/console/images/js-filter.png", "overwrite": "always"}})
221222
+
222223
image::console:js-filter.png[]
223224

@@ -237,7 +238,7 @@ By default, the filter runs on the newest 50 messages. You can run the filter on
237238
// (step {"goTo": "http://localhost:8080/topics/transactions"})
238239
// (step {"find": {"selector": ".chakra-tabs__tablist button[data-index='5']", "elementText": "Documentation", "click": true, "timeout": 15000}})
239240
// (step {"wait": 15000})
240-
// (step {"screenshot": {"path": "../../modules/console/images/topic-documentation.png", "overwrite": "aboveVariation", "maxVariation": 10}})
241+
// (step {"screenshot": {"path": "../../modules/console/images/topic-documentation.png", "overwrite": "always"}})
241242

242243
See also: xref:console:ui/programmable-push-filters.adoc[].
243244

@@ -248,7 +249,7 @@ On the *Schema Registry* page, you see an overview of your schemas. You can crea
248249
// (step {"find": {"selector": "[data-testid='nav-link-Schema Registry']", "elementText": "Schema Registry", "click": true}})
249250
// (step {"goTo": "http://localhost:8080/schema-registry/subjects/transactions?version=latest"})
250251
// (step {"wait": 5000})
251-
// (step {"screenshot": {"path": "../../modules/console/images/schema-reg.png", "overwrite": "aboveVariation", "maxVariation": 10}})
252+
// (step {"screenshot": {"path": "../../modules/console/images/schema-reg.png", "overwrite": "always"}})
252253

253254
image::console:schema-reg.png[]
254255

@@ -283,7 +284,7 @@ Suppose you're onboarding a new team member who needs access to specific topics.
283284
// (step {"find": {"selector": "[data-testid='test_field']", "click": true}, "variables": {"password": "$$element.text"}})
284285
// (step {"find": {"selector": "[data-testid='password-input-toggle']", "click": true}})
285286
// (step {"wait": 5000})
286-
// (step {"screenshot": {"path": "../../modules/console/images/user.png", "overwrite": "aboveVariation", "maxVariation": 10}})
287+
// (step {"screenshot": {"path": "../../modules/console/images/user.png", "overwrite": "always"}})
287288
. Click *Create*.
288289

289290
image::console:user.png[]
@@ -391,7 +392,7 @@ In the menu, click *Transforms*.
391392

392393
On the *Transforms* page, you see your transform. You can use Redpanda Console to manage and monitor your transforms.
393394
// (step {"wait": 5000})
394-
// (step {"screenshot": { "path": "../../modules/console/images/transforms.png", "overwrite": "aboveVariation", "maxVariation": 10}})
395+
// (step {"screenshot": {"path": "../../modules/console/images/transforms.png", "overwrite": "always"}})
395396

396397
NOTE: The source code for the data transform function is in the {test-source}docker-compose/transform/transform.go[`docker-compose/transform/transform.go` file] that you downloaded. This file is commented to explain how it works.
397398

@@ -404,7 +405,7 @@ See also:
404405

405406
// (step {"goTo": "http://localhost:8080/upload-license"})
406407
// (step {"wait": 5000})
407-
// (step {"screenshot": { "path": "../../modules/console/images/license.png", "overwrite": "aboveVariation", "maxVariation": 10}})
408+
// (step {"screenshot": {"path": "../../modules/console/images/license.png", "overwrite": "always"}})
408409

409410
=== View audit logs
410411

@@ -419,7 +420,7 @@ Audit logs provide a record of all user actions. You can use these logs to track
419420
. Click the *_redpanda.audit_log* topic in the table.
420421
// (step {"goTo": "http://localhost:8080/topics/_redpanda.audit_log"})
421422
// (step {"wait": 5000})
422-
// (step {"screenshot": { "path": "../../modules/console/images/audit-logs.png", "overwrite": "aboveVariation", "maxVariation": 10}})
423+
// (step {"screenshot": {"path": "../../modules/console/images/audit-logs.png", "overwrite": "always"}})
423424

424425
image::console:audit-logs.png[]
425426

@@ -596,7 +597,7 @@ See also: xref:manage:tiered-storage.adoc[].
596597
// (step {"wait": 5000})
597598
// (step {"goTo": "http://localhost:8080/overview"})
598599
// (step {"wait": 5000})
599-
// (step {"screenshot": { "path": "../../modules/console/images/degraded-cluster.png", "overwrite": "aboveVariation", "maxVariation": 10}})
600+
// (step {"screenshot": {"path": "../../modules/console/images/degraded-cluster.png", "overwrite": "always"}})
600601
// (step {"runShell": { "command": "docker start redpanda-2", "workingDirectory": "../docker-compose"}})
601602

602603
== Deploy a pipeline with Redpanda Connect

tests/docker-compose/docker-compose.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,11 @@ services:
8787
- 28082:28082
8888
- 29092:29092
8989
- 29644:9644
90+
healthcheck:
91+
test: ["CMD", "rpk", "cluster", "info", "-X", "user=superuser", "-X", "pass=secretpassword"]
92+
interval: 10s
93+
timeout: 15s
94+
retries: 10
9095
depends_on:
9196
- redpanda-0
9297
- minio
@@ -119,6 +124,11 @@ services:
119124
- 38082:38082
120125
- 39092:39092
121126
- 39644:9644
127+
healthcheck:
128+
test: ["CMD", "rpk", "cluster", "info", "-X", "user=superuser", "-X", "pass=secretpassword"]
129+
interval: 10s
130+
timeout: 15s
131+
retries: 10
122132
depends_on:
123133
- redpanda-0
124134
- minio

tests/setup-tests/fetch-versions-and-rpk.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,39 +13,39 @@
1313
},
1414
{
1515
"stepId": "get-console-version",
16-
"description": "Run doc-tools to fetch the Redpanda Console version, capture output.",
16+
"description": "Get Redpanda Console version from env var or fetch from doc-tools.",
1717
"runShell": {
18-
"command": "npx doc-tools get-console-version --from-antora | grep CONSOLE_VERSION= | cut -d'=' -f2"
18+
"command": "if [ -n \"$REDPANDA_CONSOLE_VERSION\" ]; then echo $REDPANDA_CONSOLE_VERSION; else npx doc-tools get-console-version --from-antora | grep CONSOLE_VERSION= | cut -d'=' -f2; fi"
1919
},
2020
"variables": {
2121
"REDPANDA_CONSOLE_VERSION": "$$stdio.stdout"
2222
}
2323
},
2424
{
2525
"stepId": "get-console-docker-repo",
26-
"description": "Run doc-tools to fetch the Redpanda Console Docker repo, capture output.",
26+
"description": "Get Redpanda Console Docker repo from env var or fetch from doc-tools.",
2727
"runShell": {
28-
"command": "npx doc-tools get-console-version --from-antora | grep CONSOLE_DOCKER_REPO= | cut -d'=' -f2"
28+
"command": "if [ -n \"$CONSOLE_DOCKER_REPO\" ]; then echo $CONSOLE_DOCKER_REPO; else npx doc-tools get-console-version --from-antora | grep CONSOLE_DOCKER_REPO= | cut -d'=' -f2; fi"
2929
},
3030
"variables": {
3131
"CONSOLE_DOCKER_REPO": "$$stdio.stdout"
3232
}
3333
},
3434
{
3535
"stepId": "get-redpanda-version",
36-
"description": "Run doc-tools to fetch the Redpanda version, capture output.",
36+
"description": "Get Redpanda version from env var or fetch from doc-tools.",
3737
"runShell": {
38-
"command": "npx doc-tools get-redpanda-version --from-antora | grep REDPANDA_VERSION= | cut -d'=' -f2"
38+
"command": "if [ -n \"$REDPANDA_VERSION\" ]; then echo $REDPANDA_VERSION; else npx doc-tools get-redpanda-version --from-antora | grep REDPANDA_VERSION= | cut -d'=' -f2; fi"
3939
},
4040
"variables": {
4141
"REDPANDA_VERSION": "$$stdio.stdout"
4242
}
4343
},
4444
{
4545
"stepId": "get-redpanda-docker-repo",
46-
"description": "Run doc-tools to fetch the Redpanda Docker repo, capture output.",
46+
"description": "Get Redpanda Docker repo from env var or fetch from doc-tools.",
4747
"runShell": {
48-
"command": "npx doc-tools get-redpanda-version --from-antora | grep REDPANDA_DOCKER_REPO= | cut -d'=' -f2"
48+
"command": "if [ -n \"$REDPANDA_DOCKER_REPO\" ]; then echo $REDPANDA_DOCKER_REPO; else npx doc-tools get-redpanda-version --from-antora | grep REDPANDA_DOCKER_REPO= | cut -d'=' -f2; fi"
4949
},
5050
"variables": {
5151
"REDPANDA_DOCKER_REPO": "$$stdio.stdout"

0 commit comments

Comments
 (0)