Skip to content

Commit 2149464

Browse files
Topo: use topo health cmd instead of manually checking host's state
Topo health already checks for Host dependencies like SSH and Docker. It also provides hints on how to resolve the issues. * Suggest running Topo health first on the Host and then on the target. Splitting it in two may help address the issues separately. Signed-off-by: Tomás González <tomasagustin.gonzalezorlando@arm.com>
1 parent 6ee9665 commit 2149464

2 files changed

Lines changed: 59 additions & 47 deletions

File tree

content/learning-paths/cross-platform/deploy-containerized-workloads-with-topo/assess-compatibility.md

Lines changed: 57 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,56 @@ layout: learningpathall
88

99
## Run Topo health checks
1010

11+
### Prepare host environment
12+
13+
Confirm that the required dependencies are available on the host by running this command in your host terminal:
14+
15+
```bash
16+
topo health
17+
```
18+
19+
The output should appear similar to the following:
20+
21+
```bash
22+
Host
23+
----
24+
SSH: ✅ (ssh)
25+
Container Engine: ✅ (docker)
26+
27+
Target
28+
------
29+
ℹ️ provide --target or set TOPO_TARGET to check target health
30+
```
31+
32+
If Docker is missing, please use [Install Docker](https://learn.arm.com/install-guides/docker/).
33+
34+
If SSH is missing, please use [Install SSH](https://learn.arm.com/install-guides/ssh/).
35+
36+
## Prepare target environment
37+
38+
Now that the host device is prepared, we will setup the target. On the host device, connect to your target with SSH.
39+
40+
```bash
41+
ssh user@your-target
42+
```
43+
44+
Once connected to the target, use the following commands to verify both Docker and `lscpu` are installed:
45+
46+
```bash
47+
docker --version
48+
lscpu
49+
```
50+
51+
The output should apear similar to the following:
52+
53+
```output
54+
Docker version xx.x.x
55+
Architecture: aarch64
56+
CPU(s): ...
57+
```
58+
59+
### Prepare Topo for target
60+
1161
We will now run a health check against your target. Run the following command from the terminal of your host device.
1262

1363
If you are using your host device simultaneously as your target, use `topo health --target localhost`.
@@ -21,14 +71,17 @@ The output should appear similar to:
2171
```output
2272
Host
2373
----
24-
SSH: ✅
25-
Container Engine: ✅
74+
SSH: ✅ (ssh)
75+
Container Engine: ✅ (docker)
2676
2777
Target
2878
------
2979
Connectivity: ✅
30-
Container Engine: ✅
31-
Hardware Info: ✅
80+
Container Engine: ✅ (docker)
81+
Remoteproc Runtime: ✅ (remoteproc-runtime)
82+
Remoteproc Shim: ✅ (containerd-shim-remoteproc-v1)
83+
Hardware Info: ✅ (lscpu)
84+
Subsystem Driver (remoteproc): ✅ (m33, m0)
3285
```
3386

3487
A Topo health check confirms connectivity between the host and target, as well as the verifying the presence of dependencies such as docker.

content/learning-paths/cross-platform/deploy-containerized-workloads-with-topo/overview-and-setup.md

Lines changed: 2 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Once a template is defined, use of Topo removes the need to deal with low-level
2525

2626
Topo can also be leveraged by AI Agents to further streamline and automate.
2727

28-
## Prepare host environment
28+
## Install Topo
2929

3030
In this step, you install Topo on the host, along with other dependencies.
3131

@@ -50,47 +50,6 @@ topo --help
5050

5151
You should see an output confirming Topo is present, and describing the available commands.
5252

53-
Confirm that the required dependencies are available on the host bu running these commands in your host terminal:
54-
55-
```bash
56-
ssh -V
57-
docker --version
58-
```
59-
60-
You should see an output confirming version numbers, for example:
61-
62-
```output
63-
OpenSSH_x.x
64-
Docker version xx.x.x
65-
```
66-
67-
If Docker is missing, please use [Install Docker](https://learn.arm.com/install-guides/docker/).
68-
69-
If SSH is missing, please use [Install SSH](https://learn.arm.com/install-guides/ssh/).
70-
71-
## Prepare target environment
72-
73-
Now that the host device is prepared, we will setup the target. On the host device, connect to your target with SSH.
74-
75-
```bash
76-
ssh user@your-target
77-
```
78-
79-
Once connected to the target, use the following commands to verify both Docker and `lscpu` are installed:
80-
81-
```bash
82-
docker --version
83-
lscpu
84-
```
85-
86-
The output should apear similar to the following:
87-
88-
```output
89-
Docker version xx.x.x
90-
Architecture: aarch64
91-
CPU(s): ...
92-
```
93-
9453
## What you've completed and what's next
9554

96-
You have now prepared both your host and target for use with Topo. In the next step, you will utilize Topo to probe your target device for features, assessing its compability with template containerized workloads.
55+
You have now installed Topo on your host. In the next step, you will utilize Topo to prepare your host machine and to probe your target device for features, assessing its compability with template containerized workloads.

0 commit comments

Comments
 (0)