vagrant-service-manager 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f1e9902aaff50390eff0bbf5bef7964ccc07a4a
-  data.tar.gz: 297496405f7ad27b5fbdf2fbc4565f80e7d3b162
+  metadata.gz: ca4fffe47264ba2b029362806a88f8495c947d70
+  data.tar.gz: e5b0d7ac1bdaf82879b1f238860f7a38d6b01808
 SHA512:
-  metadata.gz: 084b2c651cb6486fe25a3c4dd08d6d41c9042870d4ea53e2afa8afaa7784b66fdb9912dfd4528478103961d6fd157a8add918da66fa245fcccc511dbca1eebc0
-  data.tar.gz: 71766c71c6a027d78408cd83c289fb453110ed9956d946a1ccbed1367dd7fe6cd9e8d9328476be0755bc3cb0746d91b2a7a38217e605fa7cd1baae5b278d6873
+  metadata.gz: c2576875e9f19647ed220bad985427a74e195954b6e0f1ee551bdd19f212774c2e7cd64c8005b93af3722bd3739474c2f56a4ef32d938c0e5ab96b006198a2e3
+  data.tar.gz: c7c57eeb19ca720a7ffe38bd7bb29e04b7dee290cded645aabb1c61efa1669e36d493d7c8d80de55db07f11e81dbbb38fca58d2279b6cafd2b21fe2c5961c7db

data/.gitattributes

@@ -0,0 +1 @@
+CHANGELOG.md merge=union

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## Unreleased
 
+## v1.0.0 Apr 07, 2016
+- Fix #132: vagrant-service-manager 1.0.0 release @navidshaikh
+- Fix #133: Adds restart command for services @navidshaikh
+- Fix #152: Makes plugin backward compatible with docker 1.8.2 for docker version API @navidshaikh
+- Fix #150: Adds .gitattributes to fix the CHANGELOG.md merge conflicts @bexelbie
+- Fix #142: Removes # before human readable output of openshift env info @navidshaikh
+- Fix #75 and #141: Improves `vagrant service-manager env` output @navidshaikh
+- Fix#146: Updates docker 1.9.1 API call for `docker version` @navidshaikh
+- Updating CONTRIBUTING with note about entry loc @bexelbie
+- Update IP detection routine and fix for libvirt @bexelbie
+- Fix #50: Add --help @budhrg
+- Fix #89: Improve help output for service-manager -h @budhrg
+- Vagrant way of showing information using 'locale' @budhrg
+- cygwin eval hint now removes colors and env uses export @bexelbie
+- Fix #131: Fixes starting OpenShift service by default for CDK box @navidshaikh
+
 ## v0.0.5 Mar 29, 2016
 - Fix #127: vagrant-service-manager 0.0.5 release @navidshaikh
 - Fixes a logical issue in the method invocation @navidshaikh

data/CONTRIBUTING.md

@@ -19,7 +19,8 @@ mailing list they will be added to this document.
 * All changes must include appropriate documentation updates.
 
 * All changes must include an entry in the `CHANGELOG.md` in the
-  *unreleased* section describing the change
+  *unreleased* section describing the change.  Your new entry should be
+  the first entry after *unreleased.*
 
 * All changes need at least 2 ACKs from maintainers before they will be merged. If
   the author of the PR is a maintainer, their submission is considered

data/README.md

@@ -77,6 +77,12 @@ Exit Code Number | Meaning
 3                | Vagrant box is not running and must be before this command can succeed
 126              | A service inside the box is not running / Command invoked cannot execute
 
+## IP Address Detection
+
+There is no standarized way of detection Vagrant box IP addresses.
+This code uses the last IPv4 address available from the set of configured
+addresses that are *up*.  i.e. if eth0, eth1, and eth2 are all up and
+have IPv4 addresses, the address on eth2 is used.
 
 ## Get Involved/Contact Us
 

data/Vagrantfile

@@ -13,6 +13,9 @@ Vagrant.configure(2) do |config|
 
   config.vm.box = "projectatomic/adb"
 
