diff options
author | notgne2 | 2020-10-08 18:13:26 -0700 |
---|---|---|
committer | notgne2 | 2020-10-08 18:14:47 -0700 |
commit | 518f7f5b4f1db83cab61941ab8887b0df76ce8d8 (patch) | |
tree | f33d3ebdf76681e1881bbe4d8a6bcd6b5577c072 /interface | |
parent | 3a92593bf9c4ca07a2b09888e4a3f7dff6c9c510 (diff) |
Update documentation
Diffstat (limited to 'interface')
-rw-r--r-- | interface/README.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/interface/README.md b/interface/README.md index c6b52bd..bfca01e 100644 --- a/interface/README.md +++ b/interface/README.md @@ -7,6 +7,7 @@ deploy ├── <NODE> │ ├── <generic args> │ ├── hostname + │ ├── profilesOrder │ └── profiles │ ├── <PROFILE> │ │ ├── <generic args> @@ -14,7 +15,6 @@ deploy │ │ └── path │ └── <PROFILE>... └── <NODE>... - ``` Where `<generic args>` are all optional and can be one or multiple of: @@ -29,4 +29,4 @@ A formal definition for the structure can be found in [the JSON schema](./deploy For every profile of every node, arguments are merged with `<PROFILE>` taking precedence over `<NODE>` and `<NODE>` taking precedence over top-level. -Values can be overridden for all the profiles deployed by setting environment variables with the same names as the profile, for example `sshUser=foobar nix run github:serokell/deploy .` will connect to all nodes as `foobar@<NODE>.hostname`. +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 |