vagrant-service-manager

Table of Contents

$ vagrant plugin install vagrant-service-manager

1. Install vagrant-service-manager plugin:

   vagrant plugin install vagrant-service-manager

2. Download the relevant Vagrantfile for your ADB vagrant box, from the repository. For further details on the usage of custom Vagrantfiles designed for specific use cases, refer to the Download ADB section in the Installing ADB Documentation.

3. Start the ADB vagrant box using vagrant up. For detailed instructions consult the Installation Documentation.

   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 DHCP network is added by default and a warning is displayed.

4. Run the plugin to get the environment variables and certificates:

   $ 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.182:2376
   export DOCKER_CERT_PATH=/foo/bar/.vagrant/machines/default/virtualbox/docker
   export DOCKER_TLS_VERIFY=1
   export DOCKER_API_VERSION=1.20
   
   # run following command to configure your shell:
   # eval "$(vagrant service-manager env docker)"

   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 VM. If the certificates on the host machine are invalid, this command will also re-download the certificates onto the host machine.

For a detailed list of all available commands and their explanations refer to the Commands Document.
The following section lists the high level commands available for the plugin. which enable you to 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.

• vagrant service-manager [command] [--help | -h]
  Displays the possible commands, options and other relevant information for the vagrant-service-manager plugin.

• 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.

• vagrant service-manager box [command] [--script-readable]
  Displays VM related information like release version, IP, etc.

• vagrant service-manager [operation] [service]
  Manages the life cycle of a service.

• vagrant service-manager install-cli [service]
  Installs the client binary for the specified service.

The following table lists the plugin’s exit codes and their meaning:

There is no standardized way of detecting 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.

In an environment where the HTTP traffic needs to pass through an HTTP proxy server, set the proxy, proxy_user and proxy_password proxy configurations in the Vagrantfiles to enable services like Docker and OpenShift to function correctly.
You can do so via:

When these settings are applied, they are passed through to the Docker and OpenShift services. In an unauthenticated proxy environment, the proxy_user and proxy_password configurations can be omitted.

Note	http_proxy, http_proxy_user and http_proxy_password have been depreacted now.

The vagrant-service-manager helps you configure the service of your choice:

1. Enable the desired service(s) in the ADB Vagrantfile as:

   config.servicemanager.services = "openshift"

   Note

   Docker is the default service for the Atomic Developer Bundle and does not require any configuration to ensure it is started whereas, the Red Hat Enterprise Linux Container Development Kit, which is based on ADB, automatically starts OpenShift. You can use a comma-separated list to enable multiple services. For instance: docker, openshift.

2. Enable the relevant option for the services you have selected in the Vagrantfile. For example, specific versions of OpenShift can be set using the following variables:

   • config.servicemanager.openshift_docker_registry = "docker.io" - Specifies the registry from where the OpenShift image is pulled.

   • config.servicemanager.openshift_image_name = "openshift/origin" - Specifies the image to be used.

   • config.servicemanager.openshift_image_tag = "v1.3.0" - Specifies the version of the image to be used.

1. After cloning the repository, install the Bundler gem:

   $ gem install bundler -v 1.12.5

   Note	You need to specify version 1.12.5. It will not work with the latest version of Bundler.

2. Then setup your project dependencies:

   $ bundle install

3. The build is driven via rake. All build related tasks should be executed in the Bundler environment, for example bundle exec rake clean. You can get a list of available Rake tasks via:

   $ bundle exec rake -T

As most other open-source projects, vagrant-service-manager has a set of conventions about how to write code for it. It follows the Ruby Style Guide.

You can verify that your changes adhere to this style using the RuboCop Rake task:

The source contains a set of Minitest unit tests. They can be run as follows:

To run the entire test suite:

To run a single test:

The source also contains a set of Cucumber acceptance tests. They can be run via:

You can run a single feature specifying the path to the feature file to run via the FEATURE environment variable:

Note	These Cucumber tests do not run on Windows, pending resolution of Issue #213.

The documentation of this plugin is written in Asciidoc. If you need some syntax help, refer to the AsciiDoc Syntax Quick Reference.

To build the documentation you can execute

which will build the HTML documentation into the folder build/html.

The source code also contains a Guardfile for the Guard library. You can execute

and your HTML documentation will be automatically updated on each change to an Asciidoc source file. Live reload is also enabled, so you just need to install the right LiveReload Safari/Chrome/Firefox extension and your browser will refresh the page each time you save a change to your Asciidoc files.