management 1.2 → 1.3

data/README.md

@@ -2,122 +2,103 @@
 
 Minimalist EC2 configuration & deployment tool.
 
-- Version: **1.2**
+- Version: **1.3**
 
-![build status](https://travis-ci.org/sdegutis/management.svg?branch=master)
+[![Build Status](https://travis-ci.org/sdegutis/management.svg?branch=master)](https://travis-ci.org/sdegutis/management)
+[![Dependency Status](https://gemnasium.com/sdegutis/management.svg)](https://gemnasium.com/sdegutis/management)
+[![Code Climate](https://codeclimate.com/github/sdegutis/management.png)](https://codeclimate.com/github/sdegutis/management)
+[![Gem Version](https://badge.fury.io/rb/management.svg)](http://badge.fury.io/rb/management)
+[![Gittip](http://img.shields.io/gittip/sdegutis.png)](https://www.gittip.com/sdegutis/)
 
 #### Install
 
-`gem install management`
-
-#### Intro
-
-Read [this short blog post](http://sdegutis.github.io/2014/06/09/announcing-management/) for a brief summary of this project.
+    gem install management
 
 #### Usage
 
-```
-$ management
-Usage: management [command] [args*]
-
-Commands:
-       create-server <env> <type>
-        list-servers [<env>]
-      destroy-server <server>
-        start-server <server>
-         stop-server <server>
-          run-script <server> <script>
-          ssh-server <server>
-
-    -h, --help                       Display this screen
-    -v, --version                    Show version
-
-$ management list-servers
-Name                  State       IP                    Private IP            Size        Env              Type             EC2 ID
---------------------  ----------  --------------------  --------------------  ----------  ---------------  ---------------  -----------
-
-
-$ management create-server staging web
-Created "staging-web-1".
-
-
-$ management list-servers
-Name                  State       IP                    Private IP            Size        Env              Type             EC2 ID
---------------------  ----------  --------------------  --------------------  ----------  ---------------  ---------------  -----------
-staging-web-1         running     101.102.103.104       1.2.3.4               m1.large    staging          db               i-12341234
-
-
-$ management run-script staging-web-1 setup-web
-Copying resources/scripts/bootstrap_base.sh -> /home/webapp/bootstrap_base.sh
-Running /home/webapp/bootstrap_base.sh
-[...snip...]
-Copying resources/files/web.conf.erb -> /etc/init/web.conf
-Copying resources/files/nginx.conf -> /etc/init/nginx.conf
-Copying resources/scripts/start_web_server.sh -> /home/webapp/start_web_server.sh
-Running /home/webapp/start_web_server.sh
-[...snip...]
-```
-
-#### Niche
-
-The remote server only needs ssh and `tar -xzf` to be available, which
-means it'll work in pretty much any linux server, out-of-the-box.
-
-If you only need to provision and manage a handful of servers, this
-project may be right for you.
-
-#### Setup
-
-Put this in `management_config.yml':
-
-```yaml
-cloud:  # NOTE: this just gets passed to Fog::Compute.new
-  provider: AWS
-  aws_access_key_id: 123
-  aws_secret_access_key: 456
-  region: New York 1
-
-envs:
-  - staging
-  - production
-
-types:
-  web:  # NOTE: this just gets passed to compute.servers.create
-    image_id: ami-1234
-    flavor_id: m1.small
-    key_name: my-ssh-key-name
-    groups: ["web"]
-    ssh_key_path: resources/my-ssh-key
-
-scripts:
-  setup-web:
-    - copy: [resources/scripts/bootstrap_base.sh, /home/webapp/bootstrap_base.sh]
-    - run: /home/webapp/bootstrap_base.sh
-    - copy: [resources/files/web.conf.erb, /etc/init/web.conf, template: true]
-    - copy: [resources/files/nginx.conf, /etc/init/nginx.conf]
-    - copy: [resources/scripts/start_web_server.sh, /home/webapp/start_web_server.sh]
-    - run: /home/webapp/start_web_server.sh
-```
+    $ management
+    Usage: management [command [arg ...]]
+
+    Commands:
+           create-server <env> <type>
+            list-servers [<env>]
+         destroy-servers <server> [...]
+            start-server <server>
+             stop-server <server>
+              run-script <server> <script>
+              ssh-server <server>
+          list-addresses
+          attach-address <address> <server>
+            open-console
+
+        -h, --help                       Display this screen
+        -v, --version                    Show version
+
+#### Features
+
+1. All your configuration is done in a single YAML file.
+2. Automating deployment can be done in plain-old bash.
+3. You explicitly specify what files to copy and where to.
+4. You can mix run-script and copy-file phases together.
+5. There's a built-in concept of environments.
+6. You can template any of your copied files (using ERB).
+7. There are as few implicit rules as possible.
+
+Management isn't for everyone. It uses a push-based method which isn't
+ideal if you have tons of servers, but is perfect for small setups
+like the one we have at work. Also, it assumes you're only dealing
+with servers that it created, since it requires certain metadata to
+work. And because it uses EC2 tags, it's currently kind of hard-coded
+to only work on EC2.
+
+#### Sample Configs
+
+Put this in `management_config.yml` at the root of some project:
+
+    cloud:
+      provider: AWS
+      aws_access_key_id: 123
+      aws_secret_access_key: 456
+      region: New York 1
+
+    envs:
+      - staging
+      - production
+
+    types:
+      web:
+        image_id: ami-1234
+        flavor_id: m1.small
+        key_name: my-ssh-key-name
+        groups: ["web"]
+        ssh_key_path: resources/my-ssh-key
+
+    scripts:
+      setup-web:
+        - copy: [resources/scripts/bootstrap_base.sh, /home/webapp/bootstrap_base.sh]
+        - run: /home/webapp/bootstrap_base.sh
+        - copy: [resources/files/web.conf.erb, /etc/init/web.conf, template: true]
+        - copy: [resources/files/nginx.conf, /etc/init/nginx.conf]
+        - copy: [resources/scripts/start_web_server.sh, /home/webapp/start_web_server.sh]
+        - run: /home/webapp/start_web_server.sh
 
 Management doesn't care where any of your files are, with the exception of
 `management_config.yml`, which it expects to be in your project's
 root. Here's the relevant part of the file structure that the above
 sample config assumes:
 
-```
-./my-project
-|-- management_config.yml
-`-- resources
-    |-- files
-    |   |-- nginx.conf
-    |   `-- web.conf.erb
-    |-- keys
-    |   |-- id_rsa_digitalocean
-    |   `-- id_rsa_digitalocean.pub
-    `-- scripts
-        |-- bootstrap_base.sh
-        `-- start_web_server.sh
-```
+    ./my-project
+    |-- management_config.yml
+    `-- resources
+        |-- files
+        |   |-- nginx.conf
+        |   `-- web.conf.erb
+        |-- keys
+        |   |-- id_rsa_digitalocean
+        |   `-- id_rsa_digitalocean.pub
+        `-- scripts
+            |-- bootstrap_base.sh
+            `-- start_web_server.sh
 
 #### Details
 
@@ -172,17 +153,15 @@ If you wanted to install Ruby 2 in your setup phase, you might add
 this to one of your scripts
 ([courtesy of Brandon Hilkert](https://github.com/brandonhilkert/fucking_shell_scripts)):
 
-```bash
-sudo apt-get -y install build-essential zlib1g-dev libssl-dev libreadline6-dev libyaml-dev
-cd /tmp
-wget http://ftp.ruby-lang.org/pub/ruby/2.0/ruby-2.0.0-p247.tar.gz
-tar -xzf ruby-2.0.0-p247.tar.gz
-cd ruby-2.0.0-p247
-./configure --prefix=/usr/local
-make
-sudo make install
-rm -rf /tmp/ruby*
-```
+    sudo apt-get -y install build-essential zlib1g-dev libssl-dev libreadline6-dev libyaml-dev
+    cd /tmp
+    wget http://ftp.ruby-lang.org/pub/ruby/2.0/ruby-2.0.0-p247.tar.gz
+    tar -xzf ruby-2.0.0-p247.tar.gz
+    cd ruby-2.0.0-p247
+    ./configure --prefix=/usr/local
+    make
+    sudo make install
+    rm -rf /tmp/ruby*
 
 #### License
 

data/lib/ext/fog.rb

@@ -71,4 +71,8 @@ class Fog::Compute::Server
   def chown_r(remote_path, chown)
     ssh("sudo chown -R #{chown} #{remote_path}")
   end
+
+  def chmod(remote_path, chmod)
+    ssh("sudo chmod #{chmod} #{remote_path}")
+  end
 end

data/lib/management/commands/run_script.rb

@@ -45,6 +45,7 @@ module Management
     def copy_file(server, local_path, remote_path, opts = nil)
       should_template = opts && opts[:template]
       custom_chown = opts && opts[:chown]
+      custom_chmod = opts && opts[:chmod]
 
       Dir.mktmpdir('management-file-dir') do |file_tmpdir|
 
@@ -70,6 +71,7 @@ module Management
           server.copy_file(local_tar_path, remote_tar_path)
           server.extract_tar(remote_tar_path)
           server.chown_r(remote_path, custom_chown) if custom_chown
+          server.chmod(remote_path, custom_chmod) if custom_chmod
         end
       end
     end

data/lib/management/version.rb

@@ -1,3 +1,3 @@
 module Management
-  VERSION = "1.2"
+  VERSION = "1.3"
 end

data/spec/main_spec.rb

@@ -184,6 +184,10 @@ describe 'management' do
           FileUtils.chown_R(user, group, File.join("/fake-remote-dir", remote))
         end
 
+        server.define_singleton_method(:chmod) do |remote, chmod|
+          FileUtils.chmod(Integer(chmod), File.join("/fake-remote-dir", remote))
+        end
+
       end
 
       it "copies file contents into their remote paths" do
@@ -219,6 +223,24 @@ describe 'management' do
         expect( Etc.getgrgid(stats.gid).name ).to eq `id -gn`.chomp
       end
 
+      it "chmods files correctly when specified" do
+        File.write("foo", "hello world")
+        FileUtils.chmod(0755, "foo")
+        without_stdout { subject.copy_file(server, "foo", "/remote/foo", chmod: "0700") }
+
+        stats = File.stat("/fake-remote-dir/remote/foo")
+        expect(stats.mode & 0o777).to eq 0o700
+      end
+
+      it "doesn't chmod anything unless specified" do
+        File.write("foo", "hello world")
+        FileUtils.chmod(0755, "foo")
+        without_stdout { subject.copy_file(server, "foo", "/remote/foo") }
+
+        stats = File.stat("/fake-remote-dir/remote/foo")
+        expect(stats.mode & 0o777).to eq 0o755
+      end
+
       it "fails if multiple local paths don't exist" do
         script = subject.get_script("testing")
         list = subject.missing_local_files(script)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: management
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
   prerelease: 
 platform: ruby
 authors: