Skip to content

Commit 2070de8

Browse files
committed
Updated the ssh auth
1 parent fffebc0 commit 2070de8

1 file changed

Lines changed: 16 additions & 54 deletions

File tree

content/install-guides/atp.md

Lines changed: 16 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -169,85 +169,47 @@ When the installation finishes, select **Close** to exit the installer.
169169

170170
## How do I prepare my target for ATP connections?
171171

172-
Before connecting to an Arm Linux target, set up SSH key-based authentication and configure passwordless sudo access. The setup differs depending on whether your target is a cloud instance or an on-premise server.
172+
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.
173173

174-
### Working with cloud instances
174+
### Check your existing SSH key
175175

176-
If your target is a cloud instance (for example: AWS EC2 Graviton, GCP Axion, Azure Cobalt), you likely created it with an existing SSH key pair. You need to generate a separate ATP key for the tool to use.
177-
178-
First, ensure you can connect to your cloud instance using the existing key. For example, if your cloud provider key is stored at `~/cloud-keys/my-instance.pem`:
179-
180-
```bash
181-
ssh -i ~/cloud-keys/my-instance.pem ubuntu@your-instance-ip
182-
```
183-
184-
If the connection works, generate a new key pair specifically for ATP (without a passphrase):
185-
186-
```bash
187-
ssh-keygen -t ed25519 -f ~/.ssh/atp_key
188-
```
189-
190-
Press **Enter** when prompted for a passphrase to leave it empty (ATP doesn't support SSH keys with a passphrase).
191-
192-
Now copy the ATP public key to your cloud instance, using your existing cloud key for authentication:
193-
194-
```bash
195-
ssh-copy-id -i ~/.ssh/atp_key.pub -o "IdentityFile=~/cloud-keys/my-instance.pem" ubuntu@your-instance-ip
196-
```
197-
198-
Alternatively, if you've configured your SSH config file (`~/.ssh/config`) with the cloud key details for your instance, you can use:
199-
200-
```bash
201-
ssh-copy-id -i ~/.ssh/atp_key.pub ubuntu@your-instance-ip
202-
```
203-
204-
After this, you can use `~/.ssh/atp_key` as the private key when configuring ATP's target connection.
205-
206-
### Working with on-premise targets
207-
208-
If your target is an on-premise Arm Linux server, check if you already have an SSH key pair on your local machine:
176+
Verify that you can connect to your target using SSH:
209177

210178
```bash
211-
ls -l ~/.ssh/id*
179+
ssh user@target_host
212180
```
213181

214-
If a key pair exists, you see files like `id_ed25519` and `id_ed25519.pub`. The `.pub` file is your public key.
215-
216-
If no keys exist, generate a new key pair:
182+
If the connection works, you have SSH key authentication configured. Now check if your existing key has a passphrase. Try to display the public key:
217183

218184
```bash
219-
ssh-keygen
185+
ssh-keygen -y -f ~/.ssh/id_ed25519
220186
```
221187

222-
Press **Enter** to accept the default location. When prompted for a passphrase, press **Enter** to skip (ATP doesn't support SSH keys with a passphrase).
188+
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.
223189

224-
Copy your public key to the target system:
190+
### Create a passphrase-free key for ATP (if needed)
225191

226-
```bash
227-
ssh-copy-id user@target_host
228-
```
229-
230-
By default, `ssh-copy-id` uses your default public key. If you have multiple keys and want to specify which one to copy, use the `-i` option:
192+
If your existing SSH key has a passphrase, generate a new key specifically for ATP:
231193

232194
```bash
233-
ssh-copy-id -i ~/.ssh/id_ed25519.pub user@target_host
195+
ssh-keygen -t ed25519 -f ~/.ssh/atp_key
234196
```
235197

236-
Enter your password when prompted.
198+
Press **Enter** when prompted for a passphrase to leave it empty.
237199

238-
If you see a message that "All keys were skipped because they already exist on the remote system," but you still need to add or update the key, use the `-f` option to force the installation:
200+
Copy the new public key to your target. If your existing SSH key is at a non-default location (for example, `~/cloud-keys/my-instance.pem`), specify it when copying:
239201

240202
```bash
241-
ssh-copy-id -f user@target_host
203+
ssh-copy-id -i ~/.ssh/atp_key.pub -o "IdentityFile=~/cloud-keys/my-instance.pem" user@target_host
242204
```
243205

244-
Verify key-based authentication works:
206+
If your existing key is in the default location (`~/.ssh/id_ed25519` or `~/.ssh/id_rsa`), use:
245207

246208
```bash
247-
ssh user@target_host
209+
ssh-copy-id -i ~/.ssh/atp_key.pub user@target_host
248210
```
249211

250-
The connection should succeed without prompting for a password.
212+
You can now use `~/.ssh/atp_key` as the private key when configuring ATP's target connection.
251213

252214
### Enable passwordless sudo on the target
253215

0 commit comments

Comments
 (0)