Skip to content

Commit b5eeae0

Browse files
committed
deploy_nixos: re-generate documentation
1 parent fa6ba97 commit b5eeae0

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

deploy_nixos/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,12 @@ see also:
7676
* https://github.com/hashicorp/terraform/issues/17034
7777

7878
<!-- terraform-docs-start -->
79+
## Requirements
80+
81+
| Name | Version |
82+
|------|---------|
83+
| terraform | >= 0.12 |
84+
7985
## Providers
8086

8187
| Name | Version |
@@ -86,16 +92,20 @@ see also:
8692
## Inputs
8793

8894
| Name | Description | Type | Default | Required |
89-
|------|-------------|------|---------|:-----:|
95+
|------|-------------|------|---------|:--------:|
9096
| NIX\_PATH | Allow to pass custom NIX\_PATH. Ignored if `-`. | `string` | `"-"` | no |
97+
| build\_on\_target | Avoid building on the deployer. Must be true or false. Has no effect when deploying from an incompatible system. Unlike remote builders, this does not require the deploying user to be trusted by its host. | `string` | `false` | no |
9198
| config | NixOS configuration to be evaluated. This argument is required unless 'nixos\_config' is given | `string` | `""` | no |
9299
| config\_pwd | Directory to evaluate the configuration in. This argument is required if 'config' is given | `string` | `""` | no |
93100
| extra\_build\_args | List of arguments to pass to the nix builder | `list(string)` | `[]` | no |
94101
| extra\_eval\_args | List of arguments to pass to the nix evaluation | `list(string)` | `[]` | no |
95102
| keys | A map of filename to content to upload as secrets in /var/keys | `map(string)` | `{}` | no |
96103
| nixos\_config | Path to a NixOS configuration | `string` | `""` | no |
104+
| ssh\_agent | Whether to use an SSH agent | `bool` | `true` | no |
97105
| ssh\_private\_key\_file | Path to private key used to connect to the target\_host. Ignored if `-` or empty. | `string` | `"-"` | no |
98106
| target\_host | DNS host to deploy to | `any` | n/a | yes |
107+
| target\_port | SSH port used to connect to the target\_host | `number` | `22` | no |
108+
| target\_system | Nix system string | `string` | `"x86_64-linux"` | no |
99109
| target\_user | SSH user used to connect to the target\_host | `string` | `"root"` | no |
100110
| triggers | Triggers for deploy | `map(string)` | `{}` | no |
101111

0 commit comments

Comments
 (0)