+  #config.vm.network "private_network", ip: "192.168.33.10"
+  #config.vm.network "private_network", type: "dhcp"
+
   # This is the default setup
   # config.servicemanager.services = 'docker'
 

data/lib/vagrant-service-manager/command.rb

@@ -4,24 +4,21 @@ require 'digest'
 module Vagrant
   module ServiceManager
     DOCKER_PATH = '/home/vagrant/.docker'
+    SUPPORTED_SERVICES = ['docker', 'openshift', 'kubernetes']
+    SCCLI_SERVICES = ["openshift", "k8s"]
 
     class Command < Vagrant.plugin(2, :command)
       OS_RELEASE_FILE = '/etc/os-release'
 
       def self.synopsis
-        'provides the IP address:port and tls certificate file location for a docker daemon'
+        I18n.t('servicemanager.synopsis')
       end
 
       def exit_if_machine_not_running
         # Exit from plugin with status 3 if machine is not running
         with_target_vms(nil, {:single_target=>true}) do |machine|
           if machine.state.id != :running then
-            message = <<-eos
-  The virtual machine must be running before you execute this command.
-  Try this in the directory with your Vagrantfile:
-  vagrant up
-              eos
-            @env.ui.error(message)
+            @env.ui.error I18n.t('servicemanager.machine_should_running')
             exit 3
           end
         end
@@ -29,81 +26,79 @@ module Vagrant
 
       def execute
         command, subcommand, option = ARGV[1..ARGV.length]
+
         case command
-        when "env"
-          self.exit_if_machine_not_running
+        when 'env'
+          exit_if_machine_not_running
           case subcommand
-          when "docker"
+          when 'docker'
             case option
             when nil
-              self.execute_docker_info
+              execute_docker_info
+            when '--help', '-h'
+              print_help(type: command)
             else
-              self.print_help
+              print_help(type: command, exit_status: 1)
             end
-          when "openshift"
+          when 'openshift'
             case option
             when nil
-              self.execute_openshift_info
-            when "--script-readable"
-              self.execute_openshift_info(true)
+              execute_openshift_info
+            when '--script-readable'
+              execute_openshift_info(true)
+            when '--help', '-h'
+              print_help(type: command)
             else
-              self.print_help
+              print_help(type: command, exit_status: 1)
             end
           when nil
             # display information about all the providers inside ADB/CDK
-            self.print_all_provider_info
+            print_all_provider_info
+          when '--help', '-h'
+            print_help(type: command)
           else
-            self.print_help(1)
+            print_help(type: command, exit_status: 1)
           end
-        when "box"
-          self.exit_if_machine_not_running
+        when 'box'
+          exit_if_machine_not_running
           case subcommand
-          when "version"
+          when 'version'
             case option
             when nil
-              self.print_vagrant_box_version
-            when "--script-readable"
-              self.print_vagrant_box_version(true)
+              print_vagrant_box_version
+            when '--script-readable'
+              print_vagrant_box_version(true)
             else
-                self.print_help(1)
+              print_help(type: command, exit_status: 1)
             end
+          when '--help', '-h'
+            print_help(type: command)
           else
-            self.print_help
+            print_help(type: command, exit_status: 1)
+          end
+        when '--help', '-h'
+          print_help
+        when "restart"
+          self.exit_if_machine_not_running
+          case subcommand
+          when '--help', '-h'
+            print_help(type: command)
+          else
+            restart_service(subcommand)
           end
         when "help"
             self.print_help
         else
-            self.print_help(1)
+          print_help(exit_status: 1)
         end
       end
 
-      def print_help(exit_status=0)
-        help_text = <<-help
-Service manager for services inside vagrant box.
-
-vagrant service-manager <verb> <object> [options]
-
-Verb:
-  env
-    Display connection information for providers in the box.
-    Example:
-    Display information for all active providers in the box:
-      $vagrant service-manager env
-    Display information for docker provider in the box:
-      $vagrant service-manager env docker
-    Display information for openshift provider in the box:
-      $vagrant service-manager env openshift
-    Display information for openshift provider in script readable format:
-      $vagrant service-manager env openshift --script-readable
-
-  box
-    object
-      version : Display version and release of the running vagrant box (from /etc/os-release)
-        option
-          --script-readable : Display the version and release in script readable (key=value) form
-        help
-        @env.ui.info(help_text)
-        exit exit_status
+      def print_help(config = {})
+        config[:type] ||= 'default'
+        config[:exit_status] ||= 0
+
+        @env.ui.info(I18n.t("servicemanager.commands.help.#{config[:type]}"))
+        exit config[:exit_status]
       end
 
       def check_if_a_service_is_running?(service)
@@ -114,12 +109,23 @@ Verb:
       end
 
       def print_all_provider_info
-        message = <<-msg
-# Showing the status of providers in the vagrant box:
-        msg
-        @env.ui.info(message)
-        self.execute_docker_info
-        self.execute_openshift_info
+        @env.ui.info I18n.t('servicemanager.commands.env.nil')
+
+        running_services = []
+        SUPPORTED_SERVICES.each do |service|
+          status = if check_if_a_service_is_running?(service)
+                     running_services << service
+                     I18n.t('servicemanager.commands.env.status.running')
+                    else
+                     I18n.t('servicemanager.commands.env.status.stopped')
+                    end
+          @env.ui.info("#{service} - #{status}")
+        end
+
+        running_services.each do |e|
+          @env.ui.info("\n#{e} env:")
+          public_send("execute_#{e}_info")
+        end
       end
 
       def execute_openshift_info(script_readable = false)
@@ -134,39 +140,28 @@ Verb:
             openshift_console_url,
             script_readable)
         else
-          @env.ui.error("# OpenShift service is not running in the vagrant box.")
+          @env.ui.error I18n.t('servicemanager.commands.env.service_not_running',
+                               name: 'OpenShift')
           exit 126
         end
       end
 
-      def print_openshift_info(openshift_url, openshift_console_url, script_readable = false)
-        if !script_readable
-          message =
-            <<-eos
-# You can access the OpenShift console on: #{openshift_console_url}
-# To use OpenShift CLI, run: oc login #{openshift_url}
-            eos
+      def print_openshift_info(url, console_url, script_readable = false)
+        if script_readable
+          message = I18n.t('servicemanager.commands.env.openshift.script_readable',
+                           openshift_url: url, openshift_console_url: console_url)
         else
-          message =
-            <<-eos
-OPENSHIFT_URL=#{openshift_url}
-OPENSHIFT_WEB_CONSOLE=#{openshift_console_url}
-            eos
+          message = I18n.t('servicemanager.commands.env.openshift.default',
+                           openshift_url: url, openshift_console_url: console_url)
         end
+
         @env.ui.info(message)
       end
 
       def find_machine_ip
         with_target_vms(nil, {:single_target=>true}) do |machine|
           # Find the guest IP
-          if machine.provider_name == :virtualbox then
-            # VirtualBox automatically provisions an eth0 interface that is a NAT interface
-            # We need a routeable IP address, which will therefore be found on eth1
-            command = "ip addr show eth1 | awk 'NR==3 {print $2}' | cut -f1 -d\/"
-          else
-            # For all other provisions, find the default route
-            command = "ip route get 8.8.8.8 | awk 'NR==1 {print $NF}'"
-          end
+          command = "ip -o -4 addr show up |egrep -v ': docker|: lo' |tail -1 | awk '{print $4}' |cut -f1 -d\/"
           guest_ip = ""
           machine.communicate.execute(command) do |type, data|
             guest_ip << data.chomp if type == :stdout
@@ -207,9 +202,14 @@ OPENSHIFT_WEB_CONSOLE=#{openshift_console_url}
           end
 
           api_version = ""
