Skip to content

Commit 89e77e1

Browse files
author
Marianne Dillard
committed
rollback ssh key changes and propose deploy component clarification
1 parent c999725 commit 89e77e1

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/developers/operations-api/components.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,12 @@ or this can be shortened to:
4747
HarperDB/application-template#semver:v1.0.0
4848
```
4949

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.
5151

5252
```
5353
git+ssh://[email protected]:my-org/my-app.git#semver:v1.0.0
54+
55+
git+ssh://[email protected]:my-org/my-app.git#semver:v1.0.0
5456
```
5557

5658
Or you can use a Github token:
@@ -328,7 +330,7 @@ _Operation is restricted to super_user roles only_
328330
- operation _(required)_ - must always be `add_ssh_key`
329331
- name _(required)_ - the name of the key
330332
- 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.
332334
- hostname _(required)_ - the hostname for the ssh config (see below). Used to map `host` to an actual domain (e.g. `github.com`)
333335
- 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`
334336
- 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_
340342
"operation": "add_ssh_key",
341343
"name": "harperdb-private-component",
342344
"key": "-----BEGIN OPENSSH PRIVATE KEY-----\nthis\nis\na\nfake\nkey\n-----END OPENSSH PRIVATE KEY-----\n",
343-
"host": "github.com",
345+
"host": "harperdb-private-component.github.com",
344346
"hostname": "github.com"
345347
}
346348
```
@@ -357,7 +359,7 @@ _Operation is restricted to super_user roles only_
357359

358360
```
359361
#harperdb-private-component
360-
Host github.com
362+
Host harperdb-private-component.github.com
361363
HostName github.com
362364
User git
363365
IdentityFile /hdbroot/ssh/harperdb-private-component.key
@@ -367,7 +369,7 @@ Host github.com
367369
```
368370
"package": "git+ssh://git@<host>:<github-repo-path>.git#semver:v1.2.3"
369371
370-
"package": "git+ssh://[email protected]:HarperDB/harperdb-private-component.git#semver:v1.2.3"
372+
"package": "git+ssh://git@harperdb-private-component.github.com:HarperDB/harperdb-private-component.git#semver:v1.2.3"
371373
```
372374

373375
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_
383385
- operation _(required)_ - must always be `update_ssh_key`
384386
- name _(required)_ - the name of the key to be updated
385387
- 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.
387389
- hostname _(required)_ - the hostname for the ssh config (see below). Used to map `host` to an actual domain (e.g. `github.com`)
388390
- 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`
389391
- 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_
395397
"operation": "update_ssh_key",
396398
"name": "harperdb-private-component",
397399
"key": "-----BEGIN OPENSSH PRIVATE KEY-----\nthis\nis\na\nNEWFAKE\nkey\n-----END OPENSSH PRIVATE KEY-----\n",
398-
"host": "github.com",
400+
"host": "harperdb-private-component.github.com",
399401
"hostname": "github.com"
400402
}
401403
```

0 commit comments

Comments
 (0)