puter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd5bc41c2b68e84e15dae9f1944aea76afdf75af
+  data.tar.gz: b6651d0335a77c943ce1586b8841863218a4c8c5
+SHA512:
+  metadata.gz: 11708fe516cecaa0344435886ee282af29e34ff93aafd4726c12a69acd0c5cfb6cbeca9084c06485a417b2e7686aca21b2c934a9ac7c8d9667d5e3bb11a24817
+  data.tar.gz: 7cc8e3654e93c4cc889ac8a4c047aadb248c93deae086d01f56d715fe1f26756d341aa93331eb41e1679a5ac5f443e15aa98e96055efa317a5efb1ad7316649f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puter.gemspec
+gemspec
+
+# gem 'vmonkey', path: '../vmonkey'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/NOTES.md

@@ -0,0 +1,54 @@
+## What's been implemented
+
+VMware provider, using the vmonkey and rbvmomi APIs.
+Puterfile instructions: FROM, RUN, and COPY
+puter vm sub-commands: images, build, rmi, ps, create, start, stop, rm, apply
+
+## What needs to be implemented
+
+### Enhance puter sub-commands
+
+    `ps`     - detailed output, currently only names are output.
+    `images` - detailed output, currently only names are output.
+
+### Implement puter sub-commands
+
+    `version` -
+    `run`     - convenience for create & start
+    `restart` - guest OS restart
+    `exec`    - run a command on the guest OS
+    `inspect` - detailed metadata of an image/instance
+    `implode` - completely remove all Puter images, instances, and provider-specific metadata
+
+    `tag`     - maybe?
+    `import`  - maybe?  dups an existing non-Puter image (template, ami) into the set of Puter Images
+    `export`  - maybe?  dups an existing Puter Image to a non-Puter image (template, ami)
+
+
+### Implement Puterfile instructions
+
+    `MAINTAINER`
+    `USER`
+    `ENV`
+    `VOLUME`
+    `ADD`
+    `EXPOSE`
+    `ONBUILD`
+
+### Implement an AWS provider
+
+
+## VMware provider
+
+### VMware Puter structure within a Datacenter
+
+    <datacenter>/     # VMonkey config specifies the specific Datacenter to operate from
+      vmFolder/       #
+        Puter/        # top-level vSphere Folder - 'puter vm init' creates this folder
+          Build/      # this folder is used by 'puter vm build' as a working folder
+          Images/     # this folder is where Puter Images (VM templates) are stored
+          Instances/  # this folder is where Puter Images (running and stopped VMs) are stored
+
+## AWS Puter Structure, within an EC2 Region
+
+    tbd

data/README.md