-          docker_apiversion = "docker version --format '{{.Server.ApiVersion}}'"
-          machine.communicate.execute(docker_apiversion) do |type, data|
-            api_version << data.chomp if type == :stdout
+          docker_api_version = "docker version --format '{{.Server.APIVersion}}'"
+          unless machine.communicate.test(docker_api_version)
+            # fix for issue #152: Fallback to older Docker version (< 1.9.1)
+            docker_api_version.gsub!(/APIVersion/, 'ApiVersion')
+          end
+
+          machine.communicate.execute(docker_api_version) do |type, data|
+            api_version << data.chomp if type ==:stdout
           end
 
           # display the information, irrespective of the copy operation
@@ -221,31 +221,23 @@ OPENSHIFT_WEB_CONSOLE=#{openshift_console_url}
         # Print configuration information for accesing the docker daemon
 
         if !OS.windows? then
-          message =
-          <<-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_API_VERSION=#{api_version}
-# run following command to configure your shell:
-# eval "$(vagrant service-manager env docker)"
-
-          eos
+          message = I18n.t('servicemanager.commands.env.docker.non_windows',
+                           ip: guest_ip, port: port, path: secrets_path,
+                           api_version: api_version)
+          @env.ui.info(message)
+        elsif OS.windows_cygwin? then
+          # replace / with \ for path in Cygwin Windows - which uses export
+          secrets_path = secrets_path.split('/').join('\\') + '\\'
+          message = I18n.t('servicemanager.commands.env.docker.windows_cygwin',
+                           ip: guest_ip, port: port, path: secrets_path,
+                           api_version: api_version)
           @env.ui.info(message)
         else
           # replace / with \ for path in Windows
           secrets_path = secrets_path.split('/').join('\\') + '\\'
-          message =
-          <<-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
-setx DOCKER_API_VERSION=#{api_version}
-          eos
+          message = I18n.t('servicemanager.commands.env.docker.windows',
+                           ip: guest_ip, port: port, path: secrets_path,
+                           api_version: api_version)
           # puts is used here to escape and render the back slashes in Windows path
           @env.ui.info(puts(message))
         end
@@ -272,6 +264,26 @@ setx DOCKER_API_VERSION=#{api_version}
           end
         end
       end
+
+      def restart_service(service)
+
+        if SCCLI_SERVICES.include? service
+          # TODO : Handle the case where user wants to pass extra arguments to OpenShift service
+          command = "sudo sccli #{service}"
+        else
+          command = "sudo systemctl restart #{service}"
+        end
+
+        with_target_vms(nil, { single_target: true}) do |machine|
+          machine.communicate.execute(command) do |type, error|
+            if type == :stderr
+              @env.ui.error(error)
+              exit 126
+            end
+          end
+        end
+      end
+
     end
   end
 end

data/lib/vagrant-service-manager/config.rb

@@ -12,7 +12,7 @@ module Vagrant
       attr_accessor(*CONFIG_KEYS)
 
       DEFAULTS = {
-        services: 'docker'
+        services: ''
       }
 
       def initialize
@@ -40,7 +40,8 @@ module Vagrant
         errors = []
 
         unless is_supported_services?
-          errors << "services should be subset of #{SERVICES.inspect}.}"
+          errors << I18n.t('servicemanager.config.supported_devices',
+                           services: SERVICES.inspect)
         end
 
         errors

data/lib/vagrant-service-manager/os.rb

@@ -5,7 +5,7 @@ module OS
   end
 
   def self.windows_cygwin?
-    (/cygwin/ =~ RUBY_PLATFORM) != nil
+    (/cygwin/ =~ ENV["VAGRANT_DETECTED_OS"]) != nil
   end
 
   def self.mac?

data/lib/vagrant-service-manager/service.rb

@@ -19,13 +19,13 @@ module Vagrant
         @app.call(env)
 
         if SUPPORTED_BOXES.include? @machine.guest.capability(:os_variant)
+          # docker service needs to be started by default for ADB and CDK box
           @docker_hook.execute
 
