Skip to content

Commit c999725

Browse files
author
Marianne Dillard
committed
clarified host value explanation for add and update ssh key
1 parent bdfb61c commit c999725

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

docs/developers/operations-api/components.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -328,19 +328,10 @@ _Operation is restricted to super_user roles only_
328328
- operation _(required)_ - must always be `add_ssh_key`
329329
- name _(required)_ - the name of the key
330330
- key _(required)_ - the private key contents. Must be an ed25519 key. Line breaks must be delimited with `\n` and have a trailing `\n`
331-
- host _(required)_ - the host for the ssh config (see below). Used as part of the `package` url when deploying a component using this key
331+
- host _(required)_ - the host for the ssh config (see below). Used as part of the `package` url when deploying a component using this key. It must match the host portion of the `package` url for the component (ex: host for [email protected] url is `github.com`)
332332
- hostname _(required)_ - the hostname for the ssh config (see below). Used to map `host` to an actual domain (e.g. `github.com`)
333-
- 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`
333+
- 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`
334334
- replicated _(optional)_ - if true, HarperDB will replicate the key to all nodes in the cluster. Must be a boolean.
335-
_Operation is restricted to super_user roles only_
336-
337-
* operation _(required)_ - must always be `add_ssh_key`
338-
* name _(required)_ - the name of the key
339-
* key _(required)_ - the private key contents. Line breaks must be delimited with 
340-
* host _(required)_ - the host for the ssh config (see below). Used as part of the `package` url when deploying a component using this key
341-
* hostname _(required)_ - the hostname for the ssh config (see below). Used to map `host` to an actual domain (e.g. `github.com`)
342-
* 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 
343-
* replicated _(optional)_ - if true, Harper will replicate the key to all nodes in the cluster. Must be a boolean.
344335

345336
### Body
346337

@@ -349,7 +340,7 @@ _Operation is restricted to super_user roles only_
349340
"operation": "add_ssh_key",
350341
"name": "harperdb-private-component",
351342
"key": "-----BEGIN OPENSSH PRIVATE KEY-----\nthis\nis\na\nfake\nkey\n-----END OPENSSH PRIVATE KEY-----\n",
352-
"host": "harperdb-private-component.github.com",
343+
"host": "github.com",
353344
"hostname": "github.com"
354345
}
355346
```
@@ -366,7 +357,7 @@ _Operation is restricted to super_user roles only_
366357

367358
```
368359
#harperdb-private-component
369-
Host harperdb-private-component.github.com
360+
Host github.com
370361
HostName github.com
371362
User git
372363
IdentityFile /hdbroot/ssh/harperdb-private-component.key
@@ -376,7 +367,7 @@ Host harperdb-private-component.github.com
376367
```
377368
"package": "git+ssh://git@<host>:<github-repo-path>.git#semver:v1.2.3"
378369
379-
"package": "git+ssh://git@harperdb-private-component.github.com:HarperDB/harperdb-private-component.git#semver:v1.2.3"
370+
"package": "git+ssh://[email protected]:HarperDB/harperdb-private-component.git#semver:v1.2.3"
380371
```
381372

382373
Note that `deploy_component` with a package uses `npm install` so the url must be a valid npm format url. The above is an example of a url using a tag in the repo to install.
@@ -392,7 +383,10 @@ _Operation is restricted to super_user roles only_
392383
- operation _(required)_ - must always be `update_ssh_key`
393384
- name _(required)_ - the name of the key to be updated
394385
- key _(required)_ - the private key contents. Must be an ed25519 key. Line breaks must be delimited with `\n` and have a trailing `\n`
395-
- replicated _(optional)_ - if true, Harper will replicate the key update to all nodes in the cluster. Must be a boolean.
386+
- host _(required)_ - the host for the ssh config (see below). Used as part of the `package` url when deploying a component using this key. It must match the host portion of the `package` url for the component (ex: host for [email protected] url is `github.com`)
387+
- hostname _(required)_ - the hostname for the ssh config (see below). Used to map `host` to an actual domain (e.g. `github.com`)
388+
- 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`
389+
- replicated _(optional)_ - if true, HarperDB will replicate the key to all nodes in the cluster. Must be a boolean.
396390

397391
### Body
398392

@@ -401,7 +395,7 @@ _Operation is restricted to super_user roles only_
401395
"operation": "update_ssh_key",
402396
"name": "harperdb-private-component",
403397
"key": "-----BEGIN OPENSSH PRIVATE KEY-----\nthis\nis\na\nNEWFAKE\nkey\n-----END OPENSSH PRIVATE KEY-----\n",
404-
"host": "harperdb-private-component.github.com",
398+
"host": "github.com",
405399
"hostname": "github.com"
406400
}
407401
```

0 commit comments

Comments
 (0)