vagrant-service-manager 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85d5930d50032ff227fe63924f9e96e3f43877d0
-  data.tar.gz: 1960b2b1b233f3154b5c80961e56f9a8ad94a60b
+  metadata.gz: cf741305f765a3885caab63cddcfdd6428d3ddf9
+  data.tar.gz: 799608609c331ee3a35586a53d56139cbfbe0998
 SHA512:
-  metadata.gz: c4a8326b93fbebe49b33f562bf569af44a1136f3d21cb33a7bef8ff0d14ff7e85eb73a160bd419c446c6bc7130860a24f26075176e2767186f1661d385897d61
-  data.tar.gz: 58fb6c65fad2cb6d46295d65f3322fb193a003ed073873e388563ed2798af29bb1f8a40a5390580db2bf49ce95a546f0b21e0eaeddb32be8c56f0e53176e7795
+  metadata.gz: 90d35a506e05a208df03011389b0da295c5b526581c24542d9aef32dfc84344f9e1842761a62e6df78dbff5b9dd4abdfba0dee3edb076c35d34bc6ec478df419
+  data.tar.gz: 867fcc3a0cbcb1adf96d615fcffa02816af73651ad4009f8672618e2483a395df5e0d1d212969fc9b02f4c89f66a1277332802bcb396712c5da8e53e28d6a6c7

data/CHANGELOG.md

@@ -1,27 +1,37 @@
 # Changelog
 
+## v1.2.1 Jul 15, 2016
+
+- Fix #343 Updated CHANGELOG for user name @budhrg
+- Fix #330 Documenting release process @hferentschik
+- Fix #313 Explicitly requiring rubyzip as dependency in gemspec @hferentschik
+- Fix #336 Link commands.adoc @budhrg
+- Fix #197 Created new doc for available commands with examples @Preeticp
+
 ## v1.2.0 Jul 14, 2016
 
-- Issue #331: Update expectation for DOCKER_API_VERSION in cucumber test
-- Issue #323: Add note about default download location of client binaries in README documentation
-- Issue #321: `install-cli docker` errors "Download URL is not accessible" blocker bug
-- Issue #312: install-cli commands throws an error when trying to install Kubernetes CLI bug
-- Issue #291: Update doc example for env to reflect new changes documentation
-- Issue #289: Remove Vagrantfile in root of repository
-- Issue #287: Remove unnecessary TODO file from repo
-- Issue #285: Use native methods to detect host platform instead of OS module
-- Issue #282: Add build status to README build
-- Issue #281: The ADB/CDK download rake tasks should be made proper Rake tasks build enhancement
-- Issue #278: Missing acceptance tests for command like status, service operations test
-- Issue #275: Typo in `vagrant service-manager env --help` command output text bug
-- Issue #270: DOCKER_API_VERSION not set properly on Windows bug
-- Issue #262: Update CI setup configuration
-- Issue #252: Cosmetic bug: vagrant service-manager box ip --script-readable
-- Issue #207: Remove vagrant-service-manager.spec and stop publishing gem as rpm
-- Issue #196: Introduce unit test harness test
-- Issue #93: Implement style guide based test using rubocop test
-- Issue #90: Add install-cli command enhancement focus:devex
-- Issue #20: --force should force redownloading the TLS certificates documentation
+- Fix #331 Updating test expectation after latest ADB release @hferentschik
+- Fix #207 Removes SPEC file from repository and reference from README @navidshaikh
+- Fix #321 Adding support for HTTPS URLs for download URLs @budhrg
+- Fix #323 Adding note about CLI default download location @navidshaikh
+- Fix #312 Improving test for install-cli of Kubernetes @hferentschik
+- Fix #312 Adding message to install-cli to indicate that Kubernetes is not supported by this command @budhrg
+- Fix #93 Adding Rubocop configuration @hferentschik
+- Fix #90, #196 and #289 Introducing unit tests using minitest @budhrg
+- Fix #90 Add install-cli command @budhrg
+- Fix #281 Making download of box file a true dependency of the feature task with update checks @hferentschik
+- Fix #20 Adding documentation about the Docker TLS certification creation @hferentschik
+- Fix #291 Reorganized the Available Commands section @preeticp
+- Fix #285 Native methods to detect host platform @budhrg
+- Fix #287 Removed Unnecessary TODO file @budhrg
+- Fix #288 Adding build status image to README @hferentschik
+- Fix #278 Acceptance tests for --help option for commands like box, env and service-operations @budhrg
+- Fix #275 Fixes typo in vagrant service-manager --help output @navidshaikh
+- Fix #272 README fix for env default behavior @budhrg
+- Fix #262 Updating CI config @hferentschik
+- Fix #270 Fix DOCKER_API_VERSION properly on Windows @budhrg
+- Fix #268 Explicitly setting v1.8.4 as dev version for Vagrant as HEAD has switched to Ruby 2.2 @hferentschik
+- Fix #252 Added --script-readable option to box ip @budhrg
 
 ## v1.1.0 Jun 08, 2016
 - Updated README to make Installation Instructions clearer @bexelbie

