Skip to content

Commit 275f8a7

Browse files
Update ATP install guide
1 parent 4c9ffec commit 275f8a7

1 file changed

Lines changed: 17 additions & 19 deletions

File tree

content/install-guides/atp.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
2-
### Title the install tools article with the name of the tool to be installed
3-
### Include vendor name where appropriate
42
title: Arm Total Performance
53

6-
### Optional additional search terms (one per line) to assist in finding the article
74
additional_search_terms:
85
- performance
96
- profiling
@@ -13,13 +10,14 @@ additional_search_terms:
1310
- perf
1411
- top-down
1512

16-
### Estimated completion time in minutes (please use integer multiple of 5)
1713
minutes_to_complete: 30
1814

15+
author: Pareena Verma
16+
1917
### Link to official documentation
2018
official_docs: https://arm-total-performance.tools.arm.com/
2119

22-
author: Pareena Verma
20+
2321

2422
### PAGE SETUP
2523
weight: 1 # Defines page ordering. Must be 1 for first (or only) page.
@@ -140,7 +138,7 @@ Verify the installation by checking the version:
140138
./atperf version
141139
```
142140

143-
The output displays the installed version number.
141+
The output shows the installed version number:
144142

145143
```output
146144
Arm Total Performance CLI version: 0.39.0
@@ -174,9 +172,9 @@ When the installation finishes, select **Close** to exit the installer.
174172

175173
Before connecting to an Arm Linux target, ensure SSH key-based authentication is configured and that passwordless sudo access is enabled. If you already manage your target system via SSH, you likely have most of this setup complete.
176174

177-
### Check your existing SSH key
175+
## Check your existing SSH key
178176

179-
Verify that you can connect to your target using SSH:
177+
Verify that you can connect to your target using SSH. Replace `user` with your username and `target_host` with your target's hostname or IP address:
180178

181179
```bash
182180
ssh user@target_host
@@ -190,7 +188,7 @@ ssh-keygen -y -f ~/.ssh/id_ed25519
190188

191189
If you're prompted for a passphrase, your key is protected with one. ATP doesn't support SSH keys with passphrases, so you need to create a separate key without a passphrase for ATP.
192190

193-
### Create a passphrase-free key for ATP (if needed)
191+
## Create a passphrase-free key for ATP (if needed)
194192

195193
If your existing SSH key has a passphrase, generate a new key specifically for ATP:
196194

@@ -212,9 +210,9 @@ If your existing key is in the default location (`~/.ssh/id_ed25519` or `~/.ssh/
212210
ssh-copy-id -i ~/.ssh/atp_key.pub user@target_host
213211
```
214212

215-
You can now use `~/.ssh/atp_key` as the private key when configuring ATP's target connection.
213+
You can now use `~/.ssh/atp_key` as the private key when configuring the ATP target connection.
216214

217-
### Enable passwordless sudo on the target
215+
## Enable passwordless sudo on the target
218216

219217
ATP needs to run commands with elevated privileges on the target system. Because ATP cannot enter sudo passwords interactively, configure passwordless sudo access.
220218

@@ -238,7 +236,7 @@ After installing ATP and preparing your target, you can connect using either the
238236

239237
### Connect using the ATP GUI
240238

241-
The GUI is typically used on Windows and macOS hosts, though it's also available on Linux.
239+
Use the GUI on Windows and macOS hosts, though you can also run it on Linux.
242240

243241
Open the ATP application.
244242

@@ -257,15 +255,15 @@ In the **Configure Target** form, provide the following details:
257255
* **Host Key Verification**: Choose **Strict** (recommended) or **Ignore**
258256
* Strict mode verifies the server identity using your `~/.ssh/known_hosts` file
259257

260-
![ATP target configuration example #center](_images/atp-target-config.png)
258+
![ATP target configuration form showing fields for host IP address, descriptive target name, SSH port 22, username, SSH private key selection with automatic detection option, and host key verification set to strict mode for secure server identity verification alt-txt#center](_images/atp-target-config.png)
261259

262260
Select **Add Target**.
263261

264262
The target appears in the targets list and is ready for profiling.
265263

266264
You can select the **Test Connection** button to verify your connection to the ATP Linux target is successful.
267265

268-
![ATP connection test #center](_images/atp-connection-test.png)
266+
![ATP graphical interface showing successful connection test results with green checkmark icon, target name my-target, host IP address 192.168.1.10, connection status Connected, and Test Connection button in an active state alt-txt#center](_images/atp-connection-test.png)
269267

270268
#### Configure jump nodes (optional)
271269

@@ -310,7 +308,7 @@ atperf --help
310308

311309
If your target is the same machine where you installed ATP (the host machine itself), ATP automatically provides a built-in `localhost` target. You don't need to configure authentication, SSH keys, or host verification for local profiling.
312310

313-
Verify the localhost target is available:
311+
Verify the localhost target is available by listing all configured targets:
314312

315313
```bash
316314
atperf target list
@@ -328,7 +326,7 @@ Your local machine is now ready to use as a target. Specify `--target=localhost`
328326

329327
#### Add a remote target
330328

331-
To profile a workload on a remote machine, add it as a target using the standard syntax:
329+
To profile a workload on a remote machine, add it as a target using the standard syntax. This command registers the remote system with ATP:
332330

333331
```bash
334332
atperf target add <user>@<host>:<port>:<private_ssh_key_path>
@@ -452,11 +450,11 @@ atperf target remove my-target
452450

453451
To remove ATP from your system, use the appropriate method for your platform:
454452

455-
**Windows**: Open **Settings** > **Apps**, find **Arm Total Performance**, and select **Uninstall**.
453+
* For Windows, open **Settings** > **Apps**, find **Arm Total Performance**, and select **Uninstall**.
456454

457-
**macOS**: Drag the Arm Total Performance application from **Applications** to the **Trash**.
455+
* For macOS, drag the Arm Total Performance application from **Applications** to the **Trash**.
458456

459-
**Linux**: Remove the package:
457+
* For Linux, remove the package:
460458

461459
```bash
462460
sudo apt remove arm-total-performance

0 commit comments

Comments
 (0)