tristan/nixinate
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity

Some docs about sshConfigHost

Browse source
This commit is contained in:
Jimmy Reichley 2023-09-29 01:10:27 -04:00
parent 699f6b4495
commit 279c5c55eb
No known key found for this signature in database
GPG key ID: 67715DC5A329803C
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -32,6 +32,10 @@ Below is a minimal example:
_module.args.nixinate = { _module.args.nixinate = {
host = "itchy.scratchy.com"; host = "itchy.scratchy.com";
sshUser = "matthew"; sshUser = "matthew";
# Or optionally pass a 'short' hostname that is defined in ssh config
sshConfigHost = "itchy-scratchy";
buildOn = "remote"; # valid args are "local" or "remote" buildOn = "remote"; # valid args are "local" or "remote"
substituteOnTarget = true; # if buildOn is "local" then it will substitute on the target, "-s" substituteOnTarget = true; # if buildOn is "local" then it will substitute on the target, "-s"
hermetic = false; hermetic = false;
@ -91,6 +95,11 @@ Connection to itchy.scratchy.com closed.
A string representing the username a machine to connect to via ssh. A string representing the username a machine to connect to via ssh.
- `sshConfigHost` *`string`*
A string representing an entry in ssh config. If provided, it takes precedence
over `host` and `sshUser`.
- `buildOn` *`"remote"`* or *`"local"`* - `buildOn` *`"remote"`* or *`"local"`*
- `"remote"` - `"remote"`