Current File : //lib/python2.7/site-packages/salt/states/vagrant.pyo
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l m Z m
Z
d d l j j
Z
d Z d � Z d d � Z d � Z d � Z d
� Z d � Z d � Z d
� Z d � Z d � Z d S( u�
Manage Vagrant VMs
==================
Manange execution of Vagrant virtual machines on Salt minions.
Vagrant_ is a tool for building and managing virtual machine environments.
It can use various providers, such as VirtualBox_, Docker_, or VMware_, to run its VMs.
Vagrant provides some of the functionality of a light-weight hypervisor.
The combination of Salt modules, Vagrant running on the host, and a
virtual machine provider, gives hypervisor-like functionality for
developers who use Vagrant to quickly define their virtual environments.
.. _Vagrant: http://www.vagrantup.com/
.. _VirtualBox: https://www.virtualbox.org/
.. _Docker: https://www.docker.io/
.. _VMWare: https://www.vmware.com/
.. versionadded:: 2018.3.0
The configuration of each virtual machine is defined in a file named
``Vagrantfile`` which must exist on the VM host machine.
The essential parameters which must be defined to start a Vagrant VM
are the directory where the ``Vagrantfile`` is located \(argument ``cwd:``\),
and the username which will own the ``Vagrant box`` created for the VM \(
argument ``vagrant_runas:``\).
A single ``Vagrantfile`` may define one or more virtual machines.
Use the ``machine`` argument to chose among them. The default (blank)
value will select the ``primary`` (or only) machine in the Vagrantfile.
\[NOTE:\] Each virtual machine host must have the following:
- a working salt-minion
- a Salt sdb database configured for ``vagrant_sdb_data``.
- Vagrant installed and the ``vagrant`` command working
- a suitable VM provider
.. code-block:: yaml
# EXAMPLE:
# file /etc/salt/minion.d/vagrant_sdb.conf on the host computer
# -- this sdb database is required by the Vagrant module --
vagrant_sdb_data: # The sdb database must have this name.
driver: sqlite3 # Let's use SQLite to store the data ...
database: /var/cache/salt/vagrant.sqlite # ... in this file ...
table: sdb # ... using this table name.
create_table: True # if not present
i ( t absolute_importt print_functiont unicode_literalsN( t CommandExecutionErrort SaltInvocationErroru vagrantc C@ s d t k r t St S( u<
Only if vagrant module is available.
:return:
u vagrant.version( t __salt__t __virtualname__t False( ( ( s7 /usr/lib/python2.7/site-packages/salt/states/vagrant.pyt __virtual__A s c K@ s� i | d 6i d 6t d 6d d 6} g } t | t j � rq y t d | � rY | g } n Wqq t k
rm qq Xn | s� t d � } t j | | � } n g } g }
x� | D]� } | ry. t d | � d } | d
| k r� w� n Wqt t t f k
rqXn yW t d j
| � | | � } t | t � rA| d } n | j i | d 6| | 6� Wq� t t f k
r�}
|
j i | d 6t j
|
� d
6� q� Xq� W| s�t | d <d | d <|
r�i |
d 6| d <q�n i | | 6| d <| | d <| S( u
Helper to call the vagrant functions. Wildcards supported.
:param node: The Salt-id or wildcard
:param function: the vagrant submodule to call
:param section: the name for the state call.
:param comment: what the state reply should say
:param status_when_done: the Vagrant status expected for this state
:return: the dictionary for the state reply
u nameu changesu resultu u commentu vagrant.get_vm_infou vagrant.list_domainsu vagrant.vm_statei u stateu vagrant.{0}u nodeu issueu No changes seenu ignored( t Truet
isinstancet sixt string_typesR R t fnmatcht filtert
IndexErrorR t formatt dictt appendt text_type( t nodet functiont sectiont commentt status_when_donet kwargst rett targeted_nodest all_domainst
changed_nodest
ignored_nodest
present_statet responset err( ( s7 /usr/lib/python2.7/site-packages/salt/states/vagrant.pyt
_vagrant_callM sH "
,
c K@ s) d | k s d | k r. t | d d d d � Si | d 6i d 6t d 6d
j | � d 6} yZ t d | � } | d
d d k r� t d | � d | d | <d j | � | d <n Wnk t t f k
r t | | | � \ } } t | d <t d | | � d | d | <d j | � | d <n X| Sd S( u�
Defines and starts a new VM with specified arguments, or restart a
VM (or group of VMs). (Runs ``vagrant up``.)
:param name: the Salt_id node name you wish your VM to have.
If ``name`` contains a "?" or "*" then it will re-start a group of VMs
which have been paused or stopped.
Each machine must be initially started individually using this function
or the vagrant.init execution module call.
\[NOTE:\] Keyword arguments are silently ignored when re-starting an existing VM.
Possible keyword arguments:
- cwd: The directory (path) containing the Vagrantfile
- machine: ('') the name of the machine (in the Vagrantfile) if not default
- vagrant_runas: ('root') the username who owns the vagrantbox file
- vagrant_provider: the provider to run the VM (usually 'virtualbox')
- vm: ({}) a dictionary containing these or other keyword arguments
.. code-block:: yaml
node_name:
vagrant.running
.. code-block:: yaml
node_name:
vagrant.running:
- cwd: /projects/my_project
- vagrant_runas: my_username
- machine: machine1
u *u ?u startu restartedu Machine has been restartedu runningu nameu changesu resultu {0} is already runningu commentu vagrant.vm_statei u stateu
vagrant.startu Machine startedu Node {0} startedu vagrant.initu Node defined and startedu Node {0} defined and startedN( R" R R R R R t _find_init_change( t nameR R t info( ( s7 /usr/lib/python2.7/site-packages/salt/states/vagrant.pyt running� s( %
c K@ sU t j j j | � } d | k r: | j | j d � � n | j d d � | d <y t d | � } WnP t k
r� i } x: | j � D]( \ } } i d d 6| d 6| d | <q� Wn X| rKx� | D]� } | | p� d } | d k r� | j
| d � } | | k rD| d
k r"| d k r"q� n i | d 6| d 6| d | <qDq� q� Wn | | f S( uc
look for changes from any previous init of machine.
:return: modified ret and kwargs
u vmu
vagrant_runasu u runasu vagrant.get_vm_infou oldu newu changesu nameu machineN( t saltt utilst argst clean_kwargst updatet popR R t itemst Nonet get( R$ R R t vm_t keyt valuet new( ( s7 /usr/lib/python2.7/site-packages/salt/states/vagrant.pyR# � s(
$
)c K@ s� i | d 6i d 6t d 6d d 6} t | | | � \ } } | d i k rN | St | d <t d | | � d | d | <d j | � | d <| S(
u�
Defines a new VM with specified arguments, but does not start it.
:param name: the Salt_id node name you wish your VM to have.
Each machine must be initialized individually using this function
or the "vagrant.running" function, or the vagrant.init execution module call.
This command will not change the state of a running or paused machine.
Possible keyword arguments:
- cwd: The directory (path) containing the Vagrantfile
- machine: ('') the name of the machine (in the Vagrantfile) if not default
- vagrant_runas: ('root') the username who owns the vagrantbox file
- vagrant_provider: the provider to run the VM (usually 'virtualbox')
- vm: ({}) a dictionary containing these or other keyword arguments
.. code-block:: yaml
node_name1:
vagrant.initialized
- cwd: /projects/my_project
- vagrant_runas: my_username
- machine: machine1
node_name2:
vagrant.initialized
- cwd: /projects/my_project
- vagrant_runas: my_username
- machine: machine2
start_nodes:
vagrant.start:
- name: node_name?
u nameu changesu resultu# The VM is already correctly definedu commentu startu vagrant.initu Node initializedu! Node {0} defined but not started.( R R# R R R ( R$ R R ( ( s7 /usr/lib/python2.7/site-packages/salt/states/vagrant.pyt initialized� s %
c C@ s t | d d d d � S( u�
Stops a VM (or VMs) by shutting it (them) down nicely. (Runs ``vagrant halt``)
:param name: May be a Salt_id node, or a POSIX-style wildcard string.
.. code-block:: yaml
node_name:
vagrant.stopped
u shutdownu stoppedu Machine has been shut downu poweroff( R" ( R$ ( ( s7 /usr/lib/python2.7/site-packages/salt/states/vagrant.pyt stopped s c C@ s t | d d d d � S( uh
Stops a VM (or VMs) by power off. (Runs ``vagrant halt``.)
This method is provided for compatibility with other VM-control
state modules. For Vagrant, the action is identical with ``stopped``.
:param name: May be a Salt_id node or a POSIX-style wildcard string.
.. code-block:: yaml
node_name:
vagrant.unpowered
u stopu unpoweredu Machine has been powered offu poweroff( R" ( R$ ( ( s7 /usr/lib/python2.7/site-packages/salt/states/vagrant.pyt powered_off+ s c C@ s t | d d d � S( u�
Stops a VM (or VMs) and removes all references to it (them). (Runs ``vagrant destroy``.)
Subsequent re-use of the same machine will requere another operation of ``vagrant.running``
or a call to the ``vagrant.init`` execution module.
:param name: May be a Salt_id node or a POSIX-style wildcard string.
.. code-block:: yaml
node_name:
vagrant.destroyed
u destroyu destroyedu Machine has been removed( R" ( R$ ( ( s7 /usr/lib/python2.7/site-packages/salt/states/vagrant.pyt destroyed> s c C@ s t | d d d d � S( u�
Stores the state of a VM (or VMs) for fast restart. (Runs ``vagrant suspend``.)
:param name: May be a Salt_id node or a POSIX-style wildcard string.
.. code-block:: yaml
node_name:
vagrant.paused
u pauseu pausedu Machine has been suspendedu saved( R" ( R$ ( ( s7 /usr/lib/python2.7/site-packages/salt/states/vagrant.pyt pausedQ s c C@ s t | d d d � S( u
Reboots a running, paused, or stopped VM (or VMs). (Runs ``vagrant reload``.)
The will re-run the provisioning
:param name: May be a Salt_id node or a POSIX-style wildcard string.
.. code-block:: yaml
node_name:
vagrant.reloaded
u rebootu rebootedu Machine has been reloaded( R" ( R$ ( ( s7 /usr/lib/python2.7/site-packages/salt/states/vagrant.pyt rebooteda s ( t __doc__t
__future__R R R R
t salt.utils.argsR' t salt.exceptionsR R t salt.ext.sixt extR R R R. R" R& R# R4 R5 R6 R7 R8 R9 ( ( ( s7 /usr/lib/python2.7/site-packages/salt/states/vagrant.pyt <module>3 s 5 C 9
Mini Shell