freighter 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30fa1126d2621dcb16f6bdb97ea29b57b7caeb91
-  data.tar.gz: c257d67e0fe6f333232cda5e786a894c897f0f2b
+  metadata.gz: 70c6f6f59c11d33c9a2b6c2deea4e0cc53baccef
+  data.tar.gz: a8e612fa7748bbbc9e68f9071a5e58a5a9974a52
 SHA512:
-  metadata.gz: 631902e9d78698ff2db1af83e608f1b6aa7c63c903f8f2d182ae2d1c26b277f9f068648575a2a9acf7e84a9e813254051d90ed8eeba5f66c3fbbf3087202758b
-  data.tar.gz: cb428be696ac2b54f3c032aea024887fcb737e6dde93ff3795fddaf8e388aabd9064f44f98a19b1f7ce60133989ecf3fa04cf7e1fcc2ec1e33274eaf7ec6ed39
+  metadata.gz: ee8b45ac9114b3f277263c5ebfb9f315c535e4e5edcf2192a6bda2c2644ba832071e9591c4a96ac5f945fb490442d7e458c21d9ea1648b89dd22a0ac527ea195
+  data.tar.gz: 8613d3b488128480c8a89b376cbd4722abb5eaa9ada2530202d5c0419d871542698a4d685b7245e2c044ea1df4c2a7e81b7bbc55c66bda6410c61302d39bae92

data/README.md

@@ -32,7 +32,7 @@ echo 'DOCKER_OPTS="-H tcp://127.0.0.1:2375 -H unix:///var/run/docker.sock"' | su
 
 The docker service, on the host(s), will need to be restarted.
 
-Running the docker REST API this way should be secure since all communication to the API is over an SSH tunnel, and the REST API is only available locally on the host.
+Running the docker REST API this way should be secure since all communication to the API is over an SSH tunnel, and the docker REST API should only be available locally on the host.
 
 ### Authentication
 
@@ -75,9 +75,105 @@ The apps are defined in freighter.yml.
 
 When you run `freighter configure` it will copy an example freighter.yml file that you can use as a template. The structure of the YAML file is important. More documentation on configuration to come.
 
+Here is what part of the example freighter YAML configuration looks like:
+```YAML
+connection:
+  type: ssh
+  ssh_options:
+    config: true
+    # user_name: user name on host
+    # keys:
+    #  - "~/.config/id_rsa"
+
+docker:
+  port: 2375
+
+environments:
+  staging:
+    hosts:
+      - host: staging.example.com
+        images:
+          - name: organization/imageName:latest
+            containers:
+              - name: app
+                port_mapping: 0.0.0.0:80->80
+                env:
+                  DB_USERNAME: fooBar
+                  DB_PASSWORD: My53cr37
+```
+Breaking this example down:
+
+```YAML
+connection:
+  type: ssh
+  ssh_options:
+    config: true
+    # user_name: user name on host
+    # keys:
+    #  - "~/.config/id_rsa"
+```
+This specifies the connection used to connect to the host servers. Currently, SSH via key based authentication is the only method supported. In order to deploy, you'll need to be able to SSH into all host server you are attempting to deploy to. More connection options may be provided in the future.
+
+There are many ssh_options available. See the following documented here: http://net-ssh.github.io/net-ssh/ (for the "start" method's options). One additional options is "user_name" that was added. You can also use the "--user" option when running freighter to override the user_name in the freighter.yml. For the most simple and flexible configuraiton, use the `config: true` option and that will load your ~/.ssh/config, /etc/ssh_config files to determine how to connect to the hosts.
+
+If more than one user uses freighter to deploy, specifying the user_name in the freighter.yml is not recommended. Use the `config: true` option or the `--user` flag option.
+
+```YAML
+docker:
+  port: 2375
+```
+This specifies the port the docker REST API is running on the host servers. This port should be consistent across all host servers running docker. This port is specified in /etc/default/docker on the hosts, and more information is supplied in the installation instructions. A SSH tunnel is established tunneling TCP traffic from your local machine starting on port 7000 to the host server's localhost:<configured-port>.
+
+```YAML
+environments:
+  staging:
+    hosts:
+      - host: staging.example.com
+        images:
+          - name: organization/imageName:latest
+            containers:
+              - name: app
+                port_mapping: 0.0.0.0:80->80
+                env:
+                  DB_USERNAME: fooBar
+                  DB_PASSWORD: My53cr37
+```
+
+This is where you specify your environments > hosts > images > containers. The formatting was designed to help make it easy to see how the containers are deployed. 
+
+The parser uses Ruby's Psych ruby parser. More details on YAML formatting can be found here: http://www.yaml.org/spec/1.2/spec.html. It is possible to use advanced YAML formatting options to reduce redundancy in your freighter.yml file. The "production" environment in the example freighter.yml shows a basic way that YAML can be formatted to reduce redundancy. I didn't want to get too fancy in this file, but that shouldn't stop you. So long as the following is defined, you should be fine:
+* environments
+* environments/hosts (must be an array)
+* environments/hosts/images (must be an array)
+* environments/hosts/images/containers (must be an array)
+
+The above YAML example will evaluate to the equivalent JSON representation.
+```javascript
+{
+  "environments": {
+    "staging": {
+      "hosts": [{
+        "host": "staging.example.com",
+        "images": [{
+          "name": "organization/imageName:latest",
+          "containers": [{
+            "name": "app",
+            "port_mapping": "0.0.0.0:80->80", 
+            "env": {
+              "DB_USERNAME": "fooBar",
+              "DB_PASSWORD": "My53cr37"
+            }
+          }]
+        }]
+      }]
+    }
+  }
+}
+```
+
 ## Fun facts
 
-If you find yourself in a pickle of not being able to Ctrl+c (interupt) the command. Ctrl+z (suspend) the process and the kill the pid with `kill -6 <pid>`. I'll try to fix it so that this scenario is more avoidable.
+If you find yourself in a pickle of not being able to Ctrl+c (interrupt) the command. Ctrl+z (suspend) the process and the kill the pid with `kill -6 <pid>`. I'll try to fix it so that this scenario is more avoidable.
 
 # Status
 

data/bin/freighter

@@ -41,6 +41,10 @@ OptionParser.new do |opts|
     options.deploy_all = true
   end
 
+  opts.on('--user SSH_USER', 'User name used for the SSH connection. (optional depending on your configuration)') do |user|
+    options.ssh_user = user
+  end
+
   # This option is not yet implemented because the docker REST api is not the best at searching available images
   # opts.on('--no-pull', 'specify if you do not wish to pull the image') do
   #   options.pull_image = false

data/config/freighter.example.yml

@@ -5,9 +5,10 @@
 connection:
   type: ssh
   ssh_options:
-    user_name: user name on host
-    keys:
-      - "~/.config/id_rsa"
+    config: true
+    # user_name: user name on host
+    # keys:
+    #   - "~/.config/id_rsa"
 
 docker:
   port: 2375

data/lib/freighter/ssh.rb

@@ -7,8 +7,8 @@ module Freighter
 
     def initialize(host, ssh_conf)
       @host = host
-      @user = ssh_conf.fetch(:user_name)
-      ssh_conf.delete(:user_name)
+      user_name = ssh_conf.delete([:user_name])
+      @user = OPTIONS.ssh_user || user_name
       @ssh_options = ssh_conf
     end
 

data/lib/freighter/version.rb

@@ -1,3 +1,3 @@
 module Freighter
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freighter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sean McCleary
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh