Current File : //lib/python2.7/site-packages/salt/modules/vagrant.pyc
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l
Z d d l m Z m
Z
d d l j j Z d d l m Z e j e � Z d Z d Z d � Z d � Z d
� Z d � Z d � Z d
� Z d � Z d � Z d � Z d � Z! d d � Z# d d � Z$ d d d � Z% d d d e& d d d � Z' d � Z( d � Z) d � Z* d � Z+ d � Z, e& d � Z- d � Z. d e& d � Z/ d S( ub
Work with virtual machines managed by Vagrant.
.. versionadded:: 2018.3.0
Mapping between a Salt node id and the Vagrant machine name
(and the path to the Vagrantfile where it is defined)
is stored in a Salt sdb database on the Vagrant host (minion) machine.
In order to use this module, sdb must be configured. An SQLite
database is the recommended storage method. The URI used for
the sdb lookup is "sdb://vagrant_sdb_data".
requirements:
- the VM host machine must have salt-minion, Vagrant and a vm provider installed.
- the VM host must have a valid definition for `sdb://vagrant_sdb_data`
Configuration example:
.. code-block:: yaml
# file /etc/salt/minion.d/vagrant_sdb.conf
vagrant_sdb_data:
driver: sqlite3
database: /var/cache/salt/vagrant.sqlite
table: sdb
create_table: True
i ( t absolute_importt print_functiont unicode_literalsN( t CommandExecutionErrort SaltInvocationError( t ipaddressu vagrantu sdb://vagrant_sdb_data/c C@ s) t j j j d � d k r% t d f St S( u*
run Vagrant commands if possible
u vagrantuA The vagrant module could not be loaded: vagrant command not foundN( t saltt utilst patht whicht Nonet Falset __virtualname__( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt __virtual__3 s
c C@ s d j t | � S( u�
returns string used to fetch data for "key" from the sdb store.
Salt node id's are used as the key for vm_ dicts.
u {}{}( t formatt VAGRANT_SDB_URL( t key( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt _build_sdb_uri< s c C@ s( d j | t j j | � � } t | � S( u�
returns string used to fetch id names from the sdb store.
the cwd and machine name are concatenated with '?' which should
never collide with a Salt node id -- which is important since we
will be storing both in the same table.
u {}?{}( R t osR t abspathR ( t machinet cwdR ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt _build_machine_uriF s c C@ sX t d t | � | t � | d rT t d t | d | j d d � � | t � n d S( u) store the vm_ information keyed by name u sdb.sdb_setu machineu cwdu .N( t __utils__R t __opts__R t get( t namet vm_( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt _update_vm_infoR s
c C@ sq y t d t | � t � } Wn t k
r< t d � � n X| d k sU d | k rm t d j | � � � n | S( u�
get the information for a VM.
:param name: salt_id name
:return: dictionary of {'machine': x, 'cwd': y, ...}.
u sdb.sdb_getu8 Probable sdb driver not found. Check your configuration.u machineu) No Vagrant machine defined for Salt_id {}N( R R R t KeyErrorR R
R ( R R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt get_vm_info^ s
c C@ s t d t | | � t � } | S( u�
returns the salt_id name of the Vagrant VM
:param machine: the Vagrant machine name
:param cwd: the path to Vagrantfile
:return: salt_id name
u sdb.sdb_get( R R R ( R R R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt get_machine_idp s c C@ s� yy t | � } | d rx t | d | j d d � � } y t d | t � Wqx t k
rt t d | d t � qx Xn Wn t k
r� n Xt | � } y t d | t � Wn5 t k
r� t d | i t � n t k
r� n Xd S( u�
erase the information for a VM the we are destroying.
some sdb drivers (such as the SQLite driver we expect to use)
do not have a `delete` method, so if the delete fails, we have
to replace the with a blank entry.
u machineu cwdu .u sdb.sdb_deleteu sdb.sdb_setN( R R R R R R R
t ExceptionR ( R R R t uri( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt _erase_vm_info| s"
c C@ s� | d } t j d | p d � d j | � } t d | d | j d � d | j d � d
t �} i } xP | j d � D]? } | j � j � } t | � d k ry | d
| | d <qy qy Wt j d t
| � � | S( u�
get the information for ssh communication from the new VM
:param vm_: the VM's info as we have it now
:return: dictionary of ssh stuff
u machineu' requesting vagrant ssh-config for VM %su (default)u vagrant ssh-config {}u cmd.shellt runasu runasR u cwdt ignore_retcodeu
i i i u
ssh_config=%s( t logt infoR t __salt__R t Truet splitt stript lent debugt repr( R R t cmdt replyt
ssh_configt linet tokens( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt _vagrant_ssh_config� s
c C@ s d } t d | � S( u�
Return the version of Vagrant on the minion
CLI Example:
.. code-block:: bash
salt '*' vagrant.version
u
vagrant -vu cmd.shell( R' ( R. ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt version� s
c C@ s� g } d } t d | � } t j d | � x� | j d � D]� } | j � j � } y t | d d � } Wn t t f k
r� q= n X| d } | d } t | | � } | r= | j | � q= q= W| S( u�
Return a list of the salt_id names of all available Vagrant VMs on
this host without regard to the path where they are defined.
CLI Example:
.. code-block:: bash
salt '*' vagrant.list_domains --log-level=info
The log shows information about all known Vagrant environments
on this machine. This data is cached and may not be completely
up-to-date.
u vagrant global-statusu cmd.shellu --->
u
i i i i����(
R' R% R& R) R* t intt
ValueErrort
IndexErrorR t append( t vmsR. R/ R1 R2 t _R R R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt list_domains� s
c C@ s� g } d } t d | d | �} t j d | � xb | j d � D]Q } | j � j � } t | � d k rC | d d k r� | j | d � q� qC qC W| S( u�
Return a list of machine names for active virtual machine on the host,
which are defined in the Vagrantfile at the indicated path.
CLI Example:
.. code-block:: bash
salt '*' vagrant.list_active_vms cwd=/projects/project_1
u vagrant statusu cmd.shellR u --->
u
i u runningi ( R' R% R& R) R* R+ R8 ( R R9 R. R/ R1 R2 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt list_active_vms� s c C@ s� g } d } t d | d | �} t j d | � xu | j d � D]d } | j � j � } t | � d k rC | d j d � rC | d d k r� | j | d
� q� qC qC W| S( u
Return a list of machine names for inactive virtual machine on the host,
which are defined in the Vagrantfile at the indicated path.
CLI Example:
.. code-block:: bash
salt '*' virt.list_inactive_vms cwd=/projects/project_1
u vagrant statusu cmd.shellR u --->
u
i i����u )u runningi ( R' R% R& R) R* R+ t endswithR8 ( R R9 R. R/ R1 R2 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt list_inactive_vms� s %u c
C@ sb | r/ t | � } | d } | d p) | } n$ | sM t d j | � � � n d } g } d j | � } t d | | � } t j d | � x� | j d � D]� } | j � j � } t | � d k r� | d
j d � r� yj i | d d 6d
j
| d d
!� d 6| d
j d � j d � d 6t
| d | � d 6} | j | � WqZt k
rVqZXq� q� W| S( u
Return list of information for all the vms indicating their state.
If you pass a VM name in as an argument then it will return info
for just the named VM, otherwise it will return all VMs defined by
the Vagrantfile in the `cwd` directory.
CLI Example:
.. code-block:: bash
salt '*' vagrant.vm_state <name> cwd=/projects/project_1
returns a list of dictionaries with machine name, state, provider,
and salt_id name.
.. code-block:: python
datum = {'machine': _, # Vagrant machine name,
'state': _, # string indicating machine state, like 'running'
'provider': _, # the Vagrant VM provider
'name': _} # salt_id name
Known bug: if there are multiple machines in your Vagrantfile, and you request
the status of the ``primary`` machine, which you defined by leaving the ``machine``
parameter blank, then you may receive the status of all of them.
Please specify the actual machine name for each VM if there are more than one.
u machineu cwdu. Path to Vagranfile must be defined, but cwd={}u u vagrant status {}u cmd.shellu --->
u
i i����u )i u u stateu (u provideru name( R R R R' R% R& R) R* R+ R= t joint lstript rstripR R8 R7 (
R R R R R& R. R/ R1 R2 t datum( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt vm_state s0
%
c C@ s | d k r i n | j � } | | d <| p: | j d � | d <| d sZ t d � � n | po | j d | � | d <| p� | j d | � | d <| p� | j d d � | d <t | | � | r� t j d | � t | | � } n d j | | d p� d
� } | S( u`
Initialize a new Vagrant VM.
This inputs all the information needed to start a Vagrant VM. These settings are stored in
a Salt sdb database on the Vagrant host minion and used to start, control, and query the
guest VMs. The salt_id assigned here is the key field for that database and must be unique.
:param name: The salt_id name you will use to control this VM
:param cwd: The path to the directory where the Vagrantfile is located
:param machine: The machine name in the Vagrantfile. If blank, the primary machine will be used.
:param runas: The username on the host who owns the Vagrant work files.
:param start: (default: False) Start the virtual machine now.
:param vagrant_provider: The name of a Vagrant VM provider (if not the default).
:param vm: Optionally, all the above information may be supplied in this dictionary.
:return: A string indicating success, or False.
CLI Example:
.. code-block:: bash
salt <host> vagrant.init <salt_id> /path/to/Vagrantfile
salt my_laptop vagrant.init x1 /projects/bevy_master machine=quail1
u nameu cwdu5 Path to Vagrantfile must be defined by "cwd" argumentu machineu runasu vagrant_provideru u Starting VM %su Name {} defined using VM {}u (default)N( R
t copyR R R R% R, t _startR ( R R R R# t startt vagrant_providert vmR t ret( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt initM s
c C@ s t | � } t | | � S( u�
Start (vagrant up) a virtual machine defined by salt_id name.
The machine must have been previously defined using "vagrant.init".
CLI Example:
.. code-block:: bash
salt <host> vagrant.start <salt_id>
( R RE ( R R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyRF s c C@ s> y | d } Wn& t k
r6 t d j | � � � n X| j d d � } | r^ d j | � n d } d j | | � } t d | d | j d � d
| j d � d d
�} | d k rxa | d j d � D]I } | j d � r� | j � d j d � } | | d <t | | � Pq� q� Wn | d d k r:d j | | � St S( Nu machineu) No Vagrant machine defined for Salt_id {}u vagrant_provideru u
--provider={}u vagrant up {} {}u cmd.run_allR# u runasR u cwdt output_loglevelu infou stdoutu
u ==>i u :u retcodei u( Started "{}" using Vagrant machine "{}".(
R R R R R' R) t
startswithRA R R ( R R R RG t provider_R. RI R1 ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyRE � s$
4
c C@ s
t | � S( u=
Send a soft shutdown (vagrant halt) signal to the named vm.
This does the same thing as vagrant.stop. Other-VM control
modules use "stop" and "shutdown" to differentiate between
hard and soft shutdowns.
CLI Example:
.. code-block:: bash
salt <host> vagrant.shutdown <salt_id>
( t stop( R ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt shutdown� s c C@ s] t | � } | d } d j | � } t d | d | j d � d | j d � �} | d k S( u�
Hard shutdown the virtual machine. (vagrant halt)
CLI Example:
.. code-block:: bash
salt <host> vagrant.stop <salt_id>
u machineu vagrant halt {}u cmd.retcodeR# u runasR u cwdi ( R R R' R ( R R R R. RI ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyRN � s
c C@ s] t | � } | d } d j | � } t d | d | j d � d | j d � �} | d k S( u�
Pause (vagrant suspend) the named VM.
CLI Example:
.. code-block:: bash
salt <host> vagrant.pause <salt_id>
u machineu vagrant suspend {}u cmd.retcodeR# u runasR u cwdi ( R R R' R ( R R R R. RI ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt pause� s
c C@ sr t | � } | d } | r" d n d } d j | | � } t d | d | j d � d | j d � �} | d
k S( u
Reboot a VM. (vagrant reload)
CLI Example:
.. code-block:: bash
salt <host> vagrant.reboot <salt_id> provision=True
:param name: The salt_id name you will use to control this VM
:param provision: (False) also re-run the Vagrant provisioning scripts.
u machineu --provisionu u vagrant reload {} {}u cmd.retcodeR# u runasR u cwdi ( R R R' R ( R t provisionR R t provR. RI ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt reboot� s
c C@ s� t | � } | d } d j | � } t d | d | j d � d | j d � d d �} | d
d k r� t | � d j | � St S(
u�
Destroy and delete a virtual machine. (vagrant destroy -f)
This also removes the salt_id name defined by vagrant.init.
CLI Example:
.. code-block:: bash
salt <host> vagrant.destroy <salt_id>
u machineu vagrant destroy -f {}u cmd.run_allR# u runasR u cwdRK u infou retcodei u Destroyed VM {0}( R R R' R R" R ( R R R R. RI ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt destroy� s
c C@ s t | � } t | � } y6 i | d d 6| d d 6| d d 6| d d 6} Wn2 t k
r� t d j | j d
d � � � � n X| r�d j | � } t j d
j | � � t d | � } t j d | � t j
| d t �} x� | j d � D]� } y� | j
d d d � j � }
d } d |
k rS|
j d � d } t j |
| � } nB d |
k r�|
j d � d } t j |
| j d � d � } n | | k r�t j | � | d <Pn Wq� t t t f k
r�q� Xq� Wt j d | | j d d � � n | r{yE t j j j | d � �& }
t j j j |
j � � | d <Wd QXWq{t t f k
rw} t d j | � � � q{Xn | S( u�
Retrieve hints of how you might connect to a Vagrant VM.
:param name: the salt_id of the machine
:param network_mask: a CIDR mask to search for the VM's address
:param get_private_key: (default: False) return the key used for ssh login
:return: a dict of ssh login information for the VM
CLI Example:
.. code-block:: bash
salt <host> vagrant.get_ssh_config <salt_id>
salt my_laptop vagrant.get_ssh_config quail1 network_mask=10.0.0.0/8 get_private_key=True
The returned dictionary contains:
- key_filename: the name of the private key file on the VM host computer
- ssh_username: the username to be used to log in to the VM
- ssh_host: the IP address used to log in to the VM. (This will usually be `127.0.0.1`)
- ssh_port: the TCP port used to log in to the VM. (This will often be `2222`)
- \[ip_address:\] (if `network_mask` is defined. see below)
- \[private_key:\] (if `get_private_key` is True) the private key for ssh_username
About `network_mask`:
Vagrant usually uses a redirected TCP port on its host computer to log in to a VM using ssh.
This redirected port and its IP address are "ssh_port" and "ssh_host". The ssh_host is
usually the localhost (127.0.0.1).
This makes it impossible for a third machine (such as a salt-cloud master) to contact the VM
unless the VM has another network interface defined. You will usually want a bridged network
defined by having a `config.vm.network "public_network"` statement in your `Vagrantfile`.
The IP address of the bridged adapter will typically be assigned by DHCP and unknown to you,
but you should be able to determine what IP network the address will be chosen from.
If you enter a CIDR network mask, Salt will attempt to find the VM's address for you.
The host machine will send an "ifconfig" command to the VM (using ssh to `ssh_host`:`ssh_port`)
and return the IP address of the first interface it can find which matches your mask.
u IdentityFileu key_filenameu Useru ssh_usernameu HostNameu ssh_hostu Portu ssh_portu= Insufficient SSH information to contact VM {}. Is it running?u machineu (default)u� ssh -i {IdentityFile} -p {Port} -oStrictHostKeyChecking={StrictHostKeyChecking} -oUserKnownHostsFile={UserKnownHostsFile} -oControlPath=none {User}@{HostName} ifconfigu/ Trying ssh -p {Port} {User}@{HostName} ifconfigu cmd.shellu --->
t strictu
u addr:u i u inetu inet6u /i u
ip_addressu( Network IP address in %s detected as: %su (not found)u private_keyNu- Error processing Vagrant private key file: {}( R R3 R R R R R% R& R' R t
ip_networkR R) t replaceR
t indext
ip_addresst sixt text_typeR7 t AttributeErrort TypeErrorR R t filest fopent stringutilst
to_unicodet readt OSErrort IOError( R t network_maskt get_private_keyR R0 t anst commandR/ t target_network_rangeR1 R2 t
found_addresst nxtt pkst e( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt get_ssh_config sT (
# ) (0 t __doc__t
__future__R R R t loggingR t salt.utils.filesR t salt.utils.patht salt.utils.stringutilst salt.exceptionsR R t salt.ext.sixt extRZ t salt._compatR t getLoggert __name__R% R R R
R R R R R R" R3 R4 R; R
R< R> RC R RJ RF RE RO RN RP RS RT Rn ( ( ( s8 /usr/lib/python2.7/site-packages/salt/modules/vagrant.pyt <module> sN
! = ,
Mini Shell