https://github.com/peopledoc/macman

A Python script to manage your vagrant VM
https://github.com/peopledoc/macman

approved-public ghec-mig-migrated

Last synced: 17 days ago
JSON representation

A Python script to manage your vagrant VM

• Host: GitHub
• URL: https://github.com/peopledoc/macman
• Owner: peopledoc
• License: other
• Created: 2012-11-30T10:10:54.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2013-06-20T19:03:04.000Z (over 11 years ago)
• Last Synced: 2024-04-16T06:52:50.952Z (9 months ago)
• Topics: approved-public, ghec-mig-migrated
• Language: Python
• Size: 168 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
######

macman

######

``macman`` is a project-centric high-level machine manager.

.. warning::

   This project is experimental.

.. note::

   ``macman`` was created as a wrapper around Vagrant, in order to manage

   several machines at once, and not only using VirtualBox. In recent versions

   of Vagrant support multiple machines, and VirtualBox is no longer the only

   supported machine backend. So ``macman`` may be discontinued.

*******

Example

*******

.. code:: sh

   # Register a new box.

   macman register helloworld

   # Configure the VM.

   macman configure helloworld cpus=2 ram=256

   macman configure helloworld ip=10.0.0.10

   # Have a look at generated configuration.

   cat etc/macman.cfg

   # And have a look at generated Vagrantfile (Vagrant is the default).

   cat var/vm/helloworld/Vagrantfile

   # Let's use the VM.

   macman start helloworld

   macman ssh helloworld

   macman stop helloworld

   # You can manage several VMs!

   macman register goodbye

   macman configure goodbye ram=192 ip=10.0.0.11

   macman start all

   macman stop all

********

Abstract

********

This script has been created to manage all project-related machines from one

place, the project's root folder.

Key features:

* ``macman`` command focuses on most important commands.

* Configuration file if simple.

* Detailed configuration (i.e. Vagrantfile) is generated with templates.

* Operate on several VMs at once (start, stop...)

You focus on few important settings such as cpus, ram or IP adress, and

delegate the tricky things to scripts or templates) you share with your team.

************

Installation

************

With pip:

.. code:: sh

   pip install -e [email protected]:novagile/macman.git#egg=macman

********

Commands

********

* register MACHINE

* start MACHINE

* stop MACHINE

* download MACHINE

* configure MACHINE [[OPTION=VALUE] [OPTION=VALUE] ...]

  Where available options are:

  * ram: defaults to '512'.

  * vram: defaults to '16'.

  * cpus: defaults to '1'.

  * ip: defaults to '34.34.34.10'. Do not use '1' as last number because

    Vagrant will use it for your host.

  * gui: 'true' or defaults to 'nil'.

  * ssh_forward_agent: 'false' or defaults to 'true'.

* delete MACHINE

* ssh MACHINE

* restart MACHINE

**********

Ressources

**********

* Documentation: https://github.com/novagile/macman/

* PyPI page: not released yet

* Code repository: https://github.com/novagile/macman/

* Bugtracker: https://github.com/novagile/macman/issues

* Continuous integration: not setup yet