You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/developers/operations-api/components.md
+10-16Lines changed: 10 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -328,19 +328,10 @@ _Operation is restricted to super_user roles only_
328
328
- operation _(required)_ - must always be `add_ssh_key`
329
329
- name _(required)_ - the name of the key
330
330
- 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`)
332
332
- 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`
334
334
- 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.
344
335
345
336
### Body
346
337
@@ -349,7 +340,7 @@ _Operation is restricted to super_user roles only_
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_
392
383
- operation _(required)_ - must always be `update_ssh_key`
393
384
- name _(required)_ - the name of the key to be updated
394
385
- 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.
396
390
397
391
### Body
398
392
@@ -401,7 +395,7 @@ _Operation is restricted to super_user roles only_
0 commit comments