Skip to content

Commit 1cadace

Browse files
Devin-Hollandkriszyp
authored andcommitted
Update the docs for add_key to specify the format of the key must be ed25519
1 parent 59d9656 commit 1cadace

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/developers/operations-api/components.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ _Operation is restricted to super_user roles only_
303303

304304
- operation _(required)_ - must always be `add_ssh_key`
305305
- name _(required)_ - the name of the key
306-
- key _(required)_ - the private key contents. Line breaks must be delimited with `\n`
306+
- key _(required)_ - the private key contents. Must be an ed25519 key. Line breaks must be delimited with `\n` and have a trailing `\n`
307307
- host _(required)_ - the host for the ssh config (see below). Used as part of the `package` url when deploying a component using this key
308308
- hostname _(required)_ - the hostname for the ssh config (see below). Used to map `host` to an actual domain (e.g. `github.com`)
309309
- known_hosts _(optional)_ - the public SSH keys of the host your component will be retrieved from. If `hostname` is `github.com` this will be retrieved automatically. Line breaks must be delimited with `\n`
@@ -316,7 +316,7 @@ _Operation is restricted to super_user roles only_
316316
{
317317
"operation": "add_ssh_key",
318318
"name": "harperdb-private-component",
319-
"key": "-----BEGIN OPENSSH PRIVATE KEY-----\nthis\nis\na\nfake\nkey\n-----END OPENSSH PRIVATE KEY-----",
319+
"key": "-----BEGIN OPENSSH PRIVATE KEY-----\nthis\nis\na\nfake\nkey\n-----END OPENSSH PRIVATE KEY-----\n",
320320
"host": "harperdb-private-component.github.com",
321321
"hostname": "github.com"
322322
}
@@ -354,7 +354,7 @@ _Operation is restricted to super_user roles only_
354354

355355
- operation _(required)_ - must always be `update_ssh_key`
356356
- name _(required)_ - the name of the key to be updated
357-
- key _(required)_ - the private key contents. Line breaks must be delimited with `\n`
357+
- key _(required)_ - the private key contents. Must be an ed25519 key. Line breaks must be delimited with `\n` and have a trailing `\n`
358358
- replicated _(optional)_ - if true, HarperDB will replicate the key update to all nodes in the cluster. Must be a boolean.
359359

360360
### Body

0 commit comments

Comments
 (0)