From 7c00fd2761e6efffe763ece5d08d9a6d3fb95092 Mon Sep 17 00:00:00 2001
From: notgne2
Date: Mon, 5 Oct 2020 19:46:28 -0700
Subject: Add interface with json schema, fix flake-less issues, put
 setActivate and jsonSchema check in flake lib

---
 interface/README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 interface/README.md

(limited to 'interface/README.md')

diff --git a/interface/README.md b/interface/README.md
new file mode 100644
index 0000000..c6b52bd
--- /dev/null
+++ b/interface/README.md
@@ -0,0 +1,32 @@
+A flake must have a `deploy` output with the following structure:
+
+```
+deploy
+├── <generic args>
+└── nodes
+    ├── <NODE>
+    │   ├── <generic args>
+    │   ├── hostname
+    │   └── profiles
+    │       ├── <PROFILE>
+    │       │   ├── <generic args>
+    │       │   ├── bootstrap
+    │       │   └── 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.
+
+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`.
-- 
cgit v1.2.3


From 518f7f5b4f1db83cab61941ab8887b0df76ce8d8 Mon Sep 17 00:00:00 2001
From: notgne2
Date: Thu, 8 Oct 2020 18:13:26 -0700
Subject: Update documentation

---
 interface/README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'interface/README.md')

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
-- 
cgit v1.2.3


From 867438bfc011e63b633b9d6fa2b0edb3367ea253 Mon Sep 17 00:00:00 2001
From: notgne2
Date: Sat, 10 Oct 2020 10:42:14 -0700
Subject: Document `profilePath` option

---
 interface/README.md | 1 +
 1 file changed, 1 insertion(+)

(limited to 'interface/README.md')

diff --git a/interface/README.md b/interface/README.md
index bfca01e..99afeb2 100644
--- a/interface/README.md
+++ b/interface/README.md
@@ -12,6 +12,7 @@ deploy
     │       ├── <PROFILE>
     │       │   ├── <generic args>
     │       │   ├── bootstrap
+    │       │   ├── profilePath
     │       │   └── path
     │       └── <PROFILE>...
     └── <NODE>...
-- 
cgit v1.2.3


From b2326d8694465718024e63c691fe9920c416489e Mon Sep 17 00:00:00 2001
From: notgne2
Date: Sun, 11 Oct 2020 15:23:58 -0700
Subject: Add missing license information

---
 interface/README.md | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'interface/README.md')

diff --git a/interface/README.md b/interface/README.md
index 99afeb2..f61a69f 100644
--- a/interface/README.md
+++ b/interface/README.md
@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2020 Serokell <https://serokell.io/>
+
+SPDX-License-Identifier: MPL-2.0
+-->
+
 A flake must have a `deploy` output with the following structure:
 
 ```
-- 
cgit v1.2.3