data/CONTRIBUTING.adoc

@@ -102,3 +102,36 @@ $ git merge fix-123
 # Push to origin
 $ git push origin master
 -------------------------------------------------------------------------
+
+== Releasing
+
+* Make sure the HEAD of development builds and passes all tests:
+  `bundle exec rake clean rubocop test features install`. You can also
+  verify against https://ci.centos.org/job/vagrant-service-manager[CI]
+* Review https://github.com/projectatomic/vagrant-service-manager/milestones[milestone] for the current release
+** Make sure all issues are resolved
+** Move unresolved issues into an upcoming release
+** Close milestone
+* Update the link:CHANGELOG.adoc[CHANGELOG]
+* Update link:lib/vagrant-service-manager/version.rb[version.rb] with the correct
+  release version. Consider http://semver.org/:[Semantic Versioning] guidelines
+  when deciding on the release version
+* Commit _CHANGELOG_ and _version.rb_ using commit message of the form:
+  `vagrant-service-manager version=<version>`
+* Push commit to upstream
+* Release the gem: `bundle exec rake release`
+* Update link:lib/vagrant-service-manager/version.rb[version.rb] with the next anticipated release version, eg _1.42.0.dev_
+* Commit with message: `vagrant-service-manager setting dev version <version>.dev`
+* Push upstream
+* Create a Github https://github.com/projectatomic/vagrant-service-manager/releases[release] and paste change log for release
+
+== Maintainers
+
+* Brian Exelbierd <bexelbie@redhat.com> @bexelbie
+* Budh Ram Gurung <bgurung@redhat.com> @budhrg
+* Hardy Ferentschik @hferentschik
+* Lalatendu Mohanty <lmohanty@redhat.com> @LalatenduMohanty
+* Navid Shaikh <nshaikh@redhat.com> @navidshaikh
+
+
+

data/README.adoc

@@ -57,7 +57,7 @@ instructions consult the
 https://github.com/projectatomic/adb-atomic-developer-bundle/blob/master/docs/installing.rst[Installation
 Documentation].
 +
-*Note:* When the vagrant-service-manager plugin is loaded and an ADB box is
+NOTE: When the vagrant-service-manager plugin is loaded and an ADB box is
 started using the VirtualBox provider, the user needs to add a routable
 non NAT network interface declaration in the Vagrantfile. If the user
 does not provide a network declaration in the Vagrantfile, a private
@@ -78,77 +78,50 @@ export DOCKER_API_VERSION=1.20
 # eval "$(vagrant service-manager env docker)"
 ----------------------------------------------------------------------------
 +
-*Note:* The required TLS certificates are copied to the host machine at
+NOTE: The required TLS certificates are copied to the host machine at
 the time of `vagrant up` itself. Every run of
 `vagrant service-manager env docker` checks for the validity of the
 certificates on the host machine by matching the certificates inside the
-box. If the certificates on the host machine are invalid, this command
+VM. If the certificates on the host machine are invalid, this command
 will also re-download the certificates onto the host machine.
 
 === Available commands
 
-The following section lists the available commands for the plugin and
-their explanation:
+The following section lists the high level commands available for the plugin,
+which enable you to:
 
-1.  `vagrant service-manager [command] [--help | -h]`
-+
+- set up your environment variables and get the TLS certificates to secure the
+Docker communication channel
+- identify the routable ip address as well as the version of your VM
+- and manage the life cycle of the configured services
+
+For a detailed list of all available commands and their explanations refer
+ to the link:commands.adoc[Commands Document].
+
+- `vagrant service-manager [command] [--help | -h]` +
 Displays the possible commands, options and other relevant information
-for the vagrant-service-manager plugin. If a `command` is specified,
-only the help relevant to that command is displayed.
+for the vagrant-service-manager plugin.
 