@@ -0,0 +1,124 @@
+# Puter: provision VMs in a Docker-like way
+
+Puter is a tool to quickly and easily provision virtual machine images and
+instances directly on virtualization and cloud providers.
+
+Using a Puterfile syntax that closely resembles Dockerfile syntax, Puter makes
+it easy and familiar to create new base VM images.
+
+### Example Puterfile
+
+## Usage Example
+Given a repo with the following structure:
+
+    example/
+    |-- Puterfile
+    |-- localfile.txt
+    |-- localfile_with_a_really_really_longname.txt
+
+### Puterfile
+    FROM myorg.tld/baseos
+    # Start with any base image on your virtualization provider
+
+    # Run some simple commands
+    RUN touch /tmp/puter.txt
+    RUN userdel -f puter1; useradd puter1
+    RUN sudo -u puter1 whoami
+
+    # Copy some files to the new machine
+    COPY localfile.txt /tmp/explicit_name.txt
+
+    # Extend long lines with \ syntax
+    COPY localfile_with_a_really_really_longname.txt \
+         /home/puter1/
+
+    # Don't fear shell redirection and special characters
+    RUN touch /tmp/puter.txt && \
+        echo more commands > /tmp/puter.txt && \
+        echo done
+    RUN echo puter1 >> /tmp/puter.txt
+
+    # output from long running commands is visible along the way
+    RUN for i in `seq 1 5`; do echo $i; sleep 1; done;
+
+    RUN echo complete
+
+
+### Build an image
+    $ puter vm build myorg.tld/puterWithStuff examples
+    Building '/Puter/Images/myorg.tld/puterWithStuff' FROM '/Puter/Images/c65.small'
+    Waiting for SSH
+    Applying '/Users/pairing/projects/puter/examples/Puterfile' to '/Puter/Build/myorg.tld/puterWithStuff' at 10.0.0.123
+    Step 0 : FROM myorg.tld/baseos
+    Step 1 : RUN touch /tmp/puter.txt
+    Step 2 : RUN userdel -f puter1; useradd puter1
+    userdel: user 'puter1' does not exist
+    Step 3 : RUN sudo -u puter1 whoami
+    puter1
+    Step 4 : COPY localfile.txt /tmp/explicit_name.txt
+    Step 5 : COPY localfile_with_a_really_really_longname.txt  /home/puter1/
+    Step 6 : RUN touch /tmp/puter.txt &&  echo more commands > /tmp/puter.txt &&  echo done
+    done
+    Step 7 : RUN echo puter1 >> /tmp/puter.txt
+    Step 8 : RUN for i in `seq 1 5`; do echo $i; sleep 1; done;
+    1
+    2
+    3
+    4
+    5
+    Step 9 : RUN echo complete
+    complete
+    Stopping '/Puter/Build/myorg.tld/puterWithStuff' and moving to '/Puter/Images/myorg.tld/puterWithStuff'
+    Successfully built 'myorg.tld/puterWithStuff'
+
+    ### Build an image
+
+
+### Create and start an instance
+    $ puter vm create myorg.tld/puterWithStuff puter1
+    Created instance '/Puter/Instances/puter1' from '/Puter/Images/myorg.tld/puterWithStuff'
+
+    $ puter vm start puter1
+    Starting instance '/Puter/Instances/puter1', waiting for SSH...
+    Started '/Puter/Instances/puter1' at 10.32.30.126.
+
+
+### Virtualization providers
+Currently only VMware vSphere is supported.
+Amazon AWS support is planned.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'puter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install puter
+
+## Usage
+
+    $ puter help
+    Commands:
+    puter help [COMMAND]  # Describe available commands or one specific command
+    puter version         # Display puter version.
+    puter vm              # VMware vSphere related tasks. Type puter vm for more help.
+
+    Options:
+    [--version], [--no-version]  # Show program version
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/puter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/puter

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.push File.expand_path("../../lib", __FILE__)
+require 'puter'
+
+Puter::CLI::Cli.start

data/examples/Puterfile

@@ -0,0 +1,25 @@
+FROM c65.small
+# Start with any base image on your virtualization provider
+
+# Run some simple commands
+RUN touch /tmp/puter.txt
+RUN userdel -f puter1; useradd puter1
+RUN sudo -u puter1 whoami
+
+# Copy some files to the new machine
+COPY localfile.txt /tmp/explicit_name.txt
+
+# Extend long lines with \ syntax
+COPY localfile_with_a_really_really_longname.txt \
+     /home/puter1/
+
+# Don't fear shell redirection and special characters
+RUN touch /tmp/puter.txt && \
+    echo more commands > /tmp/puter.txt && \
+    echo done
+RUN echo puter1 >> /tmp/puter.txt
+
+# output from long running commands is visible along the way
+RUN for i in `seq 1 5`; do echo $i; sleep 1; done;
+
+RUN echo complete

data/examples/localfile.txt

@@ -0,0 +1 @@
+from the Puter context

data/examples/localfile_with_a_really_really_longname.txt

@@ -0,0 +1 @@
+from the Puter context

data/lib/puter.rb

@@ -0,0 +1,23 @@
+require 'thor'
+
+module Puter
+  autoload :CLI, 'puter/cli'
+  autoload :UI,  'puter/ui'
+
+  Thor::Base.shell.send(:include, Puter::UI)
+
+  class << self
+    def root
+      @root ||= Pathname.new(File.expand_path('../', File.dirname(__FILE__)))
+    end
+
+    def executable_name
+      File.basename($PROGRAM_NAME)
+    end
+
+    def ui
+      @ui ||= Thor::Base.shell.new
+    end
+  end
+end
+

data/lib/puter/backend/ssh.rb

