diff options
| author | notgne2 | 2020-11-07 11:56:22 -0700 |
|---|---|---|
| committer | notgne2 | 2020-11-07 11:56:22 -0700 |
| commit | 6ff3994dbb9b44a919ded00882db9b57f92fe228 (patch) | |
| tree | fe120101c0793850c1fa79331c65049782804bd3 /interface | |
| parent | 3cfc12a2ca5e7d5f6a9c64ddfda025d7599ec8d8 (diff) | |
Greatly expand documentation
Diffstat (limited to '')
| -rw-r--r-- | interface.json (renamed from interface/deploy.json) | 0 | ||||
| -rw-r--r-- | interface.json.license (renamed from interface/deploy.json.license) | 0 | ||||
| -rw-r--r-- | interface/README.md | 39 |
3 files changed, 0 insertions, 39 deletions
diff --git a/interface/deploy.json b/interface.json index fa45e50..fa45e50 100644 --- a/interface/deploy.json +++ b/interface.json diff --git a/interface/deploy.json.license b/interface.json.license index 9e9897d..9e9897d 100644 --- a/interface/deploy.json.license +++ b/interface.json.license diff --git a/interface/README.md b/interface/README.md deleted file mode 100644 index f61a69f..0000000 --- a/interface/README.md +++ /dev/null @@ -1,39 +0,0 @@ -<!-- -SPDX-FileCopyrightText: 2020 Serokell <https://serokell.io/> - -SPDX-License-Identifier: MPL-2.0 ---> - -A flake must have a `deploy` output with the following structure: - -``` -deploy -├── <generic args> -└── nodes - ├── <NODE> - │ ├── <generic args> - │ ├── hostname - │ ├── profilesOrder - │ └── profiles - │ ├── <PROFILE> - │ │ ├── <generic args> - │ │ ├── bootstrap - │ │ ├── profilePath - │ │ └── path - │ └── <PROFILE>... - └── <NODE>... -``` - -Where `<generic args>` are all optional and can be one or multiple of: - -- `sshUser` -- user to connect as -- `user` -- user to install and activate profiles with -- `sshOpts` -- options passed to `nix copy` and `ssh` -- `fastConnection` -- whether the connection from this host to the target one is fast (if it is, don't substitute on target and copy the entire closure) [default: `false`] -- `autoRollback` -- whether to roll back when the deployment fails [default: `false`] - -A formal definition for the structure can be found in [the JSON schema](./deploy.json) - -For every profile of every node, arguments are merged with `<PROFILE>` taking precedence over `<NODE>` and `<NODE>` taking precedence over top-level. - -Certain read values can be overridden by supplying flags to the deploy binary, for example `deploy --auto-rollback true .` will enable automatic rollback for all nodes being deployed to, regardless of settings.
\ No newline at end of file |