Skip to content

Commit 7623124

Browse files
Merge pull request #2879 from madeline-underwood/atp
Atp_reviewed
2 parents 76010e6 + e131500 commit 7623124

1 file changed

Lines changed: 26 additions & 30 deletions

File tree

content/install-guides/atp.md

Lines changed: 26 additions & 30 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,20 +10,18 @@ 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
23-
24-
### PAGE SETUP
25-
weight: 1 # Defines page ordering. Must be 1 for first (or only) page.
26-
tool_install: false # Set to true to be listed in main selection page, else false
27-
multi_install: false # Set to true if first page of multi-page article, else false
28-
multitool_install_part: false # Set to true if a sub-page of a multi-page article, else false
29-
layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
20+
weight: 1
21+
tool_install: false
22+
multi_install: false
23+
multitool_install_part: false
24+
layout: installtoolsall
3025

3126
build:
3227
list: false # Exclude from .Pages collections and listings
@@ -140,7 +135,7 @@ Verify the installation by checking the version:
140135
./atperf version
141136
```
142137

143-
The output displays the installed version number.
138+
The output shows the installed version number:
144139

145140
```output
146141
Arm Total Performance CLI version: 0.39.0
@@ -176,7 +171,7 @@ Before connecting to an Arm Linux target, ensure SSH key-based authentication is
176171

177172
### Check your existing SSH key
178173

179-
Verify that you can connect to your target using SSH:
174+
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:
180175

181176
```bash
182177
ssh user@target_host
@@ -190,7 +185,7 @@ ssh-keygen -y -f ~/.ssh/id_ed25519
190185

191186
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.
192187

193-
### Create a passphrase-free key for ATP (if needed)
188+
## Create a passphrase-free key for ATP (if needed)
194189

195190
If your existing SSH key has a passphrase, generate a new key specifically for ATP:
196191

@@ -212,9 +207,9 @@ If your existing key is in the default location (`~/.ssh/id_ed25519` or `~/.ssh/
212207
ssh-copy-id -i ~/.ssh/atp_key.pub user@target_host
213208
```
214209

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

217-
### Enable passwordless sudo on the target
212+
## Enable passwordless sudo on the target
218213

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

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

239234
### Connect using the ATP GUI
240235

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

243238
Open the ATP application.
244239

@@ -248,24 +243,25 @@ Select **Add Target**.
248243

249244
In the **Configure Target** form, provide the following details:
250245

251-
* **Host**: The hostname or IP address of the target machine
252-
* **Name**: A descriptive name for the target
253-
* **Port**: The SSH port number (default is 22)
254-
* **User**: The username for SSH connection
255-
* **SSH Private Key**: Choose **Automatically Detect Key** or **Select Key Manually**
246+
* **Host**: the hostname or IP address of the target machine
247+
* **Name**: a descriptive name for the target
248+
* **Port**: the SSH port number (default is 22)
249+
* **User**: the username for SSH connection
250+
* **SSH Private Key**: choose **Automatically Detect Key** or **Select Key Manually**
256251
* For manual selection, enter the path to your private key (usually `~/.ssh/id_rsa` or `~/.ssh/id_ed25519`)
257252
* **Host Key Verification**: Choose **Strict** (recommended) or **Ignore**
258253
* Strict mode verifies the server identity using your `~/.ssh/known_hosts` file
259254

260-
![ATP target configuration example #center](_images/atp-target-config.png)
255+
![ATP target configuration form displaying input fields including Host with IP address 192.168.1.10, Name field for descriptive target identifier, Port field set to 22, User field for SSH username, SSH Private Key section with radio buttons for Automatically Detect Key and Select Key Manually options, and Host Key Verification dropdown menu set to Strict mode with explanation text about verifying server identity using known_hosts file alt-txt#center](/install-guides/_images/atp-target-config.png "Configure Target form with connection settings")
256+
261257

262258
Select **Add Target**.
263259

264260
The target appears in the targets list and is ready for profiling.
265261

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

268-
![ATP connection test #center](_images/atp-connection-test.png)
264+
![ATP graphical interface displaying connection test results with green checkmark icon indicating success, target name my-target shown in header, host IP address 192.168.1.10 listed below, connection status field showing Connected in green text, and blue Test Connection button at bottom of panel#center](/install-guides/_images/atp-connection-test.png "Successful ATP target connection test")
269265

270266
#### Configure jump nodes (optional)
271267

@@ -310,7 +306,7 @@ atperf --help
310306

311307
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.
312308

313-
Verify the localhost target is available:
309+
Verify the localhost target is available by listing all configured targets:
314310

315311
```bash
316312
atperf target list
@@ -328,7 +324,7 @@ Your local machine is now ready to use as a target. Specify `--target=localhost`
328324

329325
#### Add a remote target
330326

331-
To profile a workload on a remote machine, add it as a target using the standard syntax:
327+
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:
332328

333329
```bash
334330
atperf target add <user>@<host>:<port>:<private_ssh_key_path>
@@ -452,11 +448,11 @@ atperf target remove my-target
452448

453449
To remove ATP from your system, use the appropriate method for your platform:
454450

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

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

459-
**Linux**: Remove the package:
455+
* For Linux, remove the package:
460456

461457
```bash
462458
sudo apt remove arm-total-performance

0 commit comments

Comments
 (0)