-          if @machine.guest.capability(:os_variant) == "cdk" and @services.length == 0
+          if @machine.guest.capability(:os_variant) == "cdk" && @services.length == 0
             # openshift to be started by default for CDK
             @openshift_hook.execute
-          end
-          if @services.include? "openshift"
+          elsif @services.include? "openshift"
             # Start OpenShift service if it is configured in Vagrantfile
             @openshift_hook.execute
           end

data/lib/vagrant-service-manager/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module ServiceManager
-    VERSION = "0.0.5"
+    VERSION = "1.0.0"
   end
 end

data/lib/vagrant-service-manager.rb

@@ -17,5 +17,7 @@ module Vagrant
 
     # Temporally load the extra capabilities files for Red Hat
     load(File.join(source_root, 'plugins/guests/redhat/plugin.rb'))
+    # Default I18n to load the en locale
+    I18n.load_path << File.expand_path("locales/en.yml", source_root)
   end
 end

data/locales/en.yml

@@ -0,0 +1,111 @@
+en:
+  servicemanager:
+    synopsis: |-
+      provides the IP address:port and tls certificate file location for a docker daemon
+    machine_should_running: |-
+      The virtual machine must be running before you execute this command.
+      Try this in the directory with your Vagrantfile:
+      vagrant up
+
+#-------------------------------------------------------------------------------
+# Translations for config validation errors
+#-------------------------------------------------------------------------------
+    config:
+      supported_devices: |-
+        services should be subset of %{services}.
+#-------------------------------------------------------------------------------
+# Translations for commands. e.g. `vagrant x`
+#-------------------------------------------------------------------------------
+    commands:
+      help:
+        default: |-
+          Usage: vagrant service-manager <command> [options]
+
+          Commands:
+               env          displays connection information for services in the box
+               box          displays version and release information for the box
+               restart      restarts the given systemd service in the box
+
+          Options:
+               -h, --help   print this help
+
+          For help on any individual command run `vagrant service-manager COMMAND -h`
+        env: |-
+          Usage: vagrant service-manager env [object] [options]
+
+          Objects:
+                docker      display information and environment variables for docker
+                openshift   display information and environment variables for openshift
+
+          If OBJECT is ommitted, display the status of all services and information
+          for all active services
+
+          Options:
+                --script-readable  display information in a script readable format.
+                                   Only supported by the openshift object.
+                -h, --help         print this help
+        box: |-
+          Usage: vagrant service-manager box <sub-command> [options]
+
+          Sub-Command:
+                version    display version and release information about the running VM
+
+          Options:
+                --script-readable  display information in a script readable format
+                -h, --help         print this help
+
+        restart: |-
+          Restarts the service
+
+          Usage: vagrant service-manager restart <object> [options]
+
+          Object:
+              Object is a service provided via sccli or systemd. For example: docker, k8s, or openshift etc.
+
+          Options:
+                -h, --help         print this help
+
+          Examples:
+            vagrant service-manager restart docker
+
+      env:
+        docker:
+          windows: |-
+            # Set the following environment variables to enable access to the
+            # docker daemon running inside of the vagrant virtual machine:
+            setx DOCKER_HOST tcp://%{ip}:%{port}
+            setx DOCKER_CERT_PATH %{path}
+            setx DOCKER_TLS_VERIFY 1
+            setx DOCKER_API_VERSION=#{api_version}
+          non_windows: |-
+            # Set the following environment variables to enable access to the
+            # docker daemon running inside of the vagrant virtual machine:
+            export DOCKER_HOST=tcp://%{ip}:%{port}
+            export DOCKER_CERT_PATH=%{path}
+            export DOCKER_TLS_VERIFY=1
+            export DOCKER_API_VERSION=%{api_version}
+            # run following command to configure your shell:
+            # eval "$(vagrant service-manager env docker)"
+          windows_cygwin: |-
+            # Set the following environment variables to enable access to the
+            # docker daemon running inside of the vagrant virtual machine:
+            export DOCKER_HOST=tcp://%{ip}:%{port}
+            export DOCKER_CERT_PATH='%{path}'
+            export DOCKER_TLS_VERIFY=1
+            export DOCKER_API_VERSION=%{api_version}
+            # run following command to configure your shell:
+            # eval "$(VAGRANT_NO_COLOR=1 vagrant service-manager env docker | tr -d '\r')"
+        openshift:
+          default: |-
+            You can access the OpenShift console on: %{openshift_console_url}
+            To use OpenShift CLI, run: oc login %{openshift_url}
+          script_readable: |-
+            OPENSHIFT_URL=%{openshift_url}
+            OPENSHIFT_WEB_CONSOLE=%{openshift_console_url}
+        service_not_running: |-
+          # %{name} service is not running in the vagrant box.
+        nil: |-
+          Configured services:
+        status:
+          running: running
+          stopped: stopped

