Release 3.0.0

Author: yamalight

CHANGELOG.md

@@ -1,4 +1,13 @@
 
+3.0.0 / 2018-05-23
+==================
+
+Additions:
+  * Add tutorial on running Exoframe on basic AWS-based swarm cluster
+  * Add complex recipes support
+  * Add swarm support
+  * Add config alias (`exoframe init`)
+
 2.1.1 / 2018-03-16
 ==================
 

docs/Basics.md

@@ -53,7 +53,7 @@ You can find the list of available recipes [on npm](https://www.npmjs.com/search
 | rm <id>           | Remove existing deployment or project                                |
 | log <id>          | Get logs for existing deployment or project                          |
 | template [ls, rm] | Add, list or remove deployment templates from the server             |
-| setup             | Setup a complex recipe deployment                                    |
+| setup [recipe]    | Setup a complex recipe deployment                                    |
 | token [ls, rm]    | Generate, list or remove deployment tokens                           |
 | login             | Login into Exoframe server                                           |
 | endpoint [url]    | Selects or adds the endpoint of Exoframe server                      |

docs/RecipesGuide.md

@@ -47,6 +47,11 @@ const recipeProps = {
     // executes `docker build` in project temp dir
     // returns following object: {log, image}
     build,
+    // exoframe build from params function
+    // has following signature: ({tarStream, tag, logLine = noop}) => {}
+    // executes `docker build` on given tarStream with given tag
+    // return following object: {log, image}
+    buildFromParams,
     // exoframe start function
     // has the following signature: async ({image, username, resultStream}) => {}
     // executes `docker start` with given image while setting all required labels, env vars, etc
@@ -77,6 +82,11 @@ const recipeProps = {
     // exoframe network get function
     // returns currently used exoframe network
     getNetwork,
+    // exoframe network creation function
+    // has the following signature: async (networkName) => {}
+    // finds or creates new network with given name
+    // returns dockerode network object
+    createNetwork,
   },
   // exoframe utilities & logger
   // see code here: https://github.com/exoframejs/exoframe-server/blob/master/src/util/index.js
@@ -256,3 +266,4 @@ exports.runSetup = async ({answers, serverConfig, username, docker, util}) => {
 ## Examples
 
 * [Wordpress recipe](https://github.com/exoframejs/exoframe-recipe-wordpress) (incl. Wordpress, MariaDB and PHPMyAdmin)
+* [HOBBIT project recipe](https://github.com/hobbit-project/exoframe-recipe-hobbit) (very complex recipe incl. volumes with configs, pre-setup scripts, etc.)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "exoframe",
-  "version": "3.0.0-rc.2",
+  "version": "3.0.0",
   "description": "Exoframe is a self-hosted tool that allows simple one-command deployments using Docker",
   "main": "index.js",
   "repository": "[email protected]:exoframejs/exoframe.git",
@@ -33,7 +33,7 @@
   },
   "devDependencies": {
     "coveralls": "^3.0.1",
-    "jest": "^22.4.3",
+    "jest": "^22.4.4",
     "nock": "^9.2.6",
     "pkg": "^4.3.1",
     "sinon": "^5.0.7"