@@ -0,0 +1,69 @@
+require 'net/ssh'
+require 'net/scp'
+
+module Puter
+  module Backend
+    class SshError < Exception
+    end
+
+    # TODO - pass in a logger, so that stdout and stderr can stream out directly?
+
+    class Ssh
+      def initialize(host, ssh_opts = {})
+        @ssh = Net::SSH.start( host, ssh_opts[:user] || 'root', ssh_opts )
+        @scp = Net::SCP.new(@ssh)
+      end
+
+      def run(command, user='root', opts={}, &output)
+        actual_cmd = "sudo -u #{user} -s -- sh -c '#{command}'"
+        stdout_data = ''
+        stderr_data = ''
+        exit_status = nil
+        exit_signal = nil
+
+        @ssh.open_channel do |channel|
+          # TODO - make request_pty user controllable:
+          #          without a pty, RHEL default configs fail to allow sudo
+          #          with a pty, openssh comingles stdout and stderr onto stdout
+          channel.request_pty do |ch, success|
+            raise SshError.new "Could not obtain SSH pty " if !success
+          end
+
+          channel.exec(actual_cmd) do |ch, success|
+            raise SshError.new "Could not execute command [ #{actual_cmd} ]" if !success
+            channel.on_data do |ch, data|
+              if output
+                output.call(:stdout, data) if output
+              else
+                stdout_data += data
+              end
+            end
+
+            channel.on_extended_data do |ch, type, data|
+              if output
+                output.call(:stderr, data) if output
+              else
+                stderr_data += data
+              end
+            end
+
+            channel.on_request("exit-status") do |ch, data|
+              exit_status = data.read_long
+            end
+
+            channel.on_request("exit-signal") do |ch, data|
+              exit_signal = data.read_long
+            end
+          end
+        end
+        @ssh.loop
+        { :cmd => actual_cmd, :stdout => stdout_data, :stderr => stderr_data, :exit_status => exit_status, :exit_signal => exit_signal }
+      end
+
+      def copy(from, to)
+        @scp.upload! from, to
+      end
+
+    end
+  end
+end

data/lib/puter/cli.rb

@@ -0,0 +1,57 @@
+require 'puter/version'
+require 'puter/cli/vm'
+require 'puter/cli/aws'
+
+module Puter
+  module CLI
+    EXIT_CODE_ERR = 1
+
+    SSH_OPTS = {}
+    SSH_OPTS[:user]                  =  ENV['SSH_USER'] || 'root'
+    SSH_OPTS[:password]              =  ENV['SSH_PASSWORD']         if ENV['SSH_PASSWORD']
+    SSH_OPTS[:port]                  =  ENV['SSH_PORT'].to_i        if ENV['SSH_PORT']
+    SSH_OPTS[:paranoid]              = (ENV['SSH_PARANOID'] == '1') if ENV['SSH_PARANOID']
+    SSH_OPTS[:user_known_hosts_file] =  ENV['SSH_KNOWN_HOSTS']      if ENV['SSH_KNOWN_HOSTS']
+
+    def self.run_cli(&block)
+      begin
+        block.call
+      rescue Puter::RunError => re
+        Puter.ui.error re.message
+        Puter.ui.error "[ #{re.cmd} ] returned [ #{re.exit_status} ]"
+        exit re.exit_status
+      rescue Exception => e
+        Puter.ui.error e.message
+        Puter.ui.error e.backtrace.join "\n"
+        exit EXIT_CODE_ERR
+      end
+      exit 0
+    end
+
+    class Cli < Thor
+      def self.exit_on_failure?
+        true
+      end
+
+      ALIASES = {
+        '-T'         => 'help',
+        '--version'  => 'version',
+        '-V'         => 'version'
+      }
+
+      map ALIASES
+
+      desc 'vm', "VMware vSphere related tasks. Type #{Puter.executable_name} vm for more help."
+      subcommand 'vm', Vm
+
+      desc 'aws', "Amazon AWS related tasks. Type #{Puter.executable_name} aws for more help. NOT IMPLEMENTED."
+      subcommand 'aws', Aws
+
+      class_option :version, :type => :boolean, :desc => 'Show program version'
+      desc 'version', 'Display puter version.'
+      def version
+        Puter.ui.info "#{Puter.executable_name} #{Puter::VERSION}"
+      end
+    end
+  end
+end

data/lib/puter/cli/aws.rb

@@ -0,0 +1,18 @@
+module Puter
+  module CLI
+    class Aws < Thor
+      desc 'images', 'Lists available puter images.'
+      long_desc <<-LONGDESC
+        Lists available puter images.
+
+        With --region option, lists images found in the given AWS region.
+      LONGDESC
+      option :region, :type => :string, :default => 'us-west-1', :banner => 'aws-region-name'
+      def images(region_name = options[:region])
+        CLI.run_cli do
+          raise 'NOT IMPLEMENTED'
+        end
+      end
+    end
+  end
+end