Skip to content

Commit

Permalink
document ssh key authentication workaround
Browse files Browse the repository at this point in the history
This documents a workaround for ssh key based authentication (discussed
in thatmattlove#81 ).
  • Loading branch information
bastelfreak committed Sep 19, 2020
1 parent c25cc5f commit f1f50e1
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/docs/adding-devices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,15 @@ While all devices require a credential mapping, the credential values themselves

For HTTP devices (i.e. devices using [hyperglass-agent](https://github.com/checktheroads/hyperglass-agent)), the username is ignored and the password is used as a secret for [JSON Web Token](https://tools.ietf.org/html/rfc7519) encoding/decoding.

There is currently no official support for ssh key authentication. However, it can be workarounded:

* Configure the correct user/key/ip for the device in the ~/.ssh/config file from the user that runs hyperglass
* ensure a simple `ssh $routerip` works and picks up the correct data from the ssh config file
* configure the username as credential in the devices.yaml
* configure any string as password

The `password` attribute is currently mandatory. But netmiko will read the ssh config file. If it lists an ssh key for the router, it will be used.

| Parameter | Type | Description |
| :-------------- | :----- | :----------------------------------------------------------- |
| <R/> `username` | String | Username |
Expand Down

0 comments on commit f1f50e1

Please sign in to comment.