data/vagrant-service-manager.spec

@@ -2,7 +2,7 @@
 %global vagrant_plugin_name vagrant-service-manager
 
 Name: %{vagrant_plugin_name}
-Version: 0.0.5
+Version: 1.0.0
 Release: 1%{?dist}
 Summary: To provide the user a CLI to configure the ADB/CDK for different use cases and to provide glue between ADB/CDK and the user's developer environment.
 Group: Development/Languages
@@ -70,6 +70,7 @@ popd
 %exclude %{vagrant_plugin_cache}
 %{vagrant_plugin_spec}
 %{vagrant_plugin_instdir}/plugins/guests/
+%{vagrant_plugin_instdir}/locales/
 
 %files doc
 %doc %{vagrant_plugin_docdir}
@@ -84,8 +85,26 @@ popd
 %{vagrant_plugin_instdir}/vagrant-service-manager.spec
 %{vagrant_plugin_instdir}/CHANGELOG.md
 %{vagrant_plugin_instdir}/TODO
+%{vagrant_plugin_instdir}/.gitattributes
 
 %changelog
+* Tue Mar 29 2016 Navid Shaikh - 1.0.0-1
+- Bumps the plugin version to 1.0.0
+- Fix #132: vagrant-service-manager 1.0.0 release @navidshaikh
+- Fix #133: Adds restart command for services @navidshaikh
+- Fix #152: Makes plugin backward compatible with docker 1.8.2 for docker version API @navidshaikh
+- Fix #150: Adds .gitattributes to fix the CHANGELOG.md merge conflicts @bexelbie
+- Fix #142: Removes # before human readable output of openshift env info @navidshaikh
+- Fix #75 and #141: Improves `vagrant service-manager env` output @navidshaikh
+- Fix#146: Updates docker 1.9.1 API call for `docker version` @navidshaikh
+- Updating CONTRIBUTING with note about entry loc @bexelbie
+- Update IP detection routine and fix for libvirt @bexelbie
+- Fix #50: Add --help @budhrg
+- Fix #89: Improve help output for service-manager -h @budhrg
+- Vagrant way of showing information using 'locale' @budhrg
+- cygwin eval hint now removes colors and env uses export @bexelbie
+- Fix #131: Fixes starting OpenShift service by default for CDK box @navidshaikh
+
 * Tue Mar 29 2016 Navid Shaikh - 0.0.5-1
 - Fix #127: vagrant-service-manager 0.0.5 release @navidshaikh
 - Fix #122: Certs copied at the time of generation @budhrg

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-service-manager
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Brian Exelbierd
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies: []
 description: Provides setup information, including environment variables and certificates,
   required to access services provided by ADB/CDK.
@@ -20,6 +20,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitattributes"
 - ".gitignore"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -41,6 +42,7 @@ files:
 - lib/vagrant-service-manager/services/docker.rb
 - lib/vagrant-service-manager/services/open_shift.rb
 - lib/vagrant-service-manager/version.rb
+- locales/en.yml
 - plugins/guests/redhat/cap/osvariant.rb
 - plugins/guests/redhat/cap/sha_id.rb
 - plugins/guests/redhat/plugin.rb