Update ssh key instructions #1540
Conversation
imron
requested review from
chrisys,
jtonello,
shaunmulligan and
xginn8
as code owners
shared/general/container-ssh.md
Outdated
| Host ssh.balena-devices.com | ||
| User <USER> | ||
| IdentityFile ~/.ssh/<PRIVATE_KEY> | ||
|
|
There was a problem hiding this comment.
This blank line can be removed from the markdown code snippet
shared/general/container-ssh.md
Outdated
| Host ssh.balena-devices.com | ||
| User <USER> | ||
| IdentityFile ~/.ssh/<PRIVATE_KEY> | ||
|
|
There was a problem hiding this comment.
This blank line can be removed from the markdown code snippet
Add instructions to edit ~/.ssh/config so that it contains an entry for `ssh.balena-devices.com` that uses the newly added key, otherwise `balena ssh` won't know which key to use. Change-type: patch Signed-off-by: Imron Alston <[email protected]>
| @@ -55,6 +55,14 @@ You may either import an existing SSH key from GitHub or manually enter the publ | |||
|
|
|||
| If you do not have an existing key, you can follow [GitHub's documentation][github-ssh], skipping the step about adding the key to your GitHub account, and instead adding the key to your {{ $names.cloud.lower }} account. | |||
|
|
|||
| Once you have added a key your your account, you should also add an entry for `ssh.balena-devices.com` to your `~/.ssh/config` file so that the `balena ssh` command knows to use this key: | |||
There was a problem hiding this comment.
Let me start with: Thank you for the contribution! 👍
you should also add an entry for
ssh.balena-devices.comto your~/.ssh/configfile
Hmm, this is not usually necessary though. I am considering two possibilities:
-
You meant to have a simple / standard setup with a single key for all hostnames, but
balena sshdidn't work for you until you addedssh.balena-devices.comto~/.ssh/config. In this case, we should debug what went wrong and fix it, so that it works without extra configuration in~/.ssh/config, and we might then document "watch out for xxx"... -
You have a complex setup with separate ssh keys for multiple hostnames, and deliberately chose to use a different key for balena /
ssh.balena-devices.com. I understand that ssh key configuration is a step that many users struggle with even in the simple scenario of a single ssh key for all hostnames, so I'd be wary of documenting extra setup steps that would become extra opportunity of misconfiguration and failure. If the intention was to document the steps for this complex setup case, then I would suggest adding a separate section in this document that had a title such as:
## Using a separate ssh key for balena (advanced and optional)
If you need to use a separate ssh key for balena than the ssh key(s) you use for
other services, ...
By the way, in this second scenario, we should keep in mind that balena ssh supports Windows as well, with shells like PowerShell or cmd.exe, and the built-in ssh client provided by Microsoft. Does the ~/.ssh notation even works in cmd.exe? Maybe it does, but it's something that needs confirmation before we document this configuration.
There was a problem hiding this comment.
It's the second setup. I have separate ssh keys for separate services, and without the entry in the .ssh/config file it doesn't use the correct key.
The windows version of ssh provided by Microsoft supports the ~/.ssh notation, with ~ being mapped to %USERPROFILE%.
I'll update shortly with a separate section.
|
@imron Checking back again for an update on this PR. Let us know how we can help you further to complete this change? |
1 similar comment
|
@imron Checking back again for an update on this PR. Let us know how we can help you further to complete this change? |
Add instructions to edit ~/.ssh/config so that it contains an entry for
ssh.balena-devices.comthat uses the newly added key, otherwisebalena sshwon't know which key to use.
Change-type: patch
Signed-off-by: Imron Alston [email protected]