Current File : //usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyc
�
���^c @@ sY 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
Z d d l j
Z
d d l m Z d d l m Z m Z m Z m Z yg d d l Z d d l Z d d l Z d d l Z e j j j e j � e j j j d � k d f Z Wn e k
r1e d f Z n Xe j e! � Z" d Z# d
� Z$ d � Z% d � Z& d
� Z' d � Z( d � Z) d d d � Z+ d d d � Z, d d � Z- d d d � Z. d d d � Z/ d d d � Z0 d d d � Z1 d d d � Z2 d d d � Z3 d d d d � Z4 d � Z5 d d d � Z6 d � Z7 d d d � Z8 d d d d � Z9 d S( u�
Openstack Cloud Driver
======================
:depends: `shade>=1.19.0 <https://pypi.python.org/pypi/shade>`_
OpenStack is an open source project that is in use by a number a cloud
providers, each of which have their own ways of using it.
This OpenStack driver uses a the shade python module which is managed by the
OpenStack Infra team. This module is written to handle all the different
versions of different OpenStack tools for salt, so most commands are just passed
over to the module to handle everything.
Provider
--------
There are two ways to configure providers for this driver. The first one is to
just let shade handle everything, and configure using os-client-config_ and
setting up `/etc/openstack/clouds.yml`.
.. code-block:: yaml
clouds:
democloud:
region_name: RegionOne
auth:
username: 'demo'
password: secret
project_name: 'demo'
auth_url: 'http://openstack/identity'
And then this can be referenced in the salt provider based on the `democloud`
name.
.. code-block:: yaml
myopenstack:
driver: openstack
cloud: democloud
region_name: RegionOne
This allows for just using one configuration for salt-cloud and for any other
openstack tools which are all using `/etc/openstack/clouds.yml`
The other method allows for specifying everything in the provider config,
instead of using the extra configuration file. This will allow for passing
salt-cloud configs only through pillars for minions without having to write a
clouds.yml file on each minion.abs
.. code-block:: yaml
myopenstack:
driver: openstack
region_name: RegionOne
auth:
username: 'demo'
password: secret
project_name: 'demo'
auth_url: 'http://openstack/identity'
Or if you need to use a profile to setup some extra stuff, it can be passed as a
`profile` to use any of the vendor_ config options.
.. code-block:: yaml
myrackspace:
driver: openstack
profile: rackspace
auth:
username: rackusername
api_key: myapikey
region_name: ORD
auth_type: rackspace_apikey
And this will pull in the profile for rackspace and setup all the correct
options for the auth_url and different api versions for services.
Profile
-------
Most of the options for building servers are just passed on to the
create_server_ function from shade.
The salt specific ones are:
- ssh_key_file: The path to the ssh key that should be used to login to the machine to bootstrap it
- ssh_key_file: The name of the keypair in openstack
- userdata_template: The renderer to use if the userdata is a file that is templated. Default: False
- ssh_interface: The interface to use to login for bootstrapping: public_ips, private_ips, floating_ips, fixed_ips
.. code-block:: yaml
centos:
provider: myopenstack
image: CentOS 7
size: ds1G
ssh_key_name: mykey
ssh_key_file: /root/.ssh/id_rsa
This is the minimum setup required.
If metadata is set to make sure that the host has finished setting up the
`wait_for_metadata` can be set.
.. code-block:: yaml
centos:
provider: myopenstack
image: CentOS 7
size: ds1G
ssh_key_name: mykey
ssh_key_file: /root/.ssh/id_rsa
meta:
build_config: rack_user_only
wait_for_metadata:
rax_service_level_automation: Complete
rackconnect_automation_status: DEPLOYED
Anything else from the create_server_ docs can be passed through here.
- **image**: Image dict, name or ID to boot with. image is required
unless boot_volume is given.
- **flavor**: Flavor dict, name or ID to boot onto.
- **auto_ip**: Whether to take actions to find a routable IP for
the server. (defaults to True)
- **ips**: List of IPs to attach to the server (defaults to None)
- **ip_pool**: Name of the network or floating IP pool to get an
address from. (defaults to None)
- **root_volume**: Name or ID of a volume to boot from
(defaults to None - deprecated, use boot_volume)
- **boot_volume**: Name or ID of a volume to boot from
(defaults to None)
- **terminate_volume**: If booting from a volume, whether it should
be deleted when the server is destroyed.
(defaults to False)
- **volumes**: (optional) A list of volumes to attach to the server
- **meta**: (optional) A dict of arbitrary key/value metadata to
store for this server. Both keys and values must be
<=255 characters.
- **files**: (optional, deprecated) A dict of files to overwrite
on the server upon boot. Keys are file names (i.e.
``/etc/passwd``) and values
are the file contents (either as a string or as a
file-like object). A maximum of five entries is allowed,
and each file must be 10k or less.
- **reservation_id**: a UUID for the set of servers being requested.
- **min_count**: (optional extension) The minimum number of
servers to launch.
- **max_count**: (optional extension) The maximum number of
servers to launch.
- **security_groups**: A list of security group names
- **userdata**: user data to pass to be exposed by the metadata
server this can be a file type object as well or a
string.
- **key_name**: (optional extension) name of previously created
keypair to inject into the instance.
- **availability_zone**: Name of the availability zone for instance
placement.
- **block_device_mapping**: (optional) A dict of block
device mappings for this server.
- **block_device_mapping_v2**: (optional) A dict of block
device mappings for this server.
- **nics**: (optional extension) an ordered list of nics to be
added to this server, with information about
connected networks, fixed IPs, port etc.
- **scheduler_hints**: (optional extension) arbitrary key-value pairs
specified by the client to help boot an instance
- **config_drive**: (optional extension) value for config drive
either boolean, or volume-id
- **disk_config**: (optional extension) control how the disk is
partitioned when the server is created. possible
values are 'AUTO' or 'MANUAL'.
- **admin_pass**: (optional extension) add a user supplied admin
password.
- **timeout**: (optional) Seconds to wait, defaults to 60.
See the ``wait`` parameter.
- **reuse_ips**: (optional) Whether to attempt to reuse pre-existing
floating ips should a floating IP be
needed (defaults to True)
- **network**: (optional) Network dict or name or ID to attach the
server to. Mutually exclusive with the nics parameter.
Can also be be a list of network names or IDs or
network dicts.
- **boot_from_volume**: Whether to boot from volume. 'boot_volume'
implies True, but boot_from_volume=True with
no boot_volume is valid and will create a
volume from the image and use that.
- **volume_size**: When booting an image from volume, how big should
the created volume be? Defaults to 50.
- **nat_destination**: Which network should a created floating IP
be attached to, if it's not possible to
infer from the cloud's configuration.
(Optional, defaults to None)
- **group**: ServerGroup dict, name or id to boot the server in.
If a group is provided in both scheduler_hints and in
the group param, the group param will win.
(Optional, defaults to None)
.. note::
If there is anything added, that is not in this list, it can be added to an `extras`
dictionary for the profile, and that will be to the create_server function.
.. _create_server: https://docs.openstack.org/shade/latest/user/usage.html#shade.OpenStackCloud.create_server
.. _vendor: https://docs.openstack.org/os-client-config/latest/user/vendor-support.html
.. _os-client-config: https://docs.openstack.org/os-client-config/latest/user/configuration.html#config-files
i ( t absolute_importt print_functiont unicode_literalsN( t six( t SaltCloudSystemExitt SaltCloudExecutionTimeoutt SaltCloudExecutionFailuret SaltCloudConfigErroru 1.19.0u0 Please install newer version of shade: >= 1.19.0u# Install pypi module shade >= 1.19.0u openstackc C@ s* t � t k r t St � t k r& t St S( u*
Check for OpenStack dependencies
( t get_configured_providert Falset get_dependenciest HAS_SHADEt __virtualname__( ( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt __virtual__� s
c C@ s> t j t t p t d � } | r% | St j t t p7 t d � S( u/
Return the first configured instance.
u authu region_nameu cloud( u authu region_name( u cloudu region_name( t configt is_provider_configuredt __opts__t __active_provider_name__R ( t provider( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyR s c C@ sr t s t j d � t St t d � rF t d rF t j t d � t Si t d d 6t d d 6} t j t | � S( u*
Warn if dependencies aren't met.
u "shade" not foundu __len__i i u shadeu os_client_config( R t logt warningR t hasattrR t check_driver_dependenciesR ( t deps( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyR
s
c C@ s� t j d | t d d d t �} t j } | d k rB t j } n x= | D]5 } y t j | | � | SWqI t k
r} qI qI XqI Wt S( uT
Return the preferred Internet protocol. Either 'ipv4' (default) or 'ipv6'.
u protocolt defaultu ipv4t
search_globalu ipv6( R t get_cloud_config_valueR R t sockett AF_INETt AF_INET6t inet_ptont Exception( t vm_t ipst protot familyt ip( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt preferred_ip( s
c C@ s t j d | t d d d t �S( uj
Return the ssh_interface type to connect to. Either 'public_ips' (default)
or 'private_ips'.
u
ssh_interfaceR u
public_ipsR ( R R R R ( R ( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt
ssh_interface< s c C@ s� t t k r t t St � } | j d d � } | d k r] t d t j j | � | � } n t j
j d d | � } t d k r� | t t <n | S( u5
Return a conn object for the passed VM data
u profileu dictupdate.updatet cloud_configN( R t __context__R t popt Nonet __utils__t os_client_configt vendorst get_profilet shadet openstackcloudt OpenStackCloud( R t profilet conn( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt get_connD s "
c
C@ s� | d k r t d � � n i } xY t d | � j � D]B \ } } x3 d
D]+ } | j | i � j | | j | � � qJ Wq7 W| S( ux
Return a list of VMs
CLI Example
.. code-block:: bash
salt-cloud -f list_nodes myopenstack
u actionu= The list_nodes function must be called with -f or --function.R3 u idu nameu sizeu stateu private_ipsu
public_ipsu floating_ipsu fixed_ipsu image( u idu nameu sizeu stateu private_ipsu
public_ipsu floating_ipsu fixed_ipsu image( R t list_nodes_fullt itemst
setdefaultt get( R3 t callt rett nodet infot key( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt
list_nodesT s "
-c C@ s{ | d k r t d � � n | d k r3 t � } n i } x; | j d t � D]' } i | j d 6| j d 6| | j <qL W| S( u�
Return a list of VMs with minimal information
CLI Example
.. code-block:: bash
salt-cloud -f list_nodes_min myopenstack
u actionuA The list_nodes_min function must be called with -f or --function.t bareu idu stateN( R R* R4 t list_serverst Truet idt statust name( R3 R9 R: R; ( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt list_nodes_mink s %u publicc C@ s� g } x� | j j � D]� \ } } x� | D]� } | d k rd | | j d � k rd | j | d � q) | d k r� t d | d � r� | j | d � q) | d k r) t d | d � r) | j | d � q) q) Wq W| S( Nu floatingu fixedu OS-EXT-IPS:typeu addru publicu cloud.is_public_ipu private( u floatingu fixed( t addressesR6 R8 t appendR+ ( R; t addr_typeR: t _t interfacet addr( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt _get_ips� s
! ! c C@ s� | d k r t d � � n | d k r3 t � } n i } xF| j d t � D]2} t | � | | j <| j | | j d <| j | | j d <| j j | | j d <| j | | j d <t
| d � | | j d <t
| d
� | | j d <t
| d � | | j d
<t
| d � | | j d <t | j t
j � rL| j | | j d <qL t | j | j j � d | j j � | | j d <qL W| S( u�
Return a list of VMs with all the information about them
CLI Example
.. code-block:: bash
salt-cloud -f list_nodes_full myopenstack
u actionuB The list_nodes_full function must be called with -f or --function.t detailedu idu nameu sizeu stateu privateu private_ipsu publicu
public_ipsu floatingu floating_ipsu fixedu fixed_ipsu imageN( R R* R4 R@ RA t dictRD RB t flavorRC RL t
isinstancet imageR t string_typest getattrt get_image( R3 R9 R: R; ( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyR5 � s( 6c C@ s< | d k r t d � � n t d t | d � t d | � S( u�
Return a list of VMs with the fields from `query.selection`
CLI Example
.. code-block:: bash
salt-cloud -f list_nodes_full myopenstack
u actionuD The list_nodes_select function must be called with -f or --function.u cloud.list_nodes_selectu functionu query.selection( R R+ R> R ( R3 R9 ( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt list_nodes_select� s
c C@ s7 | d k r t d � � n | d k r3 t � } n | j | d t �} t | � } | j | d <| j | d <| j | j j � j | d <| j
| d <t | d � | d <t | d
� | d <t | d � | d
<t | d � | d <t | j
t j � r| j
| d <n+ t | j | j
j � d | j
j � | d <| S( u�
Get VM on this OpenStack account
name
name of the instance
CLI Example
.. code-block:: bash
salt-cloud -a show_instance myserver
u actionu< The show_instance action must be called with -a or --action.R? u idu nameu sizeu stateu privateu private_ipsu publicu
public_ipsu floatingu floating_ipsu fixedu fixed_ipsu imageN( R R* R4 t
get_serverRA RN RB RD t
get_flavorRO RC RL RP RQ R RR RS RT ( RD R3 R9 R; R: ( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt
show_instance� s&
+c C@ s= | d k r t d � � n | d k r3 t � } n | j � S( u�
List available images for OpenStack
CLI Example
.. code-block:: bash
salt-cloud -f avail_images myopenstack
salt-cloud --list-images myopenstack
u actionu` The avail_images function must be called with -f or --function, or with the --list-images optionN( R R* R4 t list_images( R3 R9 ( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt avail_images� s c C@ s= | d k r t d � � n | d k r3 t � } n | j � S( u�
List available sizes for OpenStack
CLI Example
.. code-block:: bash
salt-cloud -f avail_sizes myopenstack
salt-cloud --list-sizes myopenstack
u actionu^ The avail_sizes function must be called with -f or --function, or with the --list-sizes optionN( R R* R4 t list_flavors( R3 R9 ( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt avail_sizes s c C@ s= | d k r t d � � n | d k r3 t � } n | j � S( u�
List networks for OpenStack
CLI Example
.. code-block:: bash
salt-cloud -f list_networks myopenstack
u actionu? The list_networks function must be called with -f or --functionN( R R* R4 t
list_networks( R3 R9 ( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyR] s c C@ s� | d k r t d � � n | d k r3 t � } n | d k sZ t | t � ri d | k ri t d � � n | j d i | d d 6� S( u�
List subnets in a virtual network
network
network to list subnets of
.. code-block:: bash
salt-cloud -f list_subnets myopenstack network=salt-net
u actionu? The list_subnets function must be called with -f or --function.u networku A `network` must be specifiedt filtersN( R R* R4 RP RN t list_subnets( R3 R9 t kwargs( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyR_ . s ' c K@ s� i t j d 6t j d 6t j d 6t d 6t d 6t j d 6t j d 6t j d 6t d 6t d
6t d 6t d 6t j d
6t d 6t j d 6t j d 6t d 6t d 6t d 6t d 6t d 6t j d 6t j d 6t d 6t d 6t d 6t d 6t d 6t d 6t j d 6t j d 6t j d 6} | j d! i � } xr t j | j � � D][ \ } } | | k r�t | | | � riq8n t
j d" | | | | � n | j | � q8Wt d# | | � S($ u5
Sanatize kwargs to be sent to create_server
u nameu imageu flavoru auto_ipu ipsu ip_poolu root_volumeu boot_volumeu terminate_volumeu volumesu metau filesu reservation_idu security_groupsu key_nameu availability_zoneu block_device_mappingu block_device_mapping_v2u nicsu scheduler_hintsu config_driveu disk_configu
admin_passu waitu timeoutu reuse_ipsu networku boot_from_volumeu volume_sizeu nat_destinationu groupu userdatau extrau Error %s: %s is not of type %su dictupdate.update(
R RR t boolt listRN t intR) t iteritemst copyRP R t errorR+ ( R` t
VALID_OPTSt extraR= t value( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt _clean_create_kwargsH sR
" c
C@ s� | d k r t d � � n t j | � } t j d | d � t d | d d � t � } t j d | t d t
d d
�} | d
k rt j
j | � ry@ t d
| d � �' } t d t | | j � � | d <Wd
QXWqt k
r} t j d | | � qXn d | k r)| j d � | d <n t j d | t d t
d d
�| d <t | d <y | j t | � � Wn_ t j j k
r�} t j d | d | � t | d d | d d �t t j | � � � n Xt | d d | d d �S( u)
Request an instance to be built
u functionu? The request_instance action must be called with -a or --action.u Creating Cloud VM %su nameu cloud.check_nameu a-zA-Z0-9._-u userdataR R u files.fopenu ru cloud.userdata_templateNu# Failed to read userdata from %s: %su sizeu flavoru ssh_key_nameu key_nameu waitu Error creating server %s: %sR3 R9 u action( R Re t deepcopyR R< R+ R4 R R R R R* t ost patht isfilet readR t exceptionR) RA t
create_serverRj R/ t exct OpenStackCloudExceptionRf t destroyR t text_typeRX ( R R3 R9 R` t userdatat fp_Rr ( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt request_instancex s: #
c
@ s� t j d | t � } t j d | t d t d d# �} | d# k rm t j j | � rm t d j | � � � n | | d <t
d d d d
j | d � d t
d
d | d d d d g � d t d d t d �t � � d | k rBd | k r[d | k r[t j
d | d � t
d t j d | t � � \ | d <| d <q[n t d � d d d | � t | j d | d � d � d d �} t j
d � � f d! � } y t
d" | d | �} Wn\ t t f k
r} z* y t | d � Wn t k
r�n XWd# t t j | � � � Xn Xt j
d$ | � t
d% | t � } t | | | � } t j
d& | � | sst d' � � n | | d( <| | d) <t
d* | t � } | j | � t j d+ | d � t j
d, | d t j | � � i | d d 6| d d 6| d d 6| d- d 6| d. d. 6| d/ d/ 6| d0 d0 6| d1 d1 6}
t
d d d2 d3 j | d � d t
d
d4 |
t |
� � d t d d t d �t
d5 | d | d d6 | d � | S(7 u-
Create a single VM from a data dict
u deployu ssh_key_fileR R u- The defined ssh_key_file '{0}' does not existu key_filenameu cloud.fire_eventu eventu starting createu salt/cloud/{0}/creatingu namet argsu cloud.filter_eventu creatingu profileu provideru drivert sock_diru sock_dirt transportu transportu instance_idu pub_keyu priv_keyu Generating minion keys for '%s'u cloud.gen_keysu keysizeR3 R9 u actionR u VM is now runningc @ s� t | d d � d d �} d | k r� x t j | j d i � � D]_ \ } } t j d | | � | d j | d � | k rD t j d | | d j | � � t SqD Wn t | | t | � � S( Nu nameR3 R9 u actionu wait_for_metadatau Waiting for metadata: %s=%su metadatau Metadata is not ready: %s=%s(
RX R Rd R8 R t debugR* R R% R& ( R t dataR= Ri ( R3 ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt __query_node� s ( u cloud.wait_for_funNu Using IP address %su cloud.get_salt_interfaceu Salt interface set to: %su A valid IP address was not foundu ssh_hostu salt_hostu cloud.bootstrapu Created Cloud VM '%s'u '%s' VM creation details:
%su idu floating_ipsu fixed_ipsu private_ipsu
public_ipsu created instanceu salt/cloud/{0}/createdu createdu cloud.cachedir_index_addu nova( R R R R R* Rl Rm Rn R t formatR+ R4 R R| Rx RX R8 R R Rt R R Ru R% t updateR< t pprintt pformatRb ( R t deployt key_filenameR} R~ t
ip_addressRr t salt_interfacet salt_ip_addressR: t
event_data( ( R3 s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt create� s�
"
(
#c C@ s� | d k r t d � � n t d d d d j | � d i | d 6d t d
d t d �| sk t � } n t | d
| d d �} t j d | � | j | � } | r�t j d | � t d d d d j | � d i | d 6d t d
d t d �t j d t
� t k r8t d t | t j d d � � d � n t j d t
� t k rtt d | t
j d � d t � n t d | � t St j d | � t
S( u
Delete a single VM
u functionuE The destroy action must be called with -d, --destroy, -a or --action.u cloud.fire_eventu eventu destroying instanceu salt/cloud/{0}/destroyingRy u nameRz u sock_dirR{ u transportR3 R9 u actionu Destroying VM: %su Destroyed VM: %su destroyed instanceu salt/cloud/{0}/destroyedu delete_sshkeysu cloud.remove_sshkeyu
ssh_interfaceu
public_ipsi u update_cachediru cloud.delete_minion_cachediru :u cloud.cachedir_index_delu Failed to Destroy VM: %s( R R+ R R R4 RX R R< t
delete_serverR8 R RA RS R t splitRf ( RD R3 R9 R; R: ( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyRt s@
*$c C@ s | d k r t d � � n d | k r6 t d � � n | d k rN t � } n | j d � } xI | j � D]; \ } } y t d | � | | <Wqj t k
r� qj qj Xqj Wy t | | � | � SWnA t j j
k
r} t j d | | � t t
j | � � � n Xd S( u
Call function from shade.
func
function to call from shade.openstackcloud library
CLI Example
.. code-block:: bash
salt-cloud -f call myopenstack func=list_images
t sujksalt-cloud -f call myopenstack func=create_network name=mysubnet
u actionu7 The call function must be called with -f or --function.u funcu No `func` argument passedu
json.loadsu Error running %s: %sN( R R* R4 R) R6 R+ t
ValueErrorRS R/ Rr Rs R Rf R Ru ( R3 R9 R` t funcR= Ri Rr ( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyR9 @ s&
(: t __doc__t
__future__R R R Re t loggingRl R� R t salt.utils.versionst saltt salt.configR t salt.extR t salt.exceptionsR R R R R/ t shade.openstackcloudt shade.excR, t utilst versionst
_LooseVersiont __version__R t ImportErrorR t getLoggert __name__R R R
R R
R% R& R4 R* R> RE RL R5 RU RX RZ R\ R] R_ Rj Rx R� Rt R9 ( ( ( s? /usr/lib/python2.7/site-packages/salt/cloud/clouds/openstack.pyt <module>� sT " *
#' 0* p.
Mini Shell