-1.  `vagrant service-manager env [service] [--script-readable]`
-+
-Displays connection information for all active services in the box in a
-manner that can be evaluated in a shell. +
-If a `service` is specified, only the information for that service is displayed.
-The supported services are: Docker, OpenShift. +
-When `--script-readable` is specified the output is in `key=value` format. +
-In the case of the _docker_ service, the required TLS certificates for securing the Docker
-communication will be regenerated and copied to the host as part of the command execution.
-If existing certificates are found to be invalid, they get regenerated.
-
-1.  `vagrant service-manager box [command] [--script-readable]`
-+
-Displays box related information like release version, IP etc.
-+
-The possible options for `command` are:
+-  `vagrant service-manager env [service] [--script-readable]` +
+Displays connection information for all active services in the VM, in a
+manner that can be evaluated in a shell.
 
-* `version`: Displays the version and release information of the running VM.
-* `ip`: Displays the routable IP address of the running VM.
-+
-When `--script-readable` is specified the output is in `key=value` format.
+-  `vagrant service-manager box [command] [--script-readable]` +
+Displays VM related information like release version, IP, etc.
 
-1.  `vagrant service-manager [operation] [service]`
-+
+-  `vagrant service-manager [operation] [service]` +
 Manages the life cycle of a service.
-+
-The possible options for `operation` are:
-
-  * `status`: Lists services and their running state. If a `service` is specified only
-the status of that service is displayed. If no service is provided then
-only supported orchestrators are reported.
-  * `start`: Start the given service in the box.
-  * `stop`: Stop the given service in the box.
-  * `restart`: Restart the given service in the box.
-+
-The supported options for `service` are `docker` and `openshift`.
 
-1. `vagrant service-manager install-cli [service]`
-+
-Install the client binary for the specified `service`. Binaries are per default downloaded to
-`$VAGRANT_HOME/data/service-manager/bin/<service>/<cli-version>`, where `$VAGRANT_HOME` defaults to
-`.vagrant.d` in your home directory.
-+
-The supported options for `service` are `docker` and `openshift`.
+- `vagrant service-manager install-cli [service]` +
+Installs the client binary for the specified service.
 
 [[debug-flag]]
 ==== Debug Flag
 
 Append `--debug` flag to enable debug mode.
 
-*Note:* Debug output from `vagrant-service-manager` is prepended with
+NOTE: Debug output from `vagrant-service-manager` is prepended with
 the following string:
-
 `DEBUG command: [ service-manager: <command name / log message> ]`
 
 === Exit codes
@@ -207,7 +180,8 @@ As most other open-source projects, vagrant-service-manager has a set of convent
 about how to write code for it. It follows the
 https://github.com/bbatsov/ruby-style-guide[Ruby Style Guide].
 
-You can verify that your changes adhere to this style using the http://batsov.com/rubocop[RuboCop] Rake task:
+You can verify that your changes adhere to this style using the
+ http://batsov.com/rubocop[RuboCop] Rake task:
 
 --------------------------
 $ bundle exec rake rubocop
@@ -239,7 +213,7 @@ acceptance tests. They can be run via:
 $ bundle exec rake features
 ---------------------------
 
-*Note:* This Cucumber tests do not run on Windows, pending resolution of
+NOTE: These Cucumber tests do not run on Windows, pending resolution of
 https://github.com/projectatomic/vagrant-service-manager/issues/213[Issue #213].
 
 Per default, only the scenarios for ADB in combination with the

data/commands.adoc

@@ -0,0 +1,272 @@
+= Available Commands and Examples
+:toc:
+:toc-placement!:
+
+Once you start the virtual machine using `vagrant up`, you can use
+ vagrant-service-manager to manage your development environment.
+
+'''
+toc::[]
+'''
+
+You can use vagrant-service-manager to set up your environment variables and
+ get the TLS certificates to secure the Docker communication channel; identify
+ the routable ip address and version of your VM; and check the status and
+ manage the life cycle of the configured services in the development environment.
+
+To run the vagrant-service-manager plugin use: +
+-------------------------------------------
+vagrant service-manager [command] [options]
+-------------------------------------------
+The following commands can be used: +
+
+`env`::  Displays the connection information for services in the VM +
+`box`:: Displays the VM related information like version, release, IP etc +
+`status`:: Lists services and their running state +
+`start`:: Starts the given service in the VM +
+`stop`:: Stops the given service in the VM +
+`restart`:: Restarts the given service in the VM +
+
+The following options can be used: +
+
+`--script-readable`:: Displays information in a key=value format +
+`-h, --help`:: Prints help for the specific command being run +
+
+
+== Set Environment Variables and Get Certificates
+
+If you need to set the environment variables and get the certificates for all
+ active services in the VM, run: +
+
+`$ vagrant service-manager env` +
+
+Usage: `vagrant service-manager env [service] [options]`
+
+The possible options for service are `docker` and `openshift`. +
+If no service is specified `vagrant service-manager env` provides connection
+ information for all active services.
+
+The following options can be used: +
+
+`--script-readable`:: Displays information in a key=value format +
+`-h, --help`:: Prints help for the specific command being run. +
+
+=== Examples
+
+If you need connection information for all active services in the VM, in a
+manner that can be evaluated in a shell, use:
+-----------------------------------------------------------------------------
+$ vagrant service-manager env
+
+# docker env:
+# Set the following environment variables to enable access to the
+# docker daemon running inside of the vagrant virtual machine:
+export DOCKER_HOST=tcp://10.1.2.2:2376
+export DOCKER_CERT_PATH=/foo/bar/.vagrant/machines/default/virtualbox/docker
+export DOCKER_TLS_VERIFY=1
+export DOCKER_API_VERSION=1.21
+
+# openshift env:
+# You can access the OpenShift console on: https://10.1.2.2:8443/console
+# To use OpenShift CLI, run: oc login https://10.1.2.2:8443
+export OPENSHIFT_URL=https://10.1.2.2:8443
+export OPENSHIFT_WEB_CONSOLE=https://10.1.2.2:8443/console
+export DOCKER_REGISTRY=hub.openshift.centos7-adb.10.1.2.2.xip.io
+
+# run following command to configure your shell:
+# eval "$(vagrant service-manager env)"
+-----------------------------------------------------------------------------
+
+If you would like to get the environment variables, and if applicable,
+ certificates for a specific service, specify the service name. For example, for
+ Docker use: +
+
+----------------------------------------------------------------------------
+$ vagrant service-manager env docker
+# Set the following environment variables to enable access to the
+# docker daemon running inside of the vagrant virtual machine:
+export DOCKER_HOST=tcp://172.28.128.3:2376
+export DOCKER_CERT_PATH=/foo/bar/.vagrant/machines/default/virtualbox/docker
+export DOCKER_TLS_VERIFY=1
+export DOCKER_API_VERSION=1.21
+
+# run following command to configure your shell:
+# eval "$(vagrant service-manager env docker)"
+----------------------------------------------------------------------------
+
+NOTE: The `env` command checks to make sure that the TLS certificate on the host
+ used with docker is valid. If it is invalid, the command will automatically
+ regenerate the docker TLS certificate and copy the new certificate to the host.
+
+Similarly, for OpenShift you can use: +
+`$ vagrant service-manager env openshift`
+
+If you want to run the plugin and get the environment variables and certificates
+ for docker in key=value format, use:
+----------------------------------------------------------------------
+$ vagrant service-manager env docker --script-readable
+DOCKER_HOST=tcp://172.28.128.3:2376
+DOCKER_CERT_PATH=/foo/bar/.vagrant/machines/default/virtualbox/docker'
+DOCKER_TLS_VERIFY=1
+DOCKER_API_VERSION=1.21
+----------------------------------------------------------------------
+
+
+== Get IP Address and Version Information
+
+If you need information about the development environment, such as the routable
+IP address or the version and release information, use:
+
+`$ vagrant service-manager box` +
+
+Usage: `vagrant service-manager box [sub-command] [options]`
+
+The following sub-commands can be used: +
+
+`ip`:: Displays the routable IP address of the VM +
+`version`:: Displays the version and release information of the VM +
+
+The following options can be used: +
+
+`--script-readable`:: Displays information in a key=value format +
+`-h, --help`:: Prints help for the specific command being run.
+
+=== Examples
+
+To check the routable IP address of the VM:
+---------------------------------
+$ vagrant service-manager box ip
+172.28.128.3
+---------------------------------
+
+To check the routable IP address of the VM in key=value format:
+---------------------------------------------------
+$ vagrant service-manager box ip --script-readable
+IP=172.28.128.3
+---------------------------------------------------
+
+To check the version information:
+--------------------------------------
+$ vagrant service-manager box version
+Atomic Developer Bundle (ADB) 2.2.0
+--------------------------------------
+
+To get the version information in key=value format:
+--------------------------------------------------------
+$ vagrant service-manager box version --script-readable
+VARIANT="Atomic Developer Bundle (ADB)"
+VARIANT_ID="adb"
+VARIANT_VERSION="2.2.0"
+--------------------------------------------------------
+
+
+== Manage Services
+
+If you need to check the status, start, stop or restart a specific service use: +
+`$ vagrant service-manager [sub-command] [service]`
+
+The following sub-commands can be used: +
+
+`status`::   Lists services and their state (running/stopped) +
+`start`::   Starts the given service in the VM +
+`stop`::   Stops the given service in the VM +
+`restart`::   Restarts the given service in the VM +
+
+The possible options for service are `docker`, `openshift` and `kubernetes`.
+
+=== Examples
+
+If no service is specified `vagrant service-manager status` will provide
+information on all the configured services and their state (running/stopped).
+---------------------------------------
+$ vagrant service-manager status
+Configured services:
+docker - running
+openshift - stopped
+kubernetes - stopped
+---------------------------------------
+
+To check the status of Docker:
+-------------------------------------------
+$ vagrant service-manager status docker
+docker - running
+-------------------------------------------
+
+To start Docker, if it is stopped:
+---------------------------------------------
+$ vagrant service-manager start docker
+$ vagrant service-manager status docker
+docker - running
+---------------------------------------------
+
+To stop Docker:
+---------------------------------------------
+$ vagrant service-manager stop docker
+$ vagrant service-manager status docker
+docker - stopped
+---------------------------------------------
+
+To restart Docker:
+-----------------------------------------
+$ vagrant service-manager restart docker
+$ vagrant service-manager status docker
+docker - running
+-----------------------------------------
+
+Similarly, you can use `$ vagrant service-manager status openshift`,
+ `$ vagrant service-manager start openshift`, `$ vagrant service-manager stop openshift`,
+ and `$ vagrant service-manager restart openshift`, to verify the status, start,
+  stop and restart OpenShift.
+
+
+== Install CLI
+
+If you need to install the client binary for a specified service, use: +
+
+`vagrant service-manager install-cli [service]` +
+
+The possible options for service are `docker` and `openshift`. +
+
+As per default, binaries are downloaded to
+ `$VAGRANT_HOME/data/service-manager/bin/<service>/<cli-version>`, where
+ `$VAGRANT_HOME` defaults to `.vagrant.d` in your home directory.
+
+=== Example
+
+To install client binary for Docker:
+
+----------------------------------------------------------------------------------------------------
+$ vagrant service-manager install-cli docker
+# Binary already available at /home/johndoe/.vagrant.d/data/service-manager/bin/docker/1.9.1/docker
+# run binary as:
+# docker <command>
+export PATH=/home/johndoe/.vagrant.d/data/service-manager/bin/docker/1.9.1:$PATH
+
+# run following command to configure your shell:
+# eval "$(VAGRANT_NO_COLOR=1 vagrant service-manager install-cli docker | tr -d '\r')"
+----------------------------------------------------------------------------------------------------
+
+
+== Access Help
+If you need information on the possible commands, options and other relevant
+information for the vagrant-service-manager plugin, access the help by using
+`--help` or `-h` as is shown below:
+
+--------------------------------------------------------------------------------
+$ vagrant service-manager [--help | -h]
+Usage: vagrant service-manager <command> [options]
+
+The following commands can be used:
+env: displays connection information for services in the VM
+box: displays VM related information like version, release, IP etc
+status: lists services and their running state
+start: starts the given service in the VM
+stop: stops the given service in the VM
+restart: restarts the given service in the VM
+
+The following options can be used:
+--script-readable : Displays information in a key=value format
+-h, --help   print this help
+
+For help on any individual command run `vagrant service-manager <command> -h`
+--------------------------------------------------------------------------------

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

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module ServiceManager
-    VERSION = '1.2.0'.freeze
+    VERSION = '1.2.1'.freeze
   end
 end

data/vagrant-service-manager.gemspec

@@ -16,4 +16,6 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.require_paths = ['lib']
+
+  spec.add_dependency 'rubyzip', '~> 1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-service-manager
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Brian Exelbierd
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
-dependencies: []
+date: 2016-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 description: Provides setup information, including environment variables and certificates,
   required to access services provided by ADB/CDK.
 email:
@@ -33,9 +47,9 @@ files:
 - CONTRIBUTING.adoc
 - Gemfile
 - LICENSE
-- MAINTAINERS
 - README.adoc
 - Rakefile
+- commands.adoc
 - features/box-command.feature
 - features/env-command.feature
 - features/help-command.feature

data/MAINTAINERS

@@ -1,17 +0,0 @@
-Brian Exelbierd <bexelbie@redhat.com> @bexelbie
-Navid Shaikh <nshaikh@redhat.com> @navidshaikh
-Lalatendu Mohanty <lmohanty@redhat.com> @LalatenduMohanty
-Budh Ram Gurung <bgurung@redhat.com> @budhrg
-
-## How to release the vagrant-service-manager plugin
-
-1. Create gemfile in `pkg` directory by running `rake build`
-
-2. Increment the Version Number.
-
-3. Release the plugin by running `rake release`
-
-4. Tag the release commit with a vX.Y.Z tag.
-
-5. Create a Github release.
-