inception-server 0.2.2 → 0.3.0

data/ChangeLog.md

@@ -1,5 +1,9 @@
 # Change Log for Inception Server
 
+## v0.3.0
+
+* `inception share-ssh` makes it really easy to share access to an inception server. It displays text that can be copied & pasted to any person explaining how to setup local SSH config and a private key.
+
 ## v0.2.0
 
 * Settings stored in `~/.inception_server` instead of `~/.bosh_inception`

data/README.md

@@ -4,12 +4,22 @@ Create an inception server for Bosh-related development.
 
 Includes a CLI for creating and preparing an inception server for deploying/developing a Bosh universe. The created or targeted VM is upgraded into an inception server via a Chef cookbook.
 
+The CLI will explain how to share access to an inception server with others. Also with the power of tmux, make it easy for 2+ people to view the same terminal and to leave long running jobs whilst you are disconnected.
+
 [![Build Status](https://travis-ci.org/drnic/inception-server.png?branch=master)](https://travis-ci.org/drnic/inception-server)
 [![Code Climate](https://codeclimate.com/github/drnic/inception-server.png)](https://codeclimate.com/github/drnic/inception-server)
 
 ## Installation
 
-The tool is distributed as a RubyGem.
+```
+git clone https://github.com/cloudfoundry-community/inception-server.git
+cd inception-server
+bundle
+```
+
+*Wherever you see `inception` below, use `bundle exec bin/inception` until the rubygem is fixed.*
+
+The tool WILL be distributed as a RubyGem, but its currently not working in this form sadly.
 
 ```
 $ gem install inception-server
@@ -83,6 +93,13 @@ $ inception deploy
 ... lots of chef output ...
 ```
 
+### SSH access
+
+You have some options for accessing the inception server via SSH:
+
+* `inception ssh` - opens a simple terminal to the inception server
+* `inception tmux` - creates or attaches to a tmux session on the inception server
+* `inception share-ssh` - displays how anyone can setup their own ssh config to connect to the inception server without requiring this project to be installed (nor requiring Ruby installed)
 
 ### Chef cookbook usage - remote VM
 

data/inception-server.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "cyoi" # choose your own infrastructure
 
   # for running cookbooks on inception server
-  spec.add_dependency "knife-solo", "~> 0.3.0.pre4"
+  spec.add_dependency "knife-solo", "~> 0.3.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
@@ -38,6 +38,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
 
   # gems for the cookbook tests
-  spec.add_development_dependency "test-kitchen", "~> 1.0.0.alpha.6"
+  spec.add_development_dependency "test-kitchen", "~> 1.0.0.beta.2"
   spec.add_development_dependency "berkshelf"
 end

data/lib/inception/cli.rb

@@ -61,6 +61,37 @@ module Inception
       run_ssh_command_or_open_tunnel(["-t", "tmux attach || tmux new-session"])
     end
 
+    desc "share-ssh", "Display the SSH config & private key that can be given to others to share access to the inception server"
+    def share_ssh(name=settings.inception.name)
+      user = settings.inception.provisioned.username
+      host = settings.inception.provisioned.host
+      private_key_path = "~/.ssh/#{name}"
+      private_key = settings.inception.key_pair.private_key
+      say <<-EOS
+To access the inception server, add the following to your ~/.ssh/config
+
+  Host #{name}
+    User #{user}
+    Hostname #{host}
+    IdentityFile #{private_key_path}
+
+Create a file #{private_key_path} with all the lines below:
+
+#{private_key}
+
+Change the private key to be read-only to you:
+
+  $ chmod 700 ~/.ssh
+  $ chmod 600 #{private_key_path}
+
+You can now access the inception server running either:
+
+  $ ssh #{name}
+  $ ssh #{name} -t "tmux attach || tmux new-session"
+
+EOS
+    end
+
     no_tasks do
       def configure_provider
         save_settings!

data/lib/inception/cli_helpers/settings.rb

@@ -3,6 +3,8 @@ require "readwritesettings"
 module Inception::CliHelpers
   module Settings
     include FileUtils
+    
+    CONFIG_DIRECTORY = ".inception_server"
 
     # The base directory for holding the manifest settings file
     # and private keys
@@ -10,7 +12,7 @@ module Inception::CliHelpers
     # Defaults to ~/.inception_server; and can be overridden with either:
     # * $SETTINGS - to a folder (supported method)
     def settings_dir
-      @settings_dir ||= File.expand_path(ENV["SETTINGS"] || "~/.inception_server")
+      @settings_dir ||= local_settings || File.expand_path(ENV["SETTINGS"] || "~/#{CONFIG_DIRECTORY}")
     end
 
     def settings_ssh_dir
@@ -49,5 +51,10 @@ module Inception::CliHelpers
       settings
     end
 
+    def local_settings
+      path = File.join(Dir.pwd, CONFIG_DIRECTORY)
+      Dir.exists?(path) ? path : nil
+    end
+
   end
 end

data/lib/inception/version.rb

@@ -1,3 +1,3 @@
 module Inception
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/spec/unit/cli_ssh_spec.rb

@@ -16,9 +16,16 @@ describe Inception do
     setting "provider.credentials.aws_secret_access_key", "aws_secret_access_key"
     setting "provider.region", "us-west-2"
     setting "inception.key_pair.name", "inception"
-    setting "inception.key_pair.private_key", "PRIVATE"
-    setting "inception.provisioned.host", "5.5.5.5"
-    setting "inception.provisioned.username", "vcap"
+    setting "inception.key_pair.private_key", <<-EOS
+-----BEGIN RSA PRIVATE KEY-----
+xV67ZHvuRdoNDbFXscpF5uK4sEwbsvSJw73qtYAgUWfhXQKBgQDCQaO9Hf6UKd4PyPeLlSGE7akS
+p57tEdMoXIE1BzUbQJL5UWfTsL6PDU7PJbIDWsR4CqESLcU3D/JVl7F5bQ6cgLifP3SuDh4oMLtK
+ToA13XEsLnlLnyyi+i1dDv97Yz5jjULy8wsbiVpneabckol4427947OZwIvsHDF+KXHy3w==
+-----END RSA PRIVATE KEY-----
+EOS
+    setting "inception.name", "inception"
+    setting "inception.provisioned.host", "ec2-1-2-3-4.compute-1.amazonaws.com"
+    setting "inception.provisioned.username", "ubuntu"
   end
 
   describe "ssh" do
@@ -28,13 +35,13 @@ describe Inception do
       it "launches ssh session" do
         @cmd.should_receive(:exit)
         @cmd.should_receive(:system).
-          with("ssh -i #{private_key_path} vcap@5.5.5.5")
+          with("ssh -i #{private_key_path} ubuntu@ec2-1-2-3-4.compute-1.amazonaws.com")
         @cmd.ssh
       end
       it "runs ssh command" do
         @cmd.should_receive(:exit)
         @cmd.should_receive(:system).
-          with("ssh -i #{private_key_path} vcap@5.5.5.5 'some command'")
+          with("ssh -i #{private_key_path} ubuntu@ec2-1-2-3-4.compute-1.amazonaws.com 'some command'")
         @cmd.ssh("some command")
       end
     end
@@ -43,7 +50,7 @@ describe Inception do
       it "launches ssh session" do
         @cmd.should_receive(:exit)
         @cmd.should_receive(:system).
-          with("ssh -i #{private_key_path} vcap@5.5.5.5 -t 'tmux attach || tmux new-session'")
+          with("ssh -i #{private_key_path} ubuntu@ec2-1-2-3-4.compute-1.amazonaws.com -t 'tmux attach || tmux new-session'")
         @cmd.tmux
       end
     end
@@ -61,7 +68,7 @@ describe Inception do
         @cmd.stub!(:ensure_mosh_installed).and_return(true)
         @cmd.should_receive(:exit)
         @cmd.should_receive(:system).
-          with("mosh --ssh 'ssh -i #{@private_key_path}' vcap@5.5.5.5")
+          with("mosh --ssh 'ssh -i #{@private_key_path}' ubuntu@ec2-1-2-3-4.compute-1.amazonaws.com")
         @cmd.mosh
       end
       xit "should ensure that the mosh ports are opened" do
@@ -76,5 +83,71 @@ describe Inception do
         @cmd.ensure_security_group_allows_mosh
       end
     end
+
+    describe "share-ssh" do
+      it "should display an example .ssh/config & private key" do
+        @cmd.should_receive(:say).with(<<-EOS)
+To access the inception server, add the following to your ~/.ssh/config
+
+  Host inception
+    User ubuntu
+    Hostname ec2-1-2-3-4.compute-1.amazonaws.com
+    IdentityFile ~/.ssh/inception
+
+Create a file ~/.ssh/inception with all the lines below:
+
+-----BEGIN RSA PRIVATE KEY-----
+xV67ZHvuRdoNDbFXscpF5uK4sEwbsvSJw73qtYAgUWfhXQKBgQDCQaO9Hf6UKd4PyPeLlSGE7akS
+p57tEdMoXIE1BzUbQJL5UWfTsL6PDU7PJbIDWsR4CqESLcU3D/JVl7F5bQ6cgLifP3SuDh4oMLtK
+ToA13XEsLnlLnyyi+i1dDv97Yz5jjULy8wsbiVpneabckol4427947OZwIvsHDF+KXHy3w==
+-----END RSA PRIVATE KEY-----
+
+
+Change the private key to be read-only to you:
+
+  $ chmod 700 ~/.ssh
+  $ chmod 600 ~/.ssh/inception
+
+You can now access the inception server running either:
+
+  $ ssh inception
+  $ ssh inception -t "tmux attach || tmux new-session"
+
+EOS
+        @cmd.share_ssh
+      end
+
+      it "should display an example .ssh/config & private key with custom name" do
+        @cmd.should_receive(:say).with(<<-EOS)
+To access the inception server, add the following to your ~/.ssh/config
+
+  Host company-xyz
+    User ubuntu
+    Hostname ec2-1-2-3-4.compute-1.amazonaws.com
+    IdentityFile ~/.ssh/company-xyz
+
+Create a file ~/.ssh/company-xyz with all the lines below:
+
+-----BEGIN RSA PRIVATE KEY-----
+xV67ZHvuRdoNDbFXscpF5uK4sEwbsvSJw73qtYAgUWfhXQKBgQDCQaO9Hf6UKd4PyPeLlSGE7akS
+p57tEdMoXIE1BzUbQJL5UWfTsL6PDU7PJbIDWsR4CqESLcU3D/JVl7F5bQ6cgLifP3SuDh4oMLtK
+ToA13XEsLnlLnyyi+i1dDv97Yz5jjULy8wsbiVpneabckol4427947OZwIvsHDF+KXHy3w==
+-----END RSA PRIVATE KEY-----
+
+
+Change the private key to be read-only to you:
+
+  $ chmod 700 ~/.ssh
+  $ chmod 600 ~/.ssh/company-xyz
+
+You can now access the inception server running either:
+
+  $ ssh company-xyz
+  $ ssh company-xyz -t "tmux attach || tmux new-session"
+
+EOS
+        @cmd.share_ssh("company-xyz")
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inception-server
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-23 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.0.pre4
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -138,7 +138,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.0.pre4
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -194,7 +194,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0.alpha.6
+        version: 1.0.0.beta.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -202,7 +202,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0.alpha.6
+        version: 1.0.0.beta.2
 - !ruby/object:Gem::Dependency
   name: berkshelf
   requirement: !ruby/object:Gem::Requirement
@@ -317,7 +317,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1534348497094153643
+      hash: -3963462369556113049
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -326,7 +326,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1534348497094153643
+      hash: -3963462369556113049
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25