vagrant-adbinfo 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69ba917d086339736dfd37c2dfcd19f99203119b
-  data.tar.gz: f18817b21274c028ea9cd345ccb192bb116d8e09
+  metadata.gz: 8b94c04f399859bdfca7a809a8d5fe7365bab9b0
+  data.tar.gz: c5a70ebb551a1b9f1b8c1c1866a2a55954fce047
 SHA512:
-  metadata.gz: 2ffe2d7f944214ec39cb59c89ddd2053b4b25137c3b1dd8de8c39f1ad8a57373d0a9ae83941afc6249070cb59e613911b969973137c3356af71957a87057c8a0
-  data.tar.gz: 249e2cf2a6ddda3bf103505136fe8591fff78dabed32f6da4d8a7833bcf64b1317fbb0360b86b31d994b7b62a57c36d87ae9e7ac2c43f5990d9c950331032c49
+  metadata.gz: 57cdb3e98b1d3551f40f58353e4b57fc903b7222b98cc6f431fd76dfe439aa4d7eb99ee6bba4b92fdca5434e550f4395866e3c9cbbb39bb17d4088486100eaa5
+  data.tar.gz: e01ba9c34b8ee99cd33f63789035c976db741871bbe002e58555bc4561a1dd39b724e99f4fbd53ad67d8269b3f8d6165b685903342ac85f8f39f58159d0db0eb

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## v0.1.0 Jan 19, 2015
+
+- Fix#66: Added CHANGELOG.md to repository
+- Added gemspec in Gemfile to enable bundler packaging
+- Fix#67: OS is not a module (TypeError) on Windows
+- Update ADB box Atlas namespace to projectatomic/adb
+- Update README to reflect latest code and project goals
+- Update Vagrantfile for QuickStart guide
+
+
+## v0.0.9 Nov 25, 2015
+
+- Fix: Prevents TLS certs generation on every run of plugin
+
+
+## v0.0.8  Nov 24, 2015
+
+- Fix#40: Handle private networking for different providers and generate Docker daemon TLS certs accordingly
+- Support backward compatibility with older versions of ADB boxes
+- lib/command.rb - Fixes bash file check command
+- Restart Docker daemon after generating correct TLS certs

data/Gemfile

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 
+gemspec
+
 group :development do
   gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
   # added as the vagrant component wouldn't build without it

data/README.md

@@ -1,105 +1,49 @@
-Display docker information from a vagrant machine, similar to what boot2docker provides
+# vagrant-adbinfo Vagrant Plugin
 
