Skip to content

Commit 0d5ea73

Browse files
hnezhnez
committed
web: setup: add helpful text for each wizard step
Signed-off-by: Leonard Göhrs <l.goehrs@pengutronix.de>
1 parent 9737d1e commit 0d5ea73

File tree

1 file changed

+123
-20
lines changed

1 file changed

+123
-20
lines changed

‎web/src/Setup.tsx

Lines changed: 123 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@ import { useState } from "react";
1919

2020
import Box from "@cloudscape-design/components/box";
2121
import Container from "@cloudscape-design/components/container";
22+
import Icon from "@cloudscape-design/components/icon";
2223
import Header from "@cloudscape-design/components/header";
24+
import Link from "@cloudscape-design/components/link";
25+
import SpaceBetween from "@cloudscape-design/components/space-between";
2326
import Spinner from "@cloudscape-design/components/spinner";
2427
import Wizard from "@cloudscape-design/components/wizard";
2528

@@ -60,8 +63,8 @@ export default function Setup() {
6063
<div id="setup_wizard_inner">
6164
<Container
6265
header={
63-
<Header variant="h1" description="Setup via SSH keys">
64-
SSH key based Wizard
66+
<Header variant="h1" description="Get started with your TAC">
67+
LXA TAC Setup Wizard
6568
</Header>
6669
}
6770
>
@@ -85,17 +88,81 @@ export default function Setup() {
8588
activeStepIndex={activeStepIndex}
8689
allowSkipTo
8790
steps={[
91+
{
92+
title: "Welcome",
93+
description: "Welcome to your TAC and its setup mode",
94+
content: (
95+
<Container>
96+
<Box variant="p">Hey there,</Box>
97+
<Box variant="p">
98+
thank you for buying this TAC. We hope you'll like it!
99+
</Box>
100+
<Box variant="p">
101+
Before you can get started using your TAC we need to set
102+
up a few things so they match your preferences. Some of
103+
these preferences can only be set via the web interface in
104+
this special setup mode, because they affect the security
105+
and inner workings of your TAC. To configure them once the
106+
setup mode is done you either need ssh access to your TAC
107+
or physical access to re-enable the setup mode via the
108+
buttons on the TAC.
109+
</Box>
110+
<Box variant="p">
111+
Ready to get started? Then maybe have a quick look at the{" "}
112+
<Link
113+
external
114+
href="https://www.linux-automation.com/lxatac-M02/index.html"
115+
>
116+
online manual
117+
</Link>{" "}
118+
first and then click "Next" to continue the setup.
119+
</Box>
120+
<br />
121+
<SpaceBetween direction="horizontal" size="s">
122+
<Icon url="/logo.svg" size="large" />
123+
<Box variant="p">
124+
Greetings,
125+
<br />
126+
the Linux Automation GmbH team
127+
</Box>
128+
</SpaceBetween>
129+
</Container>
130+
),
131+
},
88132
{
89133
title: "Add SSH keys",
90134
description:
91-
"Deploy SSH keys on your LXA TAC so you can log into it",
135+
"Deploy SSH keys onto your LXA TAC so you can log into it",
92136
content: (
93137
<Container>
94-
<ConfigEditor
95-
path="/v1/tac/ssh/authorized_keys"
96-
language="text"
97-
defaultContent={SSH_AUTH_KEYS_EXAMPLE}
98-
/>
138+
<SpaceBetween size="s">
139+
<Box variant="p">
140+
For many actions on the LXA TAC you need access to it
141+
via ssh. Permissions to ssh into the TAC are managed via
142+
a list of ssh public keys, that allow logging in as the
143+
root user.
144+
<br />
145+
Paste a list of ssh public keys into the text box below,
146+
to allow them to access the TAC, and click "Save".
147+
Afterwards you should be able to log into your TAC like
148+
this:
149+
<Box
150+
variant="code"
151+
display="block"
152+
padding="s"
153+
fontSize="body-m"
154+
>
155+
$ ssh root@{window.location.hostname}
156+
</Box>
157+
Make sure to check if logging in works before leaving
158+
the setup mode.
159+
</Box>
160+
<ConfigEditor
161+
path="/v1/tac/ssh/authorized_keys"
162+
language="text"
163+
defaultContent={SSH_AUTH_KEYS_EXAMPLE}
164+
/>
165+
</SpaceBetween>
99166
</Container>
100167
),
101168
},
@@ -105,18 +172,45 @@ export default function Setup() {
105172
isOptional: true,
106173
content: (
107174
<Container>
108-
<LabgridConfig />
175+
<SpaceBetween size="s">
176+
<Box variant="p">
177+
The LXA TAC comes with a mostly pre-configured labgrid
178+
exporter, that exports a lot of resources that are built
179+
into the TAC or can be connected to it via USB.
180+
<br />
181+
You may however want to configure the labgrid
182+
coordinator IP address/hostname on the "Environment" tab
183+
or export additional resources in the "User Config" tab.
184+
<br />
185+
Once you have made the required changes click "Save" and
186+
test your configuration by clicking "Next".
187+
</Box>
188+
<LabgridConfig />
189+
</SpaceBetween>
109190
</Container>
110191
),
111192
},
112193
{
113194
title: "Test Labgrid",
114195
description:
115-
"Make sure your labgrid Exporter Service looks healty",
196+
"Make sure your labgrid Exporter Service looks healthy",
116197
isOptional: true,
117198
content: (
118199
<Container>
119-
<LabgridService />
200+
<SpaceBetween size="m">
201+
<Box variant="p">
202+
In this step you can check if the labgrid exporter
203+
starts as expected and the correct resources are
204+
exported. Use the "Start", "Stop" and "Restart" buttons
205+
to control the labgrid exporter systemd service and
206+
observe the systemd journal output in the text window
207+
above them.
208+
<br />
209+
Go back to the exporter configuration step to make
210+
changes and click "Next" once you are satisfied.
211+
</Box>
212+
<LabgridService />
213+
</SpaceBetween>
120214
</Container>
121215
),
122216
},
@@ -125,15 +219,24 @@ export default function Setup() {
125219
description: "Make sure everything is working alright",
126220
content: (
127221
<Container>
128-
<Box>You are about to complete the setup wizard.</Box>
129-
<Box>
130-
You will not be able to re-enter the setup wizard to
131-
deploy new SSH keys via the web interface. You can however
132-
re-enable the setup wizard using the buttons and the
133-
screen on the device. If you do not have physical access
134-
the TAC you should make sure that you can log in to the
135-
device via the SSH keys you have deployed before pressing
136-
"Done".
222+
<Box variant="p">
223+
You are about to complete the setup wizard.
224+
</Box>
225+
<Box variant="p">
226+
You will not be able to re-enter the setup wizard via the
227+
web interface. You can however re-enable the setup wizard
228+
using the buttons and the screen on the device. If you do
229+
not have physical access to the TAC you should make sure
230+
that you can log in now using:
231+
<Box
232+
variant="code"
233+
display="block"
234+
padding="s"
235+
fontSize="body-m"
236+
>
237+
$ ssh root@{window.location.hostname}
238+
</Box>
239+
before pressing "Done".
137240
</Box>
138241
</Container>
139242
),

0 commit comments

Comments
 (0)