File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/libcloud/compute/__pycache__/base.cpython-310.pyc
Back
o ;j7� � @ sP d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl m Z m Z mZmZmZmZmZmZmZ ddlZddlmZ ddlmZ ddlm Z m Z m Z ddlm Z m Z m!Z!m"Z" ddl#m$Z$ dd l%m&Z&m'Z'm(Z(m)Z)m*Z* dd l+m,Z,m-Z- e r�dd l.m/Z/ e"r�dd l0m1Z1m2Z2 e2e1e3ej4ej5fZ6ne3ej4ej5fZ6ed Z7eee8 e8f Z9dZ:dZ;g d�Z<g d�Z=G dd� d�Z>G dd� de>�Z?G dd� de>�Z@G dd� de>�ZAG dd� de>�ZBG d d � d �ZCG d d � d �ZDG d d!� d!�ZEG d"d#� d#e>�ZFG d$d%� d%�ZGG d&d'� d'�ZHG d(d)� d)e �ZIeJd*k�r&ddlKZKeK�L� dS dS )+z0 Provides base classes for working with drivers � N) � TYPE_CHECKING�Any�Dict�List�Type�Tuple�Union�Callable�Optional)�get_size_price)�b)� BaseDriver� Connection� ConnectionKey)� SSHClient� BaseSSHClient�SSHCommandTimeoutError� have_paramiko)� LibcloudError)�Provider� NodeState�DeploymentError�StorageVolumeState�NodeImageMemberState)�is_private_subnet�is_valid_ip_address)� Deployment)� SSHException�AuthenticationException)�NodeAuthSSHKey�NodeAuthPassword�X �, )zno such file or directoryz invalid keyz not a valid z invalid or unsupported key typezprivate file is encryptedz private key file is encryptedz'private key file checkints do not matchzinvalid password provided)�Noder �NodeSize� NodeImage�NodeImageMember� NodeLocationr r � NodeDriver� StorageVolumer �VolumeSnapshotr r c @ s. e Zd ZdZd dd�Zdd� Zedd � �ZdS ) � UuidMixinz, Mixin class for get_uuid function. �returnNc C s d | _ d S �N)�_uuid��self� r1 �I/opt/saltstack/salt/lib/python3.10/site-packages/libcloud/compute/base.py�__init__x s zUuidMixin.__init__c C s. | j st�td�| j| jj����� | _ | j S )aE Unique hash for a node, node image, or node size The hash is a function of an SHA1 hash of the node, node image, or node size's ID and its driver which means that it should be unique between all objects of its type. In some subclasses there is no ID available so the public IP address is used. This means that, unlike a properly done system UUID, the same UUID may mean a different system install at a different time >>> from libcloud.compute.drivers.dummy import DummyNodeDriver >>> driver = DummyNodeDriver(0) >>> node = driver.create_node() >>> node.get_uuid() 'd3748461511d8b9b0e0bfa0d4d3383a619a2bb9f' Note, for example, that this example will always produce the same UUID! :rtype: ``str`` z{}:{}) r. �hashlib�sha1r �format�id�driver�type� hexdigestr/ r1 r1 r2 �get_uuid{ s ��zUuidMixin.get_uuidc C s | � � S r- )r; r/ r1 r1 r2 �uuid� s zUuidMixin.uuid)r, N)�__name__� __module__� __qualname__�__doc__r3 r; �propertyr< r1 r1 r1 r2 r+ s s r+ c @ sJ e Zd ZdZ ddd�Zdd� Zdd� Zd d � Zd d � Zd d� Z dS )r# a1 Provide a common interface for handling nodes of all types. The Node object provides the interface in libcloud through which we can manipulate nodes in different cloud providers in the same way. Node objects don't actually do much directly themselves, instead the node driver handles the connection to the node. You don't normally create a node object yourself; instead you use a driver and then have that create the node for you. >>> from libcloud.compute.drivers.dummy import DummyNodeDriver >>> driver = DummyNodeDriver(0) >>> node = driver.create_node() >>> node.public_ips[0] '127.0.0.3' >>> node.name 'dummy-3' You can also get nodes from the driver's list_node function. >>> node = driver.list_nodes()[0] >>> node.name 'dummy-1' The node keeps a reference to its own driver which means that we can work on nodes from different providers without having to know which is which. >>> driver = DummyNodeDriver(72) >>> node2 = driver.create_node() >>> node.driver.creds 0 >>> node2.driver.creds 72 Although Node objects can be subclassed, this isn't normally done. Instead, any driver specific information is stored in the "extra" attribute of the node. >>> node.extra {'foo': 'bar'} Nc C sj |rt |�nd| _|| _|| _|r|ng | _|r|ng | _|| _|| _| | _|| _ | p,i | _ t � | � dS )a� :param id: Node ID. :type id: ``str`` :param name: Node name. :type name: ``str`` :param state: Node state. :type state: :class:`libcloud.compute.types.NodeState` :param public_ips: Public IP addresses associated with this node. :type public_ips: ``list`` :param private_ips: Private IP addresses associated with this node. :type private_ips: ``list`` :param driver: Driver this node belongs to. :type driver: :class:`.NodeDriver` :param size: Size of this node. (optional) :type size: :class:`.NodeSize` :param image: Image of this node. (optional) :type image: :class:`.NodeImage` :param created_at: The datetime this node was created (optional) :type created_at: :class: `datetime.datetime` :param extra: Optional provider specific attributes associated with this node. :type extra: ``dict`` N) �strr7 �name�state� public_ips� private_ipsr8 �size� created_at�image�extrar+ r3 ) r0 r7 rC rD rE rF r8 rG rI rJ rH r1 r1 r2 r3 � s / z Node.__init__c C � | j �| �S )a� Reboot this node :return: ``bool`` This calls the node's driver and reboots the node >>> from libcloud.compute.drivers.dummy import DummyNodeDriver >>> driver = DummyNodeDriver(0) >>> node = driver.create_node() >>> node.state == NodeState.RUNNING True >>> node.state == NodeState.REBOOTING False >>> node.reboot() True >>> node.state == NodeState.REBOOTING True )r8 � reboot_noder/ r1 r1 r2 �reboot � z Node.rebootc C rK )z= Start this node. :return: ``bool`` )r8 � start_noder/ r1 r1 r2 �start! � z Node.startc C rK )zG Stop (shutdown) this node. :return: ``bool`` )r8 � stop_noder/ r1 r1 r2 rR + rQ zNode.stop_nodec C rK )a� Destroy this node :return: ``bool`` This calls the node's driver and destroys the node >>> from libcloud.compute.drivers.dummy import DummyNodeDriver >>> driver = DummyNodeDriver(0) >>> from libcloud.compute.types import NodeState >>> node = driver.create_node() >>> node.state == NodeState.RUNNING True >>> node.destroy() True >>> node.state == NodeState.RUNNING False )r8 � destroy_noder/ r1 r1 r2 �destroy5 rN z Node.destroyc C s, t �| j�}d| j| j|| j| j| jjf S )NzR<Node: uuid=%s, name=%s, state=%s, public_ips=%s, private_ips=%s, provider=%s ...>)r ZtostringrD r< rC rE rF r8 )r0 rD r1 r1 r2 �__repr__M s ��z Node.__repr__)NNNN) r= r> r? r@ r3 rM rP rR rT rU r1 r1 r1 r2 r# � s 4 �; r# c @ �$ e Zd ZdZ ddd�Zdd� ZdS )r$ af A Base NodeSize class to derive from. NodeSizes are objects which are typically returned a driver's list_sizes function. They contain a number of different parameters which define how big an image is. The exact parameters available depends on the provider. N.B. Where a parameter is "unlimited" (for example bandwidth in Amazon) this will be given as 0. >>> from libcloud.compute.drivers.dummy import DummyNodeDriver >>> driver = DummyNodeDriver(0) >>> size = driver.list_sizes()[0] >>> size.ram 128 >>> size.bandwidth 500 >>> size.price 4 Nc C sF t |�| _|| _|| _|| _|| _|| _|| _|pi | _t � | � dS )a :param id: Size ID. :type id: ``str`` :param name: Size name. :type name: ``str`` :param ram: Amount of memory (in MB) provided by this size. :type ram: ``int`` :param disk: Amount of disk storage (in GB) provided by this image. :type disk: ``int`` :param bandwidth: Amount of bandiwdth included with this size. :type bandwidth: ``int`` :param price: Price (in US dollars) of running this node for an hour. :type price: ``float`` :param driver: Driver this size belongs to. :type driver: :class:`.NodeDriver` :param extra: Optional provider specific attributes associated with this size. :type extra: ``dict`` N) rB r7 rC �ram�disk� bandwidth�pricer8 rJ r+ r3 ) r0 r7 rC rW rX rY rZ r8 rJ r1 r1 r2 r3 t s % zNodeSize.__init__c C s& d| j | j| j| j| j| j| jjf S )NzN<NodeSize: id=%s, name=%s, ram=%s disk=%s bandwidth=%s price=%s driver=%s ...>)r7 rC rW rX rY rZ r8 r/ r1 r1 r2 rU � s ��zNodeSize.__repr__r- �r= r> r? r@ r3 rU r1 r1 r1 r2 r$ \ s � /r$ c @ rV )r% a� An operating system image. NodeImage objects are typically returned by the driver for the cloud provider in response to the list_images function >>> from libcloud.compute.drivers.dummy import DummyNodeDriver >>> driver = DummyNodeDriver(0) >>> image = driver.list_images()[0] >>> image.name 'Ubuntu 9.10' Apart from name and id, there is no further standard information; other parameters are stored in a driver specific "extra" variable When creating a node, a node image should be given as an argument to the create_node function to decide which OS image to use. >>> node = driver.create_node(image=image) Nc C s. t |�| _|| _|| _|pi | _t�| � dS )al :param id: Image ID. :type id: ``str`` :param name: Image name. :type name: ``str`` :param driver: Driver this image belongs to. :type driver: :class:`.NodeDriver` :param extra: Optional provided specific attributes associated with this image. :type extra: ``dict`` N)rB r7 rC r8 rJ r+ r3 )r0 r7 rC r8 rJ r1 r1 r2 r3 � s zNodeImage.__init__c C s d| j | j| jjf S )Nz+<NodeImage: id=%s, name=%s, driver=%s ...>)r7 rC r8 r/ r1 r1 r2 rU � s �zNodeImage.__repr__r- r[ r1 r1 r1 r2 r% � s � r% c @ �& e Zd ZdZ ddd�Zdd� ZdS )r& a A member of an image. At some cloud providers there is a mechanism to share images. Once an image is shared with another account that user will be a 'member' of the image. For example, see the image members schema in the OpenStack Image Service API v2 documentation. https://developer.openstack.org/ api-ref/image/v2/index.html#image-members-schema NodeImageMember objects are typically returned by the driver for the cloud provider in response to the list_image_members method Nc C s> t |�| _t |�| _|| _|| _|| _|pi | _t�| � dS )a� :param id: Image member ID. :type id: ``str`` :param id: The associated image ID. :type id: ``str`` :param state: State of the NodeImageMember. If not provided, will default to UNKNOWN. :type state: :class:`.NodeImageMemberState` :param driver: Driver this image belongs to. :type driver: :class:`.NodeDriver` :param created: A datetime object that represents when the image member was created :type created: ``datetime.datetime`` :param extra: Optional provided specific attributes associated with this image. :type extra: ``dict`` N) rB r7 �image_idrD r8 �createdrJ r+ r3 )r0 r7 r] rD r8 r^ rJ r1 r1 r2 r3 � s zNodeImageMember.__init__c C s d| j | j| j| jjf S )Nz?<NodeImageMember: id=%s, image_id=%s, state=%s, driver=%s ...>)r7 r] rD r8 rC r/ r1 r1 r2 rU � �zNodeImageMember.__repr__�NNr[ r1 r1 r1 r2 r& � s � 'r& c @ rV )r' z� A physical location where nodes can be. >>> from libcloud.compute.drivers.dummy import DummyNodeDriver >>> driver = DummyNodeDriver(0) >>> location = driver.list_locations()[0] >>> location.country 'US' Nc C s* t |�| _|| _|| _|| _|pi | _dS )a� :param id: Location ID. :type id: ``str`` :param name: Location name. :type name: ``str`` :param country: Location country. :type country: ``str`` :param driver: Driver this location belongs to. :type driver: :class:`.NodeDriver` :param extra: Optional provided specific attributes associated with this location. :type extra: ``dict`` N)rB r7 rC �countryr8 rJ )r0 r7 rC ra r8 rJ r1 r1 r2 r3 3 s zNodeLocation.__init__c C s d| j | j| j| jjf S )Nz5<NodeLocation: id=%s, name=%s, country=%s, driver=%s>)r7 rC ra r8 r/ r1 r1 r2 rU R r_ zNodeLocation.__repr__r- r[ r1 r1 r1 r2 r' ( s � r' c @ s e Zd ZdZdd� Zdd� ZdS )r aj An SSH key to be installed for authentication to a node. This is the actual contents of the users ssh public key which will normally be installed as root's public key on the node. >>> pubkey = '...' # read from file >>> from libcloud.compute.base import NodeAuthSSHKey >>> k = NodeAuthSSHKey(pubkey) >>> k <NodeAuthSSHKey> c C s || _ dS )zS :param pubkey: Public key material. :type pubkey: ``str`` N)�pubkey)r0 rb r1 r1 r2 r3 i s zNodeAuthSSHKey.__init__c C � dS )Nz<NodeAuthSSHKey>r1 r/ r1 r1 r2 rU q � zNodeAuthSSHKey.__repr__Nr[ r1 r1 r1 r2 r [ s r c @ s" e Zd ZdZddd�Zdd� ZdS ) r z= A password to be used for authentication to a node. Fc C s || _ || _dS )z� :param password: Password. :type password: ``str`` :type generated: ``True`` if this password was automatically generated, ``False`` otherwise. N)�password� generated)r0 re rf r1 r1 r2 r3 z s zNodeAuthPassword.__init__c C rc )Nz<NodeAuthPassword>r1 r/ r1 r1 r2 rU � rd zNodeAuthPassword.__repr__N)Fr[ r1 r1 r1 r2 r u s r c @ sP e Zd ZdZ ddd�Zdd� Zddd�Zd d � Zd d � Zd d� Z dd� Z dS )r) z4 A base StorageVolume class to derive from. Nc C s2 || _ || _|| _|| _|| _|| _t�| � dS )aJ :param id: Storage volume ID. :type id: ``str`` :param name: Storage volume name. :type name: ``str`` :param size: Size of this volume (in GB). :type size: ``int`` :param driver: Driver this image belongs to. :type driver: :class:`.NodeDriver` :param state: Optional state of the StorageVolume. If not provided, will default to UNKNOWN. :type state: :class:`.StorageVolumeState` :param extra: Optional provider specific attributes. :type extra: ``dict`` N)r7 rC rG r8 rJ rD r+ r3 )r0 r7 rC rG r8 rD rJ r1 r1 r2 r3 � s zStorageVolume.__init__c C � | j j| d�S )z8 :rtype: ``list`` of ``VolumeSnapshot`` ��volume)r8 �list_volume_snapshotsr/ r1 r1 r2 �list_snapshots� s z StorageVolume.list_snapshotsc C s | j j|| |d�S )am Attach this volume to a node. :param node: Node to attach volume to :type node: :class:`.Node` :param device: Where the device is exposed, e.g. '/dev/sdb (optional) :type device: ``str`` :return: ``True`` if attach was successful, ``False`` otherwise. :rtype: ``bool`` )�noderi �device)r8 � attach_volume)r0 rl rm r1 r1 r2 �attach� s zStorageVolume.attachc C rg )z� Detach this volume from its node :return: ``True`` if detach was successful, ``False`` otherwise. :rtype: ``bool`` rh )r8 � detach_volumer/ r1 r1 r2 �detach� � zStorageVolume.detachc C s | j j| |d�S )z{ Creates a snapshot of this volume. :return: Created snapshot. :rtype: ``VolumeSnapshot`` )ri rC )r8 �create_volume_snapshot�r0 rC r1 r1 r2 �snapshot� s zStorageVolume.snapshotc C rg )z� Destroy this storage volume. :return: ``True`` if destroy was successful, ``False`` otherwise. :rtype: ``bool`` rh )r8 �destroy_volumer/ r1 r1 r2 rT � rr zStorageVolume.destroyc C s d� | j| j| jj�S )Nz'<StorageVolume id={} size={} driver={}>)r6 r7 rG r8 rC r/ r1 r1 r2 rU � � �zStorageVolume.__repr__r` r- ) r= r> r? r@ r3 rk ro rq ru rT rU r1 r1 r1 r2 r) � s �& r) c @ s4 e Zd ZdZ d dd�Zdd� Zdd� ZdS ) r* z5 A base VolumeSnapshot class to derive from. Nc C s2 || _ || _|| _|p i | _|| _|| _|| _dS )a� VolumeSnapshot constructor. :param id: Snapshot ID. :type id: ``str`` :param driver: The driver that represents a connection to the provider :type driver: `NodeDriver` :param size: A snapshot size in GB. :type size: ``int`` :param extra: Provider depends parameters for snapshot. :type extra: ``dict`` :param created: A datetime object that represents when the snapshot was created :type created: ``datetime.datetime`` :param state: A string representing the state the snapshot is in. See `libcloud.compute.types.StorageVolumeState`. :type state: ``StorageVolumeState`` :param name: A string representing the name of the snapshot :type name: ``str`` N)r7 r8 rG rJ r^ rD rC )r0 r7 r8 rG rJ r^ rD rC r1 r1 r2 r3 � s & zVolumeSnapshot.__init__c C rg )zC Destroys this snapshot. :rtype: ``bool`` )ru )r8 �destroy_volume_snapshotr/ r1 r1 r2 rT + s zVolumeSnapshot.destroyc C s d� | j| j| j| jj| j�S )Nz6<VolumeSnapshot "{}" id={} size={} driver={} state={}>)r6 rC r7 rG r8 rD r/ r1 r1 r2 rU 5 s �zVolumeSnapshot.__repr__)NNNNN)r= r> r? r@ r3 rT rU r1 r1 r1 r2 r* � s �. r* c @ r\ )�KeyPairz$ Represents a SSH key pair. Nc C s, || _ || _|| _|| _|| _|pi | _dS )aC Constructor. :keyword name: Name of the key pair object. :type name: ``str`` :keyword fingerprint: Key fingerprint. :type fingerprint: ``str`` :keyword public_key: Public key in OpenSSH format. :type public_key: ``str`` :keyword private_key: Private key in PEM format. :type private_key: ``str`` :keyword extra: Provider specific attributes associated with this key pair. (optional) :type extra: ``dict`` N)rC � fingerprint� public_key� private_keyr8 rJ )r0 rC r{ rz r8 r| rJ r1 r1 r2 r3 D s zKeyPair.__init__c C s d� | j| j| jj�S )Nz*<KeyPair name={} fingerprint={} driver={}>)r6 rC rz r8 r/ r1 r1 r2 rU h rw zKeyPair.__repr__r` r[ r1 r1 r1 r2 ry ? s � $ry c @ s� e Zd ZdZeZdZdZdZdZ dZ dg iZ i Z dd� Z dTdd�Zdd � Z dUd d �Zd dd ddddeddddf dd�Zdd� Zdd� Zdd� Zdd� Zd d � Zd d � Z dUd d!�ZdTd"d#�ZdTd$d%�Zd&d'� Z d(d)� Z d*d+� Z dTd,d-�Z dTd.d/�Z d0d1� Z!d2d3� Z"dTd4d5�Z#d6d7� Z$d8d9� Z%d:d;� Z&d<d=� Z'd>d?� Z(d@dA� Z) B C dVdDdE�Z*dFdG� Z+ B CdWdHdI�Z,dXdLdM�Z-dNdO� Z.dYdPdQ�Z/dRdS� Z0dS )Zr( z� A base NodeDriver class to derive from This class is always subclassed by a specific driver. For examples of base behavior of most functions (except deploy node) see the dummy driver. N� create_nodec O � t d��)zt List all nodes. :return: list of node objects :rtype: ``list`` of :class:`.Node` z*list_nodes not implemented for this driver��NotImplementedError)r0 �args�kwargsr1 r1 r2 � list_nodes� � zNodeDriver.list_nodesc C r~ )z� List sizes on a provider :param location: The location at which to list sizes :type location: :class:`.NodeLocation` :return: list of node size objects :rtype: ``list`` of :class:`.NodeSize` z*list_sizes not implemented for this driverr �r0 �locationr1 r1 r2 � list_sizes� � zNodeDriver.list_sizesc C r~ )z� List data centers for a provider :return: list of node location objects :rtype: ``list`` of :class:`.NodeLocation` z.list_locations not implemented for this driverr r/ r1 r1 r2 �list_locations� r� zNodeDriver.list_locationsc C r~ )as Create a new node instance. This instance will be started automatically. Not all hosting API's are created equal and to allow libcloud to support as many as possible there are some standard supported variations of ``create_node``. These are declared using a ``features`` API. You can inspect ``driver.features['create_node']`` to see what variation of the API you are dealing with: ``ssh_key`` You can inject a public key into a new node allows key based SSH authentication. ``password`` You can inject a password into a new node for SSH authentication. If no password is provided libcloud will generated a password. The password will be available as ``return_value.extra['password']``. ``generates_password`` The hosting provider will generate a password. It will be returned to you via ``return_value.extra['password']``. Some drivers allow you to set how you will authenticate with the instance that is created. You can inject this initial authentication information via the ``auth`` parameter. If a driver supports the ``ssh_key`` feature flag for ``created_node`` you can upload a public key into the new instance:: >>> from libcloud.compute.drivers.dummy import DummyNodeDriver >>> driver = DummyNodeDriver(0) >>> auth = NodeAuthSSHKey('pubkey data here') >>> node = driver.create_node("test_node", auth=auth) If a driver supports the ``password`` feature flag for ``create_node`` you can set a password:: >>> driver = DummyNodeDriver(0) >>> auth = NodeAuthPassword('mysecretpassword') >>> node = driver.create_node("test_node", auth=auth) If a driver supports the ``password`` feature and you don't provide the ``auth`` argument libcloud will assign a password:: >>> driver = DummyNodeDriver(0) >>> node = driver.create_node("test_node") >>> password = node.extra['password'] A password will also be returned in this way for drivers that declare the ``generates_password`` feature, though in that case the password is actually provided to the driver API by the hosting provider rather than generated by libcloud. You can only pass a :class:`.NodeAuthPassword` or :class:`.NodeAuthSSHKey` to ``create_node`` via the auth parameter if has the corresponding feature flag. :param name: String with a name for this new node (required) :type name: ``str`` :param size: The size of resources allocated to this node. (required) :type size: :class:`.NodeSize` :param image: OS Image to boot on node. (required) :type image: :class:`.NodeImage` :param location: Which data center to create a node in. If empty, undefined behavior will be selected. (optional) :type location: :class:`.NodeLocation` :param auth: Initial authentication information for the node (optional) :type auth: :class:`.NodeAuthSSHKey` or :class:`NodeAuthPassword` :return: The newly created node. :rtype: :class:`.Node` z+create_node not implemented for this driverr )r0 rC rG rI r� �authr1 r1 r2 r} � s XzNodeDriver.create_node�root� � � rE � c K sj t jjjs td��|rt|ttf�std��n |rnd| j v r1| j d }d|vr0d|vr0td��ntd��z|rC| j dd|i|��}n| j di |��}W n< t y� } z0d}d }t � |t|��sht � |t|��r|| j d|||||||| | | d � |��}n|�W Y d }~nd }~ww | r�tj| | |d � d }|r�t|t�r�|j}n d|jv r�|jd }| p�t}z| j|g| || d �d \}}W n ty� } z| r�t�| � t||| d��d }~ww |p�g }| p�t}d }|g| D ].}z| j|||d |||||||| d� W n t�y } z|}W Y d }~q�d }~ww d } |d u�r+| �r$t�| � t||| d��| �r3t�| � |S )a Create a new node, and start deployment. In order to be able to SSH into a created node access credentials are required. A user can pass either a :class:`.NodeAuthPassword` or :class:`.NodeAuthSSHKey` to the ``auth`` argument. If the ``create_node`` implementation supports that kind if credential (as declared in ``self.features['create_node']``) then it is passed on to ``create_node``. Otherwise it is not passed on to ``create_node`` and it is only used for authentication. If the ``auth`` parameter is not supplied but the driver declares it supports ``generates_password`` then the password returned by ``create_node`` will be used to SSH into the server. Finally, if the ``ssh_key_file`` is supplied that key will be used to SSH into the server. This function may raise a :class:`DeploymentException`, if a create_node call was successful, but there is a later error (like SSH failing or timing out). This exception includes a Node object which you may want to destroy if incomplete deployments are not desirable. >>> from libcloud.compute.drivers.dummy import DummyNodeDriver >>> from libcloud.compute.deployment import ScriptDeployment >>> from libcloud.compute.deployment import MultiStepDeployment >>> from libcloud.compute.base import NodeAuthSSHKey >>> driver = DummyNodeDriver(0) >>> key = NodeAuthSSHKey('...') # read from file >>> script = ScriptDeployment("yum -y install emacs strace tcpdump") >>> msd = MultiStepDeployment([key, script]) >>> def d(): ... try: ... driver.deploy_node(deploy=msd) ... except NotImplementedError: ... print ("not implemented for dummy driver") >>> d() not implemented for dummy driver Deploy node is typically not overridden in subclasses. The existing implementation should be able to handle most such. :param deploy: Deployment to run once machine is online and available to SSH. :type deploy: :class:`Deployment` :param ssh_username: Optional name of the account which is used when connecting to SSH server (default is root) :type ssh_username: ``str`` :param ssh_alternate_usernames: Optional list of ssh usernames to try to connect with if using the default one fails :type ssh_alternate_usernames: ``list`` :param ssh_port: Optional SSH server port (default is 22) :type ssh_port: ``int`` :param ssh_timeout: Optional SSH connection timeout in seconds (default is 10) :type ssh_timeout: ``float`` :param auth: Initial authentication information for the node (optional) :type auth: :class:`.NodeAuthSSHKey` or :class:`NodeAuthPassword` :param ssh_key: A path (or paths) to an SSH private key with which to attempt to authenticate. (optional) :type ssh_key: ``str`` or ``list`` of ``str`` :param ssh_key_password: Optional password used for encrypted keys. :type ssh_key_password: ``str`` :param timeout: How many seconds to wait before timing out. (default is 600) :type timeout: ``int`` :param max_tries: How many times to retry if a deployment fails before giving up (default is 3) :type max_tries: ``int`` :param ssh_interface: The interface to wait for. Default is 'public_ips', other option is 'private_ips'. :type ssh_interface: ``str`` :param at_exit_func: Optional atexit handler function which will be registered and called with created node if user cancels the deploy process (e.g. CTRL+C), after the node has been created, but before the deploy process has finished. This method gets passed in two keyword arguments: - driver -> node driver in question - node -> created Node object Keep in mind that this function will only be called in such scenario. In case the method finishes (this includes throwing an exception), at exit handler function won't be called. :type at_exit_func: ``func`` :param wait_period: How many seconds to wait between each iteration while waiting for node to transition into running state and have IP assigned. (default is 5) :type wait_period: ``int`` zMparamiko is not installed. You can install it using pip: pip install paramikozFIf providing auth, only NodeAuthSSHKey orNodeAuthPassword is supportedr} Zgenerates_passwordre z+deploy_node not implemented for this driverr� z;create_node\(\) missing \d+ required positional arguments.*z.create_node\(\) takes at least \d+ arguments.*) �deploy� ssh_username�ssh_alternate_usernames�ssh_port� ssh_timeout�ssh_keyr� �timeout� max_tries� ssh_interfaceN)r8 rl )�nodes� wait_periodr� r� r )rl Zoriginal_exceptionr8 ) �taskrl � ssh_hostnamer� r� � ssh_password� ssh_key_file�ssh_key_passwordr� r� r� r1 )�libcloud�computeZsshr � RuntimeError� isinstancer r r� �featuresr} � TypeError�re�matchrB �atexit�registerre rJ �NODE_ONLINE_WAIT_TIMEOUT�wait_until_running� Exception� unregisterr �SSH_CONNECT_TIMEOUT�"_connect_and_run_deployment_script)r0 r� r� r� r� r� r� r� r� r� r� r� Z at_exit_funcr� Zcreate_node_kwargs�frl �eZmsg_1_reZmsg_2_rere Z wait_timeoutZ ip_addressesZdeploy_timeoutZ deploy_error�usernamer1 r1 r2 � deploy_node s� ��� � � � � ��� � � � �� � �� zNodeDriver.deploy_nodec C r~ )z� Reboot a node. :param node: The node to be rebooted :type node: :class:`.Node` :return: True if the reboot was successful, otherwise False :rtype: ``bool`` z+reboot_node not implemented for this driverr �r0 rl r1 r1 r2 rL r� zNodeDriver.reboot_nodec C r~ )z� Start a node. :param node: The node to be started :type node: :class:`.Node` :return: True if the start was successful, otherwise False :rtype: ``bool`` z*start_node not implemented for this driverr r� r1 r1 r2 rO r� zNodeDriver.start_nodec C r~ )z� Stop a node :param node: The node to be stopped. :type node: :class:`.Node` :return: True if the stop was successful, otherwise False :rtype: ``bool`` z)stop_node not implemented for this driverr r� r1 r1 r2 rR ) r� zNodeDriver.stop_nodec C r~ )aH Destroy a node. Depending upon the provider, this may destroy all data associated with the node, including backups. :param node: The node to be destroyed :type node: :class:`.Node` :return: True if the destroy was successful, False otherwise. :rtype: ``bool`` z,destroy_node not implemented for this driverr r� r1 r1 r2 rS 6 s zNodeDriver.destroy_nodec C r~ )z\ List storage volumes. :rtype: ``list`` of :class:`.StorageVolume` z,list_volumes not implemented for this driverr r/ r1 r1 r2 � list_volumesJ � zNodeDriver.list_volumesc C r~ )zk List snapshots for a storage volume. :rtype: ``list`` of :class:`VolumeSnapshot` z5list_volume_snapshots not implemented for this driverr �r0 ri r1 r1 r2 rj S r� z NodeDriver.list_volume_snapshotsc C r~ )a� Create a new volume. :param size: Size of volume in gigabytes (required) :type size: ``int`` :param name: Name of the volume to be created :type name: ``str`` :param location: Which data center to create a volume in. If empty, undefined behavior will be selected. (optional) :type location: :class:`.NodeLocation` :param snapshot: Snapshot from which to create the new volume. (optional) :type snapshot: :class:`.VolumeSnapshot` :return: The newly created volume. :rtype: :class:`StorageVolume` z-create_volume not implemented for this driverr )r0 rG rC r� ru r1 r1 r2 � create_volume\ s zNodeDriver.create_volumec C r~ )a0 Creates a snapshot of the storage volume. :param volume: The StorageVolume to create a VolumeSnapshot from :type volume: :class:`.StorageVolume` :param name: Name of created snapshot (optional) :type name: `str` :rtype: :class:`VolumeSnapshot` z6create_volume_snapshot not implemented for this driverr )r0 ri rC r1 r1 r2 rs { � z!NodeDriver.create_volume_snapshotc C r~ )aR Attaches volume to node. :param node: Node to attach volume to. :type node: :class:`.Node` :param volume: Volume to attach. :type volume: :class:`.StorageVolume` :param device: Where the device is exposed, e.g. '/dev/sdb' :type device: ``str`` :rytpe: ``bool`` z&attach not implemented for this driverr )r0 rl ri rm r1 r1 r2 rn � s zNodeDriver.attach_volumec C r~ )z� Detaches a volume from a node. :param volume: Volume to be detached :type volume: :class:`.StorageVolume` :rtype: ``bool`` z&detach not implemented for this driverr r� r1 r1 r2 rp � r� zNodeDriver.detach_volumec C r~ )z� Destroys a storage volume. :param volume: Volume to be destroyed :type volume: :class:`StorageVolume` :rtype: ``bool`` z.destroy_volume not implemented for this driverr r� r1 r1 r2 rv � r� zNodeDriver.destroy_volumec C r~ )z� Destroys a snapshot. :param snapshot: The snapshot to delete :type snapshot: :class:`VolumeSnapshot` :rtype: :class:`bool` z7destroy_volume_snapshot not implemented for this driverr )r0 ru r1 r1 r2 rx � � z"NodeDriver.destroy_volume_snapshotc C r~ )z� List images on a provider. :param location: The location at which to list images. :type location: :class:`.NodeLocation` :return: list of node image objects. :rtype: ``list`` of :class:`.NodeImage` z+list_images not implemented for this driverr r� r1 r1 r2 � list_images� r� zNodeDriver.list_imagesc C r~ )a� Creates an image from a node object. :param node: Node to run the task on. :type node: :class:`.Node` :param name: name for new image. :type name: ``str`` :param description: description for new image. :type name: ``description`` :rtype: :class:`.NodeImage`: :return: NodeImage instance on success. z,create_image not implemented for this driverr )r0 rl rC � descriptionr1 r1 r2 � create_image� s zNodeDriver.create_imagec C r~ )z� Deletes a node image from a provider. :param node_image: Node image object. :type node_image: :class:`.NodeImage` :return: ``True`` if delete_image was successful, ``False`` otherwise. :rtype: ``bool`` z,delete_image not implemented for this driverr )r0 � node_imager1 r1 r2 � delete_image� s zNodeDriver.delete_imagec C r~ )z� Returns a single node image from a provider. :param image_id: Node to run the task on. :type image_id: ``str`` :rtype :class:`.NodeImage`: :return: NodeImage instance on success. z)get_image not implemented for this driverr )r0 r] r1 r1 r2 � get_image� r� zNodeDriver.get_imagec C r~ )a� Copies an image from a source region to the current region. :param source_region: Region to copy the node from. :type source_region: ``str`` :param node_image: NodeImage to copy. :type node_image: :class:`.NodeImage`: :param name: name for new image. :type name: ``str`` :param description: description for new image. :type name: ``str`` :rtype: :class:`.NodeImage`: :return: NodeImage instance on success. z*copy_image not implemented for this driverr )r0 Z source_regionr� rC r� r1 r1 r2 � copy_image s zNodeDriver.copy_imagec C r~ )zq List all the available key pair objects. :rtype: ``list`` of :class:`.KeyPair` objects z.list_key_pairs not implemented for this driverr r/ r1 r1 r2 �list_key_pairs r� zNodeDriver.list_key_pairsc C r~ )z� Retrieve a single key pair. :param name: Name of the key pair to retrieve. :type name: ``str`` :rtype: :class:`.KeyPair` z,get_key_pair not implemented for this driverr rt r1 r1 r2 � get_key_pair% r� zNodeDriver.get_key_pairc C r~ )z� Create a new key pair object. :param name: Key pair name. :type name: ``str`` :rtype: :class:`.KeyPair` object z/create_key_pair not implemented for this driverr rt r1 r1 r2 �create_key_pair1 r� zNodeDriver.create_key_pairc C r~ )z� Import a new public key from string. :param name: Key pair name. :type name: ``str`` :param key_material: Public key material. :type key_material: ``str`` :rtype: :class:`.KeyPair` object z;import_key_pair_from_string not implemented for this driverr )r0 rC � key_materialr1 r1 r2 �import_key_pair_from_string= r� z&NodeDriver.import_key_pair_from_stringc C sN t j�|�}t|��}|�� �� }W d � n1 sw Y | j||d�S )a Import a new public key from string. :param name: Key pair name. :type name: ``str`` :param key_file_path: Path to the public key file. :type key_file_path: ``str`` :rtype: :class:`.KeyPair` object N)rC r� )�os�path� expanduser�open�read�stripr� )r0 rC Z key_file_path�fpr� r1 r1 r2 �import_key_pair_from_fileL s �z$NodeDriver.import_key_pair_from_filec C r~ )z� Delete an existing key pair. :param key_pair: Key pair object. :type key_pair: :class:`.KeyPair` :rtype: ``bool`` z/delete_key_pair not implemented for this driverr )r0 Zkey_pairr1 r1 r2 �delete_key_pair` r� zNodeDriver.delete_key_pairr! Tc sL |pi }� fdd���fdd�}|dvrt d��t�� }|| } dd� |D ��t�� | k r�| jdi |��} t�fd d �| D ��} t| �t��kr_d d � | D �} d d� d| } t| | d��dd � | D �}g }|D ]}|t||��}t|�dkr~|�|� qjt|�t�� kr�t|�kr�n ntt||��S t� |� q'td| | d��)aR Block until the provided nodes are considered running. Node is considered running when it's state is "running" and when it has at least one IP address assigned. :param nodes: List of nodes to wait for. :type nodes: ``list`` of :class:`.Node` :param wait_period: How many seconds to wait between each loop iteration. (default is 3) :type wait_period: ``int`` :param timeout: How many seconds to wait before giving up. (default is 600) :type timeout: ``int`` :param ssh_interface: Which attribute on the node to use to obtain an IP address. Valid options: public_ips, private_ips. Default is public_ips. :type ssh_interface: ``str`` :param force_ipv4: Ignore IPv6 addresses (default is True). :type force_ipv4: ``bool`` :param ex_list_nodes_kwargs: Optional driver-specific keyword arguments which are passed to the ``list_nodes`` method. :type ex_list_nodes_kwargs: ``dict`` :return: ``[(Node, ip_addresses)]`` list of tuple of Node instance and list of ip_address on success. :rtype: ``list`` of ``tuple`` c s � r t | tjd�s dS dS )z< Return True for supported address. )�address�familyFT)r �socket�AF_INET)r� )� force_ipv4r1 r2 � is_supported� s z3NodeDriver.wait_until_running.<locals>.is_supportedc s � fdd�| D �S )z= Return list of supported addresses. c s g | ]}� |�r|�qS r1 r1 )�.0r� �r� r1 r2 � <listcomp>� s zKNodeDriver.wait_until_running.<locals>.filter_addresses.<locals>.<listcomp>r1 )� addressesr� r1 r2 �filter_addresses� s z7NodeDriver.wait_until_running.<locals>.filter_addresses)rE rF z?ssh_interface argument must either be public_ips or private_ipsc S s h | ]}|j �qS r1 �r< �r� rl r1 r1 r2 � <setcomp>� � z0NodeDriver.wait_until_running.<locals>.<setcomp>c 3 s � | ] }|j � v r|V qd S r- r� r� )�uuidsr1 r2 � <genexpr>� s � z0NodeDriver.wait_until_running.<locals>.<genexpr>c S s g | ]}|j �qS r1 r� r� r1 r1 r2 r� � r� z1NodeDriver.wait_until_running.<locals>.<listcomp>z Unable to match specified uuids z (%s) with existing nodes. Found z#multiple nodes with same uuid: (%s)��valuer8 c S s g | ] }|j tjkr|�qS r1 )rD r ZRUNNINGr� r1 r1 r2 r� � s � zTimed out after %s secondsNr1 ) � ValueError�timer� �list�lenr �getattr�append�zip�sleep)r0 r� r� r� r� r� Zex_list_nodes_kwargsr� rP �endZ all_nodesZmatching_nodesZ found_uuids�msgZ running_nodesr� rl Znode_addressesr1 )r� r� r� r2 r� l s@ , ��� �$ z NodeDriver.wait_until_runningc C s� t |t�rd| jd v r|S td| d��t |t�r(d| jd v r"|S td| d��d| jd v rat�d�}t�|�� d�}d }|D ]}|� � sV|� � rVt � d d �d krV|�� }||7 }q@t|d d �S |ritd| d��dS )a� Helper function for providers supporting :class:`.NodeAuthPassword` or :class:`.NodeAuthSSHKey` Validates that only a supported object type is passed to the auth parameter and raises an exception if it is not. If no :class:`.NodeAuthPassword` object is provided but one is expected then a password is automatically generated. re r} zJPassword provided as authentication information, but passwordnot supported)r8 r� zHSSH Key provided as authentication information, but SSH Keynot supported� �ascii� r r� T)rf zS"auth" argument provided, but it was not a NodeAuthPasswordor NodeAuthSSHKey objectN)r� r r� r r r� �urandom�binascii�hexlify�decode�isdigit�islower�random�randint�upper)r0 r� r� re �charr1 r1 r2 �_get_and_check_auth� s< � � ��z NodeDriver._get_and_check_authc C s | j |g||||d�S )N)r� r� r� r� r� )r� )r0 rl r� r� r� r� r1 r1 r2 �_wait_until_running s �z NodeDriver._wait_until_running� �?r" c C s� t � � }|| }t � � |k rNz|�� W |S tyM } z,t|��� }tD ]}||v r-|�q%z|�� W n ty= Y nw t �|� W Y d}~qd}~ww t d| d��)aW Try to connect to the remote SSH server. If a connection times out or is refused it is retried up to timeout number of seconds. :param ssh_client: A configured SSHClient instance :type ssh_client: ``SSHClient`` :param wait_period: How many seconds to wait between each loop iteration. (default is 1.5) :type wait_period: ``int`` :param timeout: How many seconds to wait before giving up. (default is 300) :type timeout: ``int`` :return: ``SSHClient`` on success Nz6Could not connect to the remote SSH server. Giving up.r� ) r� �connect� SSH_TIMEOUT_EXCEPTION_CLASSESrB �lower�SSH_FATAL_ERROR_MSGS�closer� r� r ) r0 � ssh_clientr� r� rP r� r� �messageZ fatal_msgr1 r1 r2 �_ssh_client_connect s2 � � � ���z NodeDriver._ssh_client_connectc C s< t ||||p||| d�} | j| | d�} | j||| | d�}|S )z� Establish an SSH connection to the node and run the provided deployment task. :rtype: :class:`.Node`: :return: Node instance on success. )�hostname�portr� re Z key_filesr� �r r� )r� rl r r� )r r �_run_deployment_script) r0 r� rl r� r� r� r� r� r� r� r� r� r r1 r1 r2 r� S s � �z-NodeDriver._connect_and_run_deployment_scriptc C s� d}||k rzz|� ||�}W na ty } z|�d}~w tyo } zH|d7 }dt|��� v rPz|�� W n ty> Y nw |jrGt|j�nd}| j||d�}||kret � � }t d|t|�|f | d��W Y d}~n d}~ww |�� |S ||k s|S ) a� Run the deployment script on the provided node. At this point it is assumed that SSH connection has already been established. :param task: Deployment task to run. :type task: :class:`Deployment` :param node: Node to run the task on. :type node: ``Node`` :param ssh_client: A configured and connected SSHClient instance. :type ssh_client: :class:`SSHClient` :param max_tries: How many times to retry if a deployment fails before giving up. (default is 3) :type max_tries: ``int`` :rtype: :class:`.Node` :return: ``Node`` Node instance on success. r Nr� zssh session not activer� r z Failed after %d tries: %s. %sr� ) �runr r� rB r r r� �intr � traceback� format_excr ) r0 r� rl r r� Ztriesr� r� �tbr1 r1 r2 r z s< � �� ����$z!NodeDriver._run_deployment_scriptc C s t d| j|d�S )zF Return pricing information for the provided size id. r� )Z driver_typeZ driver_name�size_id)r �api_name)r0 r r1 r1 r2 �_get_size_price� s zNodeDriver._get_size_pricer- r` )r� r! rE TN)r� r! rE T)r� r" )r� )1r= r> r? r@ r Z connectionClsrC r Zwebsiter9 r r� ZNODE_STATE_MAPr� r� r� r} r� r� rL rO rR rS r� rj r� rs rn rp rv rx r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r� r r r1 r1 r1 r2 r( p s� �] � � �h8 � 6 ' >r( �__main__)Mr@ r� r� r� r� r� r� r4 r� �datetimer �typingr r r r r r r r r Zlibcloud.compute.sshr� Zlibcloud.pricingr Zlibcloud.utils.py3r Zlibcloud.common.baser r r r r r r Zlibcloud.common.typesr Zlibcloud.compute.typesr r r r r Zlibcloud.utils.networkingr r Zlibcloud.compute.deploymentr Zparamiko.ssh_exceptionr r �IOError�gaierror�errorr� ZT_AuthrB Z T_Ssh_keyr� r� r �__all__r+ r# r$ r% r& r' r r r) r* ry r( r= ZdoctestZtestmodr1 r1 r1 r2 �<module> s� , � �. <U9>3nG1 Y �
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings