Metadata-Version: 1.1
Name: cloudmesh-vagrant
Version: 1.2.2
Summary: cloudmesh_vagrant - A real simple interface to virtualbox via vagrant
Home-page: https://github.com/cloudmesh/cloudmesh_vagrant
Author: Gregor von Laszewski
Author-email: laszewski@gmail.com
License: Apache License, Version 2.0
Description: Cloudmesh Virtualbox/Vagrant Interface
        =======================================
        
        Virtualbox provides a vonvenient way to manage virtual machines on a
        local computer. Graphical user interfaces, a commandline client, but
        also vagrant exist to access them. However we noticed that we often
        only need a very small subset to start a vm and to tear it
        down. Remembering the interfaces is difficult. Previously we developed
        a cloudmesh_client that has an easy to remember interface. We leverage
        from this experience and introduce a very easy to remember commandline
        client. At the same time we also allow a simpl python API to manage
        virtual machines on virtualbox. We use vagrant internally. However
        vagrants focus on directories and Vagrantfiles in a bit inconvenient
        also fo us, so we provided wrappers and utelize the design of vagrant
        to our advantage while only exposing the needed functionality.
        
        Manual Page
        ------------
        
        ::
        
            Usage:
              cm-vbox version [--format=FORMAT]
              cm-vbox image list [--format=FORMAT]
              cm-vbox image find NAME
              cm-vbox image add NAME
              cm-vbox vm list [--format=FORMAT] [-v]
              cm-vbox vm delete NAME
              cm-vbox vm config NAME
              cm-vbox vm ip NAME [--all]
              cm-vbox create NAME ([--memory=MEMORY]
                                   [--image=IMAGE]
                                   [--script=SCRIPT] | list)
              cm-vbox vm boot NAME ([--memory=MEMORY]
                                    [--image=IMAGE]
                                    [--port=PORT]
                                    [--script=SCRIPT] | list)
              cm-vbox vm ssh NAME [-e COMMAND]
              cm-vbox -h | --help
        
        Source Code
        -----------
        
        * github.com/cloudmesh/vagrant
        
        Prerequisits
        -------------
        
        Make sure you have the python development libraries and pip installed
        
        Ubuntu
        ^^^^^^
        
        ::
        
            sudo apt-get install python-dev
            sudo apt-get install python-pip
        
        Inastall from pip
        ------------------
        
        ::
        
            pip install cloudmesh_vagrant
        
        Install from github
        --------------------
        
        ::
        
            mkdir cloudmesh
            cd cloudmesh
            git clone https://github.com/cloudmesh/vagrant
            cd vagrant
            python setup.py install
        
        
        Examples
        --------
        
        Listing vms
        ^^^^^^^^^^^
        
        List the vms::
        
            cm-vbox vm list
        
        +------+---------+---------+------------+----------------------+
        | name | state   | id      | provider   | directory            |
        +------+---------+---------+------------+----------------------+
        | w12  | running | 47347b4 | virtualbox | ~/w12                |
        | w1   | running | db913dd | virtualbox | ~/w1                 |
        +------+---------+---------+------------+----------------------+
        
        Listing images
        ^^^^^^^^^^^^^^
        
        List the images::
        
            cm-vbox image list
        
        +-----------------+------------+--------------+
        | name            | provider   | date         |
        +-----------------+------------+--------------+
        | ubuntu/trusty64 | virtualbox | 20160406.0.0 |
        +-----------------+------------+--------------+
        
        Booting vms
        ^^^^^^^^^^^
        
        Start a vm while taking an ubuntu image as default::
        
            cm-vbox vm boot w12
        
        
        Login
        ^^^^^
        
        To login into a vm you can use the ssh command followed by the VM::
        
            cm-vbox vm ssh w12
        
        where w12 is the name of the vm.
        
        Executing a command
        ^^^^^^^^^^^^^^^^^^^
        
        To just execute a command, use::
        
            cm-vbox vm ssh w12 -e uname
        
        
        Destroy a vm
        ^^^^^^^^^^^^^
        
        Deletes the specified vm::
        
            cm-vbox vm delete w12
        
        
        Create a Vagrantfile
        ^^^^^^^^^^^^^^^^^^^^
        
        Creates a Vagrantfile in ./w12/Vagrantfile::
        
           cm-vbox create w12
        
        
        Destroy the directory of the vm
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        Assume you like to destroy also the directory with all information about the previously
        run vm you can simple delete it with rm::
        
          cm-vbox vm delete w12
          rm -r w12
        
        Please not that wen you delet the directory the list command will automatically remove
        it from the available vms. Hoewver before you delete it is advisable to destroy the vm
        so you do not have the vm any longer running.
        
        
        
Keywords: cloud cmd commandshell plugins cloudmesh vagrant virtualbox
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: System :: Clustering
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Environment :: Console
