| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125 |
- """
- DataTypes used by this provider
- """
- import hashlib
- import inspect
- import logging
- from botocore.exceptions import ClientError
- from cloudbridge.cloud.base.resources import BaseAttachmentInfo
- from cloudbridge.cloud.base.resources import BaseBucket
- from cloudbridge.cloud.base.resources import BaseBucketObject
- from cloudbridge.cloud.base.resources import BaseFloatingIP
- from cloudbridge.cloud.base.resources import BaseInstance
- from cloudbridge.cloud.base.resources import BaseInternetGateway
- from cloudbridge.cloud.base.resources import BaseKeyPair
- from cloudbridge.cloud.base.resources import BaseLaunchConfig
- from cloudbridge.cloud.base.resources import BaseMachineImage
- from cloudbridge.cloud.base.resources import BaseNetwork
- from cloudbridge.cloud.base.resources import BasePlacementZone
- from cloudbridge.cloud.base.resources import BaseRegion
- from cloudbridge.cloud.base.resources import BaseRouter
- from cloudbridge.cloud.base.resources import BaseSnapshot
- from cloudbridge.cloud.base.resources import BaseSubnet
- from cloudbridge.cloud.base.resources import BaseVMFirewall
- from cloudbridge.cloud.base.resources import BaseVMFirewallRule
- from cloudbridge.cloud.base.resources import BaseVMType
- from cloudbridge.cloud.base.resources import BaseVolume
- from cloudbridge.cloud.interfaces.resources import GatewayState
- from cloudbridge.cloud.interfaces.resources import InstanceState
- from cloudbridge.cloud.interfaces.resources import MachineImageState
- from cloudbridge.cloud.interfaces.resources import NetworkState
- from cloudbridge.cloud.interfaces.resources import RouterState
- from cloudbridge.cloud.interfaces.resources import SnapshotState
- from cloudbridge.cloud.interfaces.resources import SubnetState
- from cloudbridge.cloud.interfaces.resources import VolumeState
- from .helpers import find_tag_value
- from .helpers import trim_empty_params
- from .subservices import AWSBucketObjectSubService
- from .subservices import AWSFloatingIPSubService
- from .subservices import AWSGatewaySubService
- from .subservices import AWSVMFirewallRuleSubService
- log = logging.getLogger(__name__)
- class AWSMachineImage(BaseMachineImage):
- IMAGE_STATE_MAP = {
- 'pending': MachineImageState.PENDING,
- 'transient': MachineImageState.PENDING,
- 'available': MachineImageState.AVAILABLE,
- 'deregistered': MachineImageState.PENDING,
- 'failed': MachineImageState.ERROR,
- 'error': MachineImageState.ERROR,
- 'invalid': MachineImageState.ERROR
- }
- def __init__(self, provider, image):
- super(AWSMachineImage, self).__init__(provider)
- if isinstance(image, AWSMachineImage):
- # pylint:disable=protected-access
- self._ec2_image = image._ec2_image
- else:
- self._ec2_image = image
- @property
- def id(self):
- return self._ec2_image.id
- @property
- def name(self):
- try:
- return self._ec2_image.name
- except (AttributeError, ClientError) as e:
- log.warn("Cannot get name for image {0}: {1}".format(self.id, e))
- @property
- # pylint:disable=arguments-differ
- def label(self):
- """
- .. note:: an instance must have a (case sensitive) tag ``Name``
- """
- return find_tag_value(self._ec2_image.tags, 'Name')
- @label.setter
- # pylint:disable=arguments-differ
- def label(self, value):
- self.assert_valid_resource_label(value)
- self._ec2_image.create_tags(Tags=[{'Key': 'Name',
- 'Value': value or ""}])
- @property
- def description(self):
- try:
- return self._ec2_image.description
- except AttributeError:
- return None
- @property
- def min_disk(self):
- vols = [bdm.get('Ebs', {}) for bdm in
- self._ec2_image.block_device_mappings if
- bdm.get('DeviceName') == self._ec2_image.root_device_name]
- if vols:
- return vols[0].get('VolumeSize')
- else:
- return None
- def delete(self):
- snapshot_id = [
- bdm.get('Ebs', {}).get('SnapshotId') for bdm in
- self._ec2_image.block_device_mappings if
- bdm.get('DeviceName') == self._ec2_image.root_device_name]
- self._ec2_image.deregister()
- self.wait_for([MachineImageState.UNKNOWN, MachineImageState.ERROR])
- snapshot = self._provider.storage.snapshots.get(snapshot_id[0])
- if snapshot:
- snapshot.delete()
- @property
- def state(self):
- try:
- return AWSMachineImage.IMAGE_STATE_MAP.get(
- self._ec2_image.state, MachineImageState.UNKNOWN)
- except Exception:
- # Ignore all exceptions when querying state
- return MachineImageState.UNKNOWN
- def refresh(self):
- self._ec2_image.reload()
- class AWSPlacementZone(BasePlacementZone):
- def __init__(self, provider, zone, region):
- super(AWSPlacementZone, self).__init__(provider)
- if isinstance(zone, AWSPlacementZone):
- # pylint:disable=protected-access
- self._aws_zone = zone._aws_zone
- self._aws_region = zone._aws_region
- else:
- self._aws_zone = zone
- self._aws_region = region
- @property
- def id(self):
- return self._aws_zone
- @property
- def name(self):
- return self.id
- @property
- def region_name(self):
- return self._aws_region
- class AWSVMType(BaseVMType):
- def __init__(self, provider, instance_dict):
- super(AWSVMType, self).__init__(provider)
- self._inst_dict = instance_dict
- @property
- def id(self):
- return str(self._inst_dict['instance_type'])
- @property
- def name(self):
- return self.id
- @property
- def family(self):
- return self._inst_dict.get('family')
- @property
- def vcpus(self):
- vcpus = self._inst_dict.get('vCPU')
- if vcpus == 'N/A':
- return None
- return vcpus
- @property
- def ram(self):
- return self._inst_dict.get('memory')
- @property
- def size_root_disk(self):
- return 0
- @property
- def size_ephemeral_disks(self):
- storage = self._inst_dict.get('storage')
- if storage:
- return storage.get('size') * storage.get("devices")
- else:
- return 0
- @property
- def num_ephemeral_disks(self):
- storage = self._inst_dict.get('storage')
- if storage:
- return storage.get("devices")
- else:
- return 0
- @property
- def extra_data(self):
- return {key: val for key, val in self._inst_dict.items()
- if key not in ["instance_type", "family", "vCPU", "memory"]}
- class AWSInstance(BaseInstance):
- # ref:
- # http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html
- INSTANCE_STATE_MAP = {
- 'pending': InstanceState.PENDING,
- 'running': InstanceState.RUNNING,
- 'shutting-down': InstanceState.CONFIGURING,
- 'terminated': InstanceState.DELETED,
- 'stopping': InstanceState.CONFIGURING,
- 'stopped': InstanceState.STOPPED
- }
- def __init__(self, provider, ec2_instance):
- super(AWSInstance, self).__init__(provider)
- self._ec2_instance = ec2_instance
- self._unknown_state = False
- @property
- def id(self):
- return self._ec2_instance.id
- @property
- def name(self):
- return self.id
- @property
- # pylint:disable=arguments-differ
- def label(self):
- """
- .. note:: an instance must have a (case sensitive) tag ``Name``
- """
- return find_tag_value(self._ec2_instance.tags, 'Name')
- @label.setter
- # pylint:disable=arguments-differ
- def label(self, value):
- self.assert_valid_resource_label(value)
- self._ec2_instance.create_tags(Tags=[{'Key': 'Name',
- 'Value': value or ""}])
- @property
- def public_ips(self):
- return ([self._ec2_instance.public_ip_address]
- if self._ec2_instance.public_ip_address else [])
- @property
- def private_ips(self):
- return ([self._ec2_instance.private_ip_address]
- if self._ec2_instance.private_ip_address else [])
- @property
- def vm_type_id(self):
- return self._ec2_instance.instance_type
- @property
- def vm_type(self):
- return self._provider.compute.vm_types.find(
- name=self._ec2_instance.instance_type)[0]
- def reboot(self):
- self._ec2_instance.reboot()
- @property
- def image_id(self):
- return self._ec2_instance.image_id
- @property
- def zone_id(self):
- return self._ec2_instance.placement.get('AvailabilityZone')
- @property
- def subnet_id(self):
- return self._ec2_instance.subnet_id
- @property
- def vm_firewalls(self):
- return [
- self._provider.security.vm_firewalls.get(fw_id)
- for fw_id in self.vm_firewall_ids
- ]
- @property
- def vm_firewall_ids(self):
- return list(set([
- group.get('GroupId') for group in
- self._ec2_instance.security_groups
- ]))
- @property
- def key_pair_id(self):
- return self._ec2_instance.key_name
- def create_image(self, label):
- self.assert_valid_resource_label(label)
- name = self._generate_name_from_label(label, 'cb-img')
- image = AWSMachineImage(self._provider,
- self._ec2_instance.create_image(Name=name))
- # Wait for the image to exist
- self._provider.ec2_conn.meta.client.get_waiter('image_exists').wait(
- ImageIds=[image.id])
- # Add image label
- image.label = label
- # Return the image
- image.refresh()
- return image
- def _get_fip(self, floating_ip):
- """Get a floating IP object based on the supplied allocation ID."""
- return self._provider.networking._floating_ips.get(None, floating_ip)
- def add_floating_ip(self, floating_ip):
- fip = (floating_ip if isinstance(floating_ip, AWSFloatingIP)
- else self._get_fip(floating_ip))
- params = trim_empty_params({
- 'InstanceId': self.id,
- 'PublicIp': None if self._ec2_instance.vpc_id else
- fip.public_ip,
- # pylint:disable=protected-access
- 'AllocationId': fip._ip.allocation_id})
- self._provider.ec2_conn.meta.client.associate_address(**params)
- self.refresh()
- def remove_floating_ip(self, floating_ip):
- fip = (floating_ip if isinstance(floating_ip, AWSFloatingIP)
- else self._get_fip(floating_ip))
- params = trim_empty_params({
- 'PublicIp': None if self._ec2_instance.vpc_id else
- fip.public_ip,
- # pylint:disable=protected-access
- 'AssociationId': fip._ip.association_id})
- self._provider.ec2_conn.meta.client.disassociate_address(**params)
- self.refresh()
- def add_vm_firewall(self, firewall):
- self._ec2_instance.modify_attribute(
- Groups=self.vm_firewall_ids + [firewall.id])
- def remove_vm_firewall(self, firewall):
- self._ec2_instance.modify_attribute(
- Groups=([fw_id for fw_id in self.vm_firewall_ids
- if fw_id != firewall.id]))
- @property
- def state(self):
- if self._unknown_state:
- return InstanceState.UNKNOWN
- try:
- return AWSInstance.INSTANCE_STATE_MAP.get(
- self._ec2_instance.state['Name'], InstanceState.UNKNOWN)
- except Exception:
- # Ignore all exceptions when querying state
- return InstanceState.UNKNOWN
- def refresh(self):
- try:
- self._ec2_instance.reload()
- self._unknown_state = False
- except ClientError:
- # The instance no longer exists and cannot be refreshed.
- # set the state to unknown
- self._unknown_state = True
- # pylint:disable=unused-argument
- def _wait_till_exists(self, timeout=None, interval=None):
- self._ec2_instance.wait_until_exists()
- class AWSVolume(BaseVolume):
- # Ref:
- # http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/
- # ApiReference-cmd-DescribeVolumes.html
- VOLUME_STATE_MAP = {
- 'creating': VolumeState.CREATING,
- 'available': VolumeState.AVAILABLE,
- 'in-use': VolumeState.IN_USE,
- 'deleting': VolumeState.CONFIGURING,
- 'deleted': VolumeState.DELETED,
- 'error': VolumeState.ERROR
- }
- def __init__(self, provider, volume):
- super(AWSVolume, self).__init__(provider)
- self._volume = volume
- self._unknown_state = False
- @property
- def id(self):
- return self._volume.id
- @property
- def name(self):
- return self.id
- @property
- # pylint:disable=arguments-differ
- def label(self):
- try:
- return find_tag_value(self._volume.tags, 'Name')
- except ClientError as e:
- log.warn("Cannot get label for volume {0}: {1}".format(self.id, e))
- @label.setter
- # pylint:disable=arguments-differ
- def label(self, value):
- self.assert_valid_resource_label(value)
- self._volume.create_tags(Tags=[{'Key': 'Name', 'Value': value or ""}])
- @property
- def description(self):
- return find_tag_value(self._volume.tags, 'Description')
- @description.setter
- def description(self, value):
- self._volume.create_tags(Tags=[{'Key': 'Description',
- 'Value': value or ""}])
- @property
- def size(self):
- return self._volume.size
- @property
- def create_time(self):
- return self._volume.create_time
- @property
- def zone_id(self):
- return self._volume.availability_zone
- @property
- def source(self):
- if self._volume.snapshot_id:
- return self._provider.storage.snapshots.get(
- self._volume.snapshot_id)
- return None
- @property
- def attachments(self):
- return [
- BaseAttachmentInfo(self,
- a.get('InstanceId'),
- a.get('Device'))
- for a in self._volume.attachments
- ][0] if self._volume.attachments else None
- def attach(self, instance, device):
- instance_id = instance.id if isinstance(
- instance,
- AWSInstance) else instance
- self._volume.attach_to_instance(InstanceId=instance_id,
- Device=device)
- def detach(self, force=False):
- a = self.attachments
- if a:
- self._volume.detach_from_instance(
- InstanceId=a.instance_id,
- Device=a.device,
- Force=force)
- def create_snapshot(self, label, description=None):
- self.assert_valid_resource_label(label)
- snap = AWSSnapshot(
- self._provider,
- self._volume.create_snapshot(
- TagSpecifications=[{'ResourceType': 'snapshot',
- 'Tags': [{'Key': 'Name',
- 'Value': label}]}],
- Description=description or ""))
- snap.wait_till_ready()
- return snap
- @property
- def state(self):
- if self._unknown_state:
- return VolumeState.UNKNOWN
- try:
- return AWSVolume.VOLUME_STATE_MAP.get(
- self._volume.state, VolumeState.UNKNOWN)
- except Exception:
- # Ignore all exceptions when querying state
- return VolumeState.UNKNOWN
- def refresh(self):
- try:
- self._volume.reload()
- self._unknown_state = False
- except ClientError:
- # The volume no longer exists and cannot be refreshed.
- # set the status to unknown
- self._unknown_state = True
- class AWSSnapshot(BaseSnapshot):
- # Ref: http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/
- # ApiReference-cmd-DescribeSnapshots.html
- SNAPSHOT_STATE_MAP = {
- 'pending': SnapshotState.PENDING,
- 'deleting': SnapshotState.PENDING,
- 'completed': SnapshotState.AVAILABLE,
- 'error': SnapshotState.ERROR
- }
- def __init__(self, provider, snapshot):
- super(AWSSnapshot, self).__init__(provider)
- self._snapshot = snapshot
- self._unknown_state = False
- @property
- def id(self):
- return self._snapshot.id
- @property
- def name(self):
- return self.id
- @property
- # pylint:disable=arguments-differ
- def label(self):
- try:
- return find_tag_value(self._snapshot.tags, 'Name')
- except ClientError as e:
- log.warn("Cannot get label for snap {0}: {1}".format(self.id, e))
- @label.setter
- # pylint:disable=arguments-differ
- def label(self, value):
- self.assert_valid_resource_label(value)
- self._snapshot.create_tags(Tags=[{'Key': 'Name',
- 'Value': value or ""}])
- @property
- def description(self):
- return find_tag_value(self._snapshot.tags, 'Description')
- @description.setter
- def description(self, value):
- self._snapshot.create_tags(Tags=[{
- 'Key': 'Description', 'Value': value or ""}])
- @property
- def size(self):
- return self._snapshot.volume_size
- @property
- def volume_id(self):
- return self._snapshot.volume_id
- @property
- def create_time(self):
- return self._snapshot.start_time
- @property
- def state(self):
- if self._unknown_state:
- return SnapshotState.UNKNOWN
- try:
- return AWSSnapshot.SNAPSHOT_STATE_MAP.get(
- self._snapshot.state, SnapshotState.UNKNOWN)
- except Exception:
- # Ignore all exceptions when querying state
- return SnapshotState.UNKNOWN
- def refresh(self):
- try:
- self._snapshot.reload()
- self._unknown_state = False
- except ClientError:
- # The snapshot no longer exists and cannot be refreshed.
- # set the status to unknown
- self._unknown_state = True
- def create_volume(self, placement, size=None, volume_type=None, iops=None):
- label = "from-snap-{0}".format(self.label or self.id)
- cb_vol = self._provider.storage.volumes.create(
- label=label,
- size=size,
- zone=placement,
- snapshot=self.id)
- cb_vol.wait_till_ready()
- return cb_vol
- class AWSKeyPair(BaseKeyPair):
- def __init__(self, provider, key_pair):
- super(AWSKeyPair, self).__init__(provider, key_pair)
- class AWSVMFirewall(BaseVMFirewall):
- def __init__(self, provider, _vm_firewall):
- super(AWSVMFirewall, self).__init__(provider, _vm_firewall)
- self._rule_container = AWSVMFirewallRuleSubService(provider, self)
- @property
- def name(self):
- """
- Return the name of this VM firewall.
- """
- return self._vm_firewall.group_name
- @property
- def label(self):
- try:
- return find_tag_value(self._vm_firewall.tags, 'Name')
- except ClientError:
- return None
- @label.setter
- # pylint:disable=arguments-differ
- def label(self, value):
- self.assert_valid_resource_label(value)
- self._vm_firewall.create_tags(Tags=[{'Key': 'Name',
- 'Value': value or ""}])
- @property
- def network_id(self):
- return self._vm_firewall.vpc_id
- @property
- def rules(self):
- return self._rule_container
- def refresh(self):
- self._vm_firewall.reload()
- def to_json(self):
- attr = inspect.getmembers(self, lambda a: not inspect.isroutine(a))
- js = {k: v for (k, v) in attr if not k.startswith('_')}
- json_rules = [r.to_json() for r in self.rules]
- js['rules'] = json_rules
- if js.get('network_id'):
- js.pop('network_id') # Omit for consistency across cloud providers
- return js
- class AWSVMFirewallRule(BaseVMFirewallRule):
- def __init__(self, parent_fw, direction, rule):
- self._direction = direction
- super(AWSVMFirewallRule, self).__init__(parent_fw, rule)
- # cache id
- md5 = hashlib.md5()
- md5.update(self._name.encode('ascii'))
- self._id = md5.hexdigest()
- @property
- def id(self):
- return self._id
- @property
- def direction(self):
- return self._direction
- @property
- def protocol(self):
- return self._rule.get('IpProtocol')
- @property
- def from_port(self):
- return self._rule.get('FromPort')
- @property
- def to_port(self):
- return self._rule.get('ToPort')
- @property
- def cidr(self):
- if len(self._rule.get('IpRanges') or []) > 0:
- return self._rule['IpRanges'][0].get('CidrIp')
- return None
- @property
- def src_dest_fw_id(self):
- if len(self._rule.get('UserIdGroupPairs') or []) > 0:
- return self._rule['UserIdGroupPairs'][0]['GroupId']
- else:
- return None
- @property
- def src_dest_fw(self):
- if self.src_dest_fw_id:
- return AWSVMFirewall(
- self._provider,
- self._provider.ec2_conn.SecurityGroup(self.src_dest_fw_id))
- else:
- return None
- @staticmethod
- def _construct_ip_perms(protocol, from_port, to_port, cidr,
- src_dest_fw_id):
- return {
- 'IpProtocol': protocol,
- 'FromPort': from_port,
- 'ToPort': to_port,
- 'IpRanges': [{'CidrIp': cidr}] if cidr else None,
- 'UserIdGroupPairs': [{
- 'GroupId': src_dest_fw_id}
- ] if src_dest_fw_id else None
- }
- class AWSBucketObject(BaseBucketObject):
- class BucketObjIterator():
- CHUNK_SIZE = 4096
- def __init__(self, body):
- self.body = body
- def __iter__(self):
- while True:
- data = self.read(self.CHUNK_SIZE)
- if data:
- yield data
- else:
- break
- def read(self, length):
- return self.body.read(amt=length)
- def close(self):
- return self.body.close()
- def __init__(self, provider, obj):
- super(AWSBucketObject, self).__init__(provider)
- self._obj = obj
- @property
- def id(self):
- return self._obj.key
- @property
- def name(self):
- return self.id
- @property
- def size(self):
- try:
- return self._obj.content_length
- except AttributeError: # we're dealing with s3.ObjectSummary
- return self._obj.size
- @property
- def last_modified(self):
- return self._obj.last_modified.strftime("%Y-%m-%dT%H:%M:%S.%f")
- def iter_content(self):
- return self.BucketObjIterator(self._obj.get().get('Body'))
- def upload(self, data):
- self._obj.put(Body=data)
- def upload_from_file(self, path):
- self._obj.upload_file(path)
- def delete(self):
- self._obj.delete()
- def generate_url(self, expires_in):
- return self._provider.s3_conn.meta.client.generate_presigned_url(
- 'get_object',
- Params={'Bucket': self._obj.bucket_name, 'Key': self.id},
- ExpiresIn=expires_in)
- def refresh(self):
- self._obj.load()
- class AWSBucket(BaseBucket):
- def __init__(self, provider, bucket):
- super(AWSBucket, self).__init__(provider)
- self._bucket = bucket
- self._object_container = AWSBucketObjectSubService(provider, self)
- @property
- def id(self):
- return self._bucket.name
- @property
- def name(self):
- return self.id
- @property
- def objects(self):
- return self._object_container
- class AWSRegion(BaseRegion):
- def __init__(self, provider, aws_region):
- super(AWSRegion, self).__init__(provider)
- self._aws_region = aws_region
- @property
- def id(self):
- return self._aws_region.get('RegionName')
- @property
- def name(self):
- return self.id
- @property
- def zones(self):
- if self.id == self._provider.region_name: # optimisation
- conn = self._provider.ec2_conn
- else:
- # pylint:disable=protected-access
- conn = self._provider._connect_ec2_region(region_name=self.id)
- zones = (conn.meta.client.describe_availability_zones()
- .get('AvailabilityZones', []))
- return [AWSPlacementZone(self._provider, zone.get('ZoneName'),
- self.id)
- for zone in zones]
- class AWSNetwork(BaseNetwork):
- # Ref:
- # docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcs.html
- _NETWORK_STATE_MAP = {
- 'pending': NetworkState.PENDING,
- 'available': NetworkState.AVAILABLE,
- }
- def __init__(self, provider, network):
- super(AWSNetwork, self).__init__(provider)
- self._vpc = network
- self._gtw_container = AWSGatewaySubService(provider, self)
- self._unknown_state = False
- @property
- def id(self):
- return self._vpc.id
- @property
- def name(self):
- return self.id
- @property
- def label(self):
- return find_tag_value(self._vpc.tags, 'Name')
- @label.setter
- # pylint:disable=arguments-differ
- def label(self, value):
- self.assert_valid_resource_label(value)
- self._vpc.create_tags(Tags=[{'Key': 'Name', 'Value': value or ""}])
- @property
- def external(self):
- """
- For AWS, all VPC networks can be connected to the Internet so always
- return ``True``.
- """
- return True
- @property
- def state(self):
- if self._unknown_state:
- return NetworkState.UNKNOWN
- try:
- return AWSNetwork._NETWORK_STATE_MAP.get(
- self._vpc.state, NetworkState.UNKNOWN)
- except Exception:
- # Ignore all exceptions when querying state
- return NetworkState.UNKNOWN
- @property
- def cidr_block(self):
- return self._vpc.cidr_block
- @property
- def subnets(self):
- return [AWSSubnet(self._provider, s) for s in self._vpc.subnets.all()]
- def refresh(self):
- try:
- self._vpc.reload()
- self._unknown_state = False
- except ClientError:
- # The network no longer exists and cannot be refreshed.
- # set the status to unknown
- self._unknown_state = True
- def wait_till_ready(self, timeout=None, interval=None):
- self._provider.ec2_conn.meta.client.get_waiter('vpc_available').wait(
- VpcIds=[self.id])
- self.refresh()
- @property
- def gateways(self):
- return self._gtw_container
- class AWSSubnet(BaseSubnet):
- # http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.html
- _SUBNET_STATE_MAP = {
- 'pending': SubnetState.PENDING,
- 'available': SubnetState.AVAILABLE,
- }
- def __init__(self, provider, subnet):
- super(AWSSubnet, self).__init__(provider)
- self._subnet = subnet
- self._unknown_state = False
- @property
- def id(self):
- return self._subnet.id
- @property
- def name(self):
- return self.id
- @property
- def label(self):
- return find_tag_value(self._subnet.tags, 'Name')
- @label.setter
- # pylint:disable=arguments-differ
- def label(self, value):
- self.assert_valid_resource_label(value)
- self._subnet.create_tags(Tags=[{'Key': 'Name', 'Value': value or ""}])
- @property
- def cidr_block(self):
- return self._subnet.cidr_block
- @property
- def network_id(self):
- return self._subnet.vpc_id
- @property
- def zone(self):
- return AWSPlacementZone(self._provider, self._subnet.availability_zone,
- self._provider.region_name)
- @property
- def state(self):
- if self._unknown_state:
- return SubnetState.UNKNOWN
- try:
- return self._SUBNET_STATE_MAP.get(
- self._subnet.state, SubnetState.UNKNOWN)
- except Exception:
- # Ignore all exceptions when querying state
- return SubnetState.UNKNOWN
- def refresh(self):
- try:
- self._subnet.reload()
- self._unknown_state = False
- except ClientError:
- # subnet no longer exists
- self._unknown_state = True
- class AWSFloatingIP(BaseFloatingIP):
- def __init__(self, provider, floating_ip):
- super(AWSFloatingIP, self).__init__(provider)
- self._ip = floating_ip
- @property
- def id(self):
- return self._ip.allocation_id
- @property
- def public_ip(self):
- return self._ip.public_ip
- @property
- def private_ip(self):
- return self._ip.private_ip_address
- @property
- def in_use(self):
- return True if self._ip.association_id else False
- def refresh(self):
- self._ip.reload()
- class AWSRouter(BaseRouter):
- def __init__(self, provider, route_table):
- super(AWSRouter, self).__init__(provider)
- self._route_table = route_table
- @property
- def id(self):
- return self._route_table.id
- @property
- def name(self):
- return self.id
- @property
- def label(self):
- return find_tag_value(self._route_table.tags, 'Name')
- @label.setter
- # pylint:disable=arguments-differ
- def label(self, value):
- self.assert_valid_resource_label(value)
- self._route_table.create_tags(Tags=[{'Key': 'Name',
- 'Value': value or ""}])
- def refresh(self):
- try:
- self._route_table.reload()
- except ClientError:
- self._route_table.associations = None
- @property
- def state(self):
- if self._route_table.associations:
- return RouterState.ATTACHED
- return RouterState.DETACHED
- @property
- def network_id(self):
- return self._route_table.vpc_id
- def attach_subnet(self, subnet):
- subnet_id = subnet.id if isinstance(subnet, AWSSubnet) else subnet
- self._route_table.associate_with_subnet(SubnetId=subnet_id)
- self.refresh()
- def detach_subnet(self, subnet):
- subnet_id = subnet.id if isinstance(subnet, AWSSubnet) else subnet
- associations = [a for a in self._route_table.associations
- if a.subnet_id == subnet_id]
- for a in associations:
- a.delete()
- self.refresh()
- @property
- def subnets(self):
- return [AWSSubnet(self._provider, rta.subnet)
- for rta in self._route_table.associations if rta.subnet]
- def attach_gateway(self, gateway):
- gw_id = (gateway.id if isinstance(gateway, AWSInternetGateway)
- else gateway)
- if self._route_table.create_route(
- DestinationCidrBlock='0.0.0.0/0', GatewayId=gw_id):
- return True
- return False
- def detach_gateway(self, gateway):
- gw_id = (gateway.id if isinstance(gateway, AWSInternetGateway)
- else gateway)
- return self._provider.ec2_conn.meta.client.detach_internet_gateway(
- InternetGatewayId=gw_id, VpcId=self._route_table.vpc_id)
- class AWSInternetGateway(BaseInternetGateway):
- def __init__(self, provider, gateway):
- super(AWSInternetGateway, self).__init__(provider)
- self._gateway = gateway
- self._gateway.state = ''
- self._fips_container = AWSFloatingIPSubService(provider, self)
- @property
- def id(self):
- return self._gateway.id
- @property
- def name(self):
- return find_tag_value(self._gateway.tags, 'Name')
- def refresh(self):
- try:
- self._gateway.reload()
- except ClientError:
- self._gateway.state = GatewayState.UNKNOWN
- @property
- def state(self):
- if self._gateway.state == GatewayState.UNKNOWN:
- return GatewayState.UNKNOWN
- else:
- return GatewayState.AVAILABLE
- @property
- def network_id(self):
- if self._gateway.attachments:
- return self._gateway.attachments[0].get('VpcId')
- return None
- @property
- def floating_ips(self):
- return self._fips_container
- class AWSLaunchConfig(BaseLaunchConfig):
- def __init__(self, provider):
- super(AWSLaunchConfig, self).__init__(provider)
|