valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-08 17:33:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

INfRA-1881 - add 'filters' option to boto_ec2.find_instances, etc.

Browse Source
This commit is contained in:
Tom Williams 2016-08-01 12:41:02 -04:00
parent 316ac62463
commit f2f1eee722
2 changed files with 37 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
salt/modules/boto_ec2.py
View File

@ -439,7 +439,7 @@ def get_zones(region=None, key=None, keyid=None, profile=None):
def find_instances(instance_id=None, name=None, tags=None, region=None, def find_instances(instance_id=None, name=None, tags=None, region=None,
key=None, keyid=None, profile=None, return_objs=False, key=None, keyid=None, profile=None, return_objs=False,
in_states=None): in_states=None, filters=None):
''' '''
Given instance properties, find and return matching instance ids Given instance properties, find and return matching instance ids
@ -451,6 +451,7 @@ def find_instances(instance_id=None, name=None, tags=None, region=None,
salt myminion boto_ec2.find_instances # Lists all instances salt myminion boto_ec2.find_instances # Lists all instances
salt myminion boto_ec2.find_instances name=myinstance salt myminion boto_ec2.find_instances name=myinstance
salt myminion boto_ec2.find_instances tags='{"mytag": "value"}' salt myminion boto_ec2.find_instances tags='{"mytag": "value"}'
salt myminion boto_ec2.find_instances filters='{"vpc-id": "vpc-12345678"}'
''' '''
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile) conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
@ -468,7 +469,10 @@ def find_instances(instance_id=None, name=None, tags=None, region=None,
for tag_name, tag_value in six.iteritems(tags): for tag_name, tag_value in six.iteritems(tags):
filter_parameters['filters']['tag:{0}'.format(tag_name)] = tag_value filter_parameters['filters']['tag:{0}'.format(tag_name)] = tag_value
reservations = conn.get_all_instances(**filter_parameters) if filters:
filter_parameters['filters'].update(filters)
reservations = conn.get_all_reservations(**filter_parameters)
instances = [i for r in reservations for i in r.instances] instances = [i for r in reservations for i in r.instances]
log.debug('The filters criteria {0} matched the following ' log.debug('The filters criteria {0} matched the following '
'instances:{1}'.format(filter_parameters, instances)) 'instances:{1}'.format(filter_parameters, instances))
@ -490,7 +494,7 @@ def find_instances(instance_id=None, name=None, tags=None, region=None,
def create_image(ami_name, instance_id=None, instance_name=None, tags=None, region=None, def create_image(ami_name, instance_id=None, instance_name=None, tags=None, region=None,
key=None, keyid=None, profile=None, description=None, no_reboot=False, key=None, keyid=None, profile=None, description=None, no_reboot=False,
dry_run=False): dry_run=False, filters=None):
''' '''
Given instance properties that define exactly one instance, create AMI and return AMI-id. Given instance properties that define exactly one instance, create AMI and return AMI-id.
@ -505,7 +509,7 @@ def create_image(ami_name, instance_id=None, instance_name=None, tags=None, regi
instances = find_instances(instance_id=instance_id, name=instance_name, tags=tags, instances = find_instances(instance_id=instance_id, name=instance_name, tags=tags,
region=region, key=key, keyid=keyid, profile=profile, region=region, key=key, keyid=keyid, profile=profile,
return_objs=True) return_objs=True, filters=filters)
if not instances: if not instances:
log.error('Source instance not found') log.error('Source instance not found')
@ -533,7 +537,7 @@ def find_images(ami_name=None, executable_by=None, owners=None, image_ids=None,
.. code-block:: bash .. code-block:: bash
salt myminion boto_ec2.find_instances tags='{"mytag": "value"}' salt myminion boto_ec2.find_images tags='{"mytag": "value"}'
''' '''
conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile) conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile)
@ -573,7 +577,7 @@ def find_images(ami_name=None, executable_by=None, owners=None, image_ids=None,
def terminate(instance_id=None, name=None, region=None, def terminate(instance_id=None, name=None, region=None,
key=None, keyid=None, profile=None): key=None, keyid=None, profile=None, filters=None):
''' '''
Terminate the instance described by instance_id or name. Terminate the instance described by instance_id or name.
@ -586,7 +590,8 @@ def terminate(instance_id=None, name=None, region=None,
''' '''
instances = find_instances(instance_id=instance_id, name=name, instances = find_instances(instance_id=instance_id, name=name,
region=region, key=key, keyid=keyid, region=region, key=key, keyid=keyid,
profile=profile, return_objs=True) profile=profile, return_objs=True,
filters=filters)
if instances in (False, None, []): if instances in (False, None, []):
return instances return instances
@ -599,7 +604,7 @@ def terminate(instance_id=None, name=None, region=None,
def get_id(name=None, tags=None, region=None, key=None, def get_id(name=None, tags=None, region=None, key=None,
keyid=None, profile=None, in_states=None): keyid=None, profile=None, in_states=None, filters=None):
''' '''
Given instance properties, return the instance id if it exists. Given instance properties, return the instance id if it exists.
@ -612,7 +617,8 @@ def get_id(name=None, tags=None, region=None, key=None,
''' '''
instance_ids = find_instances(name=name, tags=tags, region=region, key=key, instance_ids = find_instances(name=name, tags=tags, region=region, key=key,
keyid=keyid, profile=profile, in_states=in_states) keyid=keyid, profile=profile, in_states=in_states,
filters=filters)
if instance_ids: if instance_ids:
log.info("Instance ids: {0}".format(" ".join(instance_ids))) log.info("Instance ids: {0}".format(" ".join(instance_ids)))
if len(instance_ids) == 1: if len(instance_ids) == 1:
@ -626,7 +632,7 @@ def get_id(name=None, tags=None, region=None, key=None,
def exists(instance_id=None, name=None, tags=None, region=None, key=None, def exists(instance_id=None, name=None, tags=None, region=None, key=None,
keyid=None, profile=None, in_states=None): keyid=None, profile=None, in_states=None, filters=None):
''' '''
Given a instance id, check to see if the given instance id exists. Given a instance id, check to see if the given instance id exists.
@ -641,7 +647,7 @@ def exists(instance_id=None, name=None, tags=None, region=None, key=None,
''' '''
instances = find_instances(instance_id=instance_id, name=name, tags=tags, instances = find_instances(instance_id=instance_id, name=name, tags=tags,
region=region, key=key, keyid=keyid, region=region, key=key, keyid=keyid,
profile=profile, in_states=in_states) profile=profile, in_states=in_states, filters=filters)
if instances: if instances:
log.info('Instance exists.') log.info('Instance exists.')
return True return True
@ -1049,7 +1055,7 @@ def get_keys(keynames=None, filters=None, region=None, key=None,
def get_attribute(attribute, instance_name=None, instance_id=None, region=None, key=None, def get_attribute(attribute, instance_name=None, instance_id=None, region=None, key=None,
keyid=None, profile=None): keyid=None, profile=None, filters=None):
''' '''
Get an EC2 instance attribute. Get an EC2 instance attribute.
@ -1088,7 +1094,8 @@ def get_attribute(attribute, instance_name=None, instance_id=None, region=None,
raise SaltInvocationError('Attribute must be one of: {0}.'.format(attribute_list)) raise SaltInvocationError('Attribute must be one of: {0}.'.format(attribute_list))
try: try:
if instance_name: if instance_name:
instances = find_instances(name=instance_name, region=region, key=key, keyid=keyid, profile=profile) instances = find_instances(name=instance_name, region=region, key=key, keyid=keyid, profile=profile,
filters=filters)
if len(instances) > 1: if len(instances) > 1:
log.error('Found more than one EC2 instance matching the criteria.') log.error('Found more than one EC2 instance matching the criteria.')
return False return False
@ -1106,7 +1113,7 @@ def get_attribute(attribute, instance_name=None, instance_id=None, region=None,
def set_attribute(attribute, attribute_value, instance_name=None, instance_id=None, region=None, key=None, keyid=None, def set_attribute(attribute, attribute_value, instance_name=None, instance_id=None, region=None, key=None, keyid=None,
profile=None): profile=None, filters=None):
''' '''
Set an EC2 instance attribute. Set an EC2 instance attribute.
Returns whether the operation succeeded or not. Returns whether the operation succeeded or not.
@ -1145,7 +1152,8 @@ def set_attribute(attribute, attribute_value, instance_name=None, instance_id=No
raise SaltInvocationError('Attribute must be one of: {0}.'.format(attribute_list)) raise SaltInvocationError('Attribute must be one of: {0}.'.format(attribute_list))
try: try:
if instance_name: if instance_name:
instances = find_instances(name=instance_name, region=region, key=key, keyid=keyid, profile=profile) instances = find_instances(name=instance_name, region=region, key=key, keyid=keyid, profile=profile,
filters=filters)
if len(instances) != 1: if len(instances) != 1:
raise CommandExecutionError('Found more than one EC2 instance matching the criteria.') raise CommandExecutionError('Found more than one EC2 instance matching the criteria.')
instance_id = instances[0] instance_id = instances[0]

18
salt/states/boto_ec2.py
View File

@ -914,7 +914,7 @@ def instance_present(name, instance_name=None, instance_id=None, image_id=None,
def instance_absent(name, instance_name=None, instance_id=None, def instance_absent(name, instance_name=None, instance_id=None,
release_eip=False, region=None, key=None, keyid=None, release_eip=False, region=None, key=None, keyid=None,
profile=None): profile=None, filters=None):
''' '''
Ensure an EC2 instance does not exist (is stopped and removed). Ensure an EC2 instance does not exist (is stopped and removed).
@ -935,8 +935,17 @@ def instance_absent(name, instance_name=None, instance_id=None,
profile profile
(variable) - A dict with region, key and keyid, or a pillar key (string) (variable) - A dict with region, key and keyid, or a pillar key (string)
that contains a dict with region, key and keyid. that contains a dict with region, key and keyid.
filters
(dict) - A dict of additional filters to use in matching the instance to
delete.
.. versionadded:: 2016.3.0 YAML example fragment:
.. code-block:: yaml
- filters:
vpc-id: vpc-abcdef12
.. versionupdated:: Carbon
''' '''
### TODO - Implement 'force' option?? Would automagically turn off ### TODO - Implement 'force' option?? Would automagically turn off
### 'disableApiTermination', as needed, before trying to delete. ### 'disableApiTermination', as needed, before trying to delete.
@ -951,7 +960,8 @@ def instance_absent(name, instance_name=None, instance_id=None,
try: try:
instance_id = __salt__['boto_ec2.get_id'](name=instance_name if instance_name else name, instance_id = __salt__['boto_ec2.get_id'](name=instance_name if instance_name else name,
region=region, key=key, keyid=keyid, region=region, key=key, keyid=keyid,
profile=profile, in_states=running_states) profile=profile, in_states=running_states,
filters=filters)
except CommandExecutionError as e: except CommandExecutionError as e:
ret['result'] = None ret['result'] = None
ret['comment'] = ("Couldn't determine current status of instance " ret['comment'] = ("Couldn't determine current status of instance "
@ -960,7 +970,7 @@ def instance_absent(name, instance_name=None, instance_id=None,
instances = __salt__['boto_ec2.find_instances'](instance_id=instance_id, region=region, instances = __salt__['boto_ec2.find_instances'](instance_id=instance_id, region=region,
key=key, keyid=keyid, profile=profile, key=key, keyid=keyid, profile=profile,
return_objs=True) return_objs=True, filters=filters)
if not len(instances): if not len(instances):
ret['result'] = True ret['result'] = True
ret['comment'] = 'Instance {0} is already gone.'.format(instance_id) ret['comment'] = 'Instance {0} is already gone.'.format(instance_id)