-Based in part on the work done by Michael Kuzmin for vagrant-guestip at https://github.com/mkuzmin/vagrant-guestip
+Provide setup information, including environment variables and certificates, required to access services provided by an [Atomic Developer Bundle (ADB)](https://github.com/projectatomic/adb-atomic-developer-bundle).  This plugin makes it easier to use the ADB with host-based tools such as Eclipse and the docker and kubernetes CLI commands.  Details on this usage pattern can be found in the [ADB Documentation](https://github.com/projectatomic/adb-atomic-developer-bundle/blob/master/docs/using.rst).
 
-#Quick Start
+The [Atomic Developer Bundle](https://github.com/projectatomic/adb-atomic-developer-bundle) is  Vagrant box that provides a ready-to-use development environment for container applications. With ADB, developers can dive right into producing complex, multi-container applications.
 
-- Export following in a `Vagranfile`
+## Quick Start
 
-```ruby
-# -*- mode: ruby -*-
-# vi: set ft=ruby :
+1. Install and start the Atomic Developer Bundle (ADB), as [documented](https://github.com/projectatomic/adb-atomic-developer-bundle/blob/master/docs/installing.rst) in the ADB project.
 
-#Vagrant file for libvirt/kvm and virtualbox provider
+2. Install the vagrant-adbinfo plugin
 
-# check if plugin is installed on system
-unless Vagrant.has_plugin?("vagrant-adbinfo")
-  raise "vagrant-adbinfo plugin is not installed, run `vagrant plugin install vagrant-adbinfo` to install the plugin."
-end
+        vagrant plugin install vagrant-adbinfo
 
-Vagrant.configure(2) do |config|
-  config.vm.box = "atomicapp/dev"
+3. Run the plugin to get environment variables and certificates
 
-  # forward the guest port 2376 of `docker` daemon in guest to host port 2379 for client side tooling to connect
-  config.vm.network "forwarded_port", guest: 2376, host: 2379, auto_correct: true
+        $ vagrant adbinfo
+        Set the following environment variables to enable access to the
+        docker daemon running inside of the vagrant virtual machine:
 
-  config.vm.provider "libvirt" do |libvirt, override|
-    libvirt.driver = "kvm"
-    libvirt.memory = 1024
-    libvirt.cpus = 2
-  end
+        export DOCKER_HOST=tcp://172.13.14.1:5555
+        export DOCKER_CERT_PATH=/home/bexelbie/Repositories/vagrant-adbinfo/.vagrant/machines/default/virtualbox/.docker
+        export DOCKER_TLS_VERIFY=1
+        export DOCKER_MACHINE_NAME="90d3e96"
 
-  config.vm.provider "virtualbox" do |vbox, override|
-    vbox.memory = 1024
-    vbox.cpus = 2
+4. Begin using your host-based tools.
 
-    # Enable use of more than one virtual CPU in a virtual machine.
-    vbox.customize ["modifyvm", :id, "--ioapic", "on"]
-  end
+## Get Involved/Contact Us
 
-end
-```
+  * IRC: #atomic and #nulecule on freenode
+  * Mailing List: container-tools@redhat.com
 
-- ```vagrant up```
+## How to Develop/Test
 
-- ```vagrant adbinfo```
+1. Install the Atomic Developer Bundle (ADB), as [documented](https://github.com/projectatomic/adb-atomic-developer-bundle/blob/master/docs/installing.rst) in the ADB project.  Do not start the box yet.
 
+2. Run `bundle install`
 
-#How to Develop/Test
+3. Start the box with `bundle exec vagrant up`
 
-1 - Install VirtualBox (http://www.if-not-true-then-false.com/2010/install-virtualbox-with-yum-on-fedora-centos-red-hat-rhel/)
+4. Develop.  You can test the command by running `bundle exec vagrant adbinfo`
 
-2 - Get a box to test
+5. When you are ready to build the release, get a maintainer to:
 
-3 - Build a vagrant file
+  1. Put the gemfile in pkg/ with `rake build`
 
-4 - bundle install
+  2. Increment the Version Number
 
-5 - bundle exec vagrant up # starts the vagrant box
-
-6 - bundle exec vagrant adbinfo # tests the command
-
-7 - rake build # puts the gemfile in pkg/
-
-8 - get bex to do a `rake release` after bumping the version number, etc.
-
-
-# Potential Plans/Ideas (in Priority Order)
-
-## VirtualBox Support (Priority 1a - implemented)
-
-For the VirtualBox provider, the user is encouraged to use a forwarded_port directive (with auto_correct) in their Vagrantfile to expose the docker port.
-
-The plugin will use the :forwarded_ports capability to find the forwarded port number and provide it with localhost as the IP address.
-
-Why? By default Virtualbox creates a box that has no inbound network access.  The pattern is to always forward ports, something that a daemon takes care.
-
-## TLS Certificate Location Support, part 2 (Priority 1b - implemented)
-
-The TLS certificate will always land in a known spot, so we need to add that
-
-## libvirt Support (Priority 2 - not started)
-
-For the libvirt provider, the user will be encouraged to just start the box with no special directives in the Vagrantfile.
-
-The plugin will use the standard-docker port combined with the private IP address of the vagrant box. 
-
-Why? vagrant-libvirt has two challenges:
-
-1. There is currently no implementation of the :forwarded_ports capability to list all forwarded ports.  Additionally the codebase does not keep track of these directly, so it is a non-trivial fix.  (Though the fix may still be easy/medium).
-2. Vagrant-libvirt doesn't actually support forwarded ports directly.  Instead a private network is always started and when a forwarded port is requested and instance of `ssh` is spawned to take care of port forwarding.  Since this has non-trivial overhead, there is no reason to use it when we can just get to the box directly
-
-## Anti-Pattern Support (priority 3 - not started)
-
-- Support inbound network and no port forward for VirtualBox.
-- Support a port forward on libvirt.
-  - note: port collision is not supported in libvirt, yet see:
-    https://github.com/pradels/vagrant-libvirt/issues/321
-
-## Other Ideas (not started)
-
-- Support `vagrant adbinfo <target>` (multiple targets?)
-
-
-## Contact us
-For queries regarding the plugin, feel free to put a note on container-tools@redhat.com mailing list.
+  3. Release the plugin with `rake release`

data/Vagrantfile

@@ -12,7 +12,7 @@ Vagrant.configure(2) do |config|
 
   # Every Vagrant development environment requires a box. You can search for
   # boxes at https://atlas.hashicorp.com/search.
-  config.vm.box = "atomicapp/dev"
+  config.vm.box = "projectatomic/adb"
 
   # Disable automatic box update checking. If you disable this, then
   # boxes will only be checked for updates when the user runs

data/lib/command.rb

@@ -1,28 +1,9 @@
-module OS
-
-  def OS.windows?
-    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
-  end
-
-  def OS.mac?
-    (/darwin/ =~ RUBY_PLATFORM) != nil
-  end
-
-  def OS.unix?
-    !OS.Windows?
-  end
-
-  def OS.linux?
-    OS.unix? and not OS.mac?
-  end
-
-end
-
+require_relative 'os'
 module VagrantPlugins
   module DockerInfo
     class Command < Vagrant.plugin(2, :command)
-      # Vagrant box password as defined in the Kickstart for the box <https://github.com/projectatomic/adb-atomic-developer-bundle/blob/master/build_tools/kickstarts/centos-7-kubernetes-vagrant.ks>
-      # On Windows, pscp utility is used to copy the client side certs on the host, this password is used in the pscp command because the ssh keys can not be used. Details: <https://github.com/bexelbie/vagrant-adbinfo/issues/14>
+      # Vagrant box password as defined in the Kickstart for the box <https://github.com/projectatomic/adb-atomic-developer-bundle/blob/master/build_tools/kickstarts/centos-7-adb-vagrant.ks>
+      # On Windows, pscp utility is used to copy the client side certs to the host, password is used in the pscp command because the ssh keys can not be used. Refer issue #14 for details
       @@vagrant_box_password = "vagrant"
 
       def self.synopsis
@@ -95,12 +76,10 @@ def print_info(guest_ip, port, secrets_path, machine_uuid)
     <<-eos
 # Set the following environment variables to enable access to the
 # docker daemon running inside of the vagrant virtual machine:
-
 export DOCKER_HOST=tcp://#{guest_ip}:#{port}
 export DOCKER_CERT_PATH=#{secrets_path}
 export DOCKER_TLS_VERIFY=1
 export DOCKER_MACHINE_NAME=#{machine_uuid[0..6]}
-
 # run following command to configure your shell:
 # eval "$(vagrant adbinfo)"
 
@@ -113,7 +92,6 @@ export DOCKER_MACHINE_NAME=#{machine_uuid[0..6]}
     <<-eos
 # Set the following environment variables to enable access to the
 # docker daemon running inside of the vagrant virtual machine:
-
 setx DOCKER_HOST tcp://#{guest_ip}:#{port}
 setx DOCKER_CERT_PATH #{secrets_path}
 setx DOCKER_TLS_VERIFY 1

data/lib/os.rb

@@ -0,0 +1,18 @@
+# OS Module
+module OS
+  def self.windows?
+    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def self.mac?
+    (/darwin/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def self.unix?
+    !windows?
+  end
+
+  def self.linux?
+    unix? && !mac?
+  end
+end

data/vagrant-adbinfo.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |spec|
   spec.name          = 'vagrant-adbinfo'
-  spec.version       = '0.0.9'
+  spec.version       = '0.1.0'
   spec.homepage      = 'https://github.com/bexelbie/vagrant-adbinfo'
-  spec.summary       = 'Vagrant plugin that provides the IP address:port and tls certificate file location for a docker daemon'
+  spec.summary       = 'Vagrant plugin that provides the IP address:port and TLS certificate file location for a docker daemon'
 
   spec.authors       = ['Brian Exelbierd', 'Navid Shaikh']
   spec.email         = ['bex@pobox.com', 'nshaikh@redhat.com']

data/vagrant-adbinfo.spec

@@ -2,7 +2,7 @@
 %global vagrant_plugin_name vagrant-adbinfo
 
 Name: %{vagrant_plugin_name}
-Version: 0.0.9
+Version: 0.1.0
 Release: 1%{?dist}
 Summary: Vagrant plugin that provides the IP address:port and TLS certificate file location for a Docker daemon
 Group: Development/Languages
@@ -82,8 +82,18 @@ popd
 %{vagrant_plugin_instdir}/MAINTAINERS
 %{vagrant_plugin_instdir}/vagrant-adbinfo.gemspec
 %{vagrant_plugin_instdir}/vagrant-adbinfo.spec
+%{vagrant_plugin_instdir}/CHANGELOG.md
 
 %changelog
+* Tue Jan 19 2016 Navid Shaikh - 0.1.0-1
+- Bump version to 0.1.0
+- Fix#66: Added CHANGELOG.md to repository
+- Added gemspec in Gemfile to enable bundler packaging
+- Fix#67: OS is not a module (TypeError) on Windows
+- Update ADB box Atlas namespace to projectatomic/adb     
+- Update README to reflect latest code and project goals
+- Update Vagrantfile for QuickStart guide
+
 * Wed Nov 25 2015 Brian Exelbierd - 0.0.9-1
 - Fixes cert-generation script existence check, a bug was found where the cert
   was regenerated to often

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-adbinfo
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Brian Exelbierd
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -48,6 +48,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -56,6 +57,7 @@ files:
 - Rakefile
 - Vagrantfile
 - lib/command.rb
+- lib/os.rb
 - lib/vagrant-adbinfo.rb
 - vagrant-adbinfo.gemspec
 - vagrant-adbinfo.spec
@@ -81,6 +83,6 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Vagrant plugin that provides the IP address:port and tls certificate file
+summary: Vagrant plugin that provides the IP address:port and TLS certificate file
   location for a docker daemon
 test_files: []