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
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,10 +47,12 @@ or this can be shortened to:
47
47
HarperDB/application-template#semver:v1.0.0
48
48
```
49
49
50
-
You can also install from private repository if you have an installed SSH keys on the server:
50
+
You can also install from private repository if you have installed SSH keys on the server. Ensure the `host` portion of the url exactly matches the `host` used when adding ssh keys to ensure proper authentication.
@@ -328,7 +330,7 @@ _Operation is restricted to super_user roles only_
328
330
- operation _(required)_ - must always be `add_ssh_key`
329
331
- name _(required)_ - the name of the key
330
332
- 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. It must match the host portion of the `package` url for the component (ex: host for [email protected] url is `github.com`)
333
+
- host _(required)_ - the host for the ssh config (see below). Used as part of the `package` url when deploying a component using this key.
332
334
- hostname _(required)_ - the hostname for the ssh config (see below). Used to map `host` to an actual domain (e.g. `github.com`)
333
335
- 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
336
- replicated _(optional)_ - if true, HarperDB will replicate the key to all nodes in the cluster. Must be a boolean.
@@ -340,7 +342,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.
@@ -383,7 +385,7 @@ _Operation is restricted to super_user roles only_
383
385
- operation _(required)_ - must always be `update_ssh_key`
384
386
- name _(required)_ - the name of the key to be updated
385
387
- key _(required)_ - the private key contents. Must be an ed25519 key. Line breaks must be delimited with `\n` and have a trailing `\n`
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`)
388
+
- host _(required)_ - the host for the ssh config (see below). Used as part of the `package` url when deploying a component using this key.
387
389
- hostname _(required)_ - the hostname for the ssh config (see below). Used to map `host` to an actual domain (e.g. `github.com`)
388
390
- 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
391
- replicated _(optional)_ - if true, HarperDB will replicate the key to all nodes in the cluster. Must be a boolean.
@@ -395,7 +397,7 @@ _Operation is restricted to super_user roles only_
0 commit comments