From e7b275483c03f4b69e570691a9a8122a56c5893a Mon Sep 17 00:00:00 2001 From: Will Thames Date: Wed, 9 Apr 2014 22:44:29 +1000 Subject: [PATCH] Use common code for ec2_elb and ec2_elb_lb Uses the new get_aws_connection_info and connect_to_aws common methods to reuse code Now complains if region is not set in one of the three possible methods Also moved over to common documentation code so this is actually based on #6913 --- library/cloud/ec2_elb | 46 ++++++++++++---------------------------- library/cloud/ec2_elb_lb | 45 +++++++++------------------------------ 2 files changed, 24 insertions(+), 67 deletions(-) diff --git a/library/cloud/ec2_elb b/library/cloud/ec2_elb index 21d771221b..e76816fbca 100644 --- a/library/cloud/ec2_elb +++ b/library/cloud/ec2_elb @@ -25,7 +25,6 @@ description: if state=absent is passed as an argument. - Will be marked changed when called only if there are ELBs found to operate on. version_added: "1.2" -requirements: [ "boto" ] author: John Jarvis options: state: @@ -33,29 +32,15 @@ options: - register or deregister the instance required: true choices: ['present', 'absent'] - instance_id: description: - EC2 Instance ID required: true - ec2_elbs: description: - List of ELB names, required for registration. The ec2_elbs fact should be used if there was a previous de-register. required: false default: None - aws_secret_key: - description: - - AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used. - required: false - default: None - aliases: ['ec2_secret_key', 'secret_key' ] - aws_access_key: - description: - - AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used. - required: false - default: None - aliases: ['ec2_access_key', 'access_key' ] region: description: - The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used. @@ -88,7 +73,7 @@ options: required: false default: 0 version_added: "1.6" - +extends_documentation_fragment: aws """ EXAMPLES = """ @@ -130,12 +115,11 @@ class ElbManager: """Handles EC2 instance ELB registration and de-registration""" def __init__(self, module, instance_id=None, ec2_elbs=None, - aws_access_key=None, aws_secret_key=None, region=None): - self.aws_access_key = aws_access_key - self.aws_secret_key = aws_secret_key + region=None, **aws_connect_params): self.module = module self.instance_id = instance_id self.region = region + self.aws_connect_params = aws_connect_params self.lbs = self._get_instance_lbs(ec2_elbs) self.changed = False @@ -270,9 +254,8 @@ class ElbManager: are attached to self.instance_id""" try: - endpoint="elasticloadbalancing.%s.amazonaws.com" % self.region - connect_region = RegionInfo(name=self.region, endpoint=endpoint) - elb = boto.ec2.elb.ELBConnection(self.aws_access_key, self.aws_secret_key, region=connect_region) + elb = connect_to_aws(boto.ec2.elb, self.region, + **self.aws_connect_params) except boto.exception.NoAuthHandlerFound, e: self.module.fail_json(msg=str(e)) @@ -291,12 +274,11 @@ class ElbManager: def _get_instance(self): """Returns a boto.ec2.InstanceObject for self.instance_id""" try: - endpoint = "ec2.%s.amazonaws.com" % self.region - connect_region = RegionInfo(name=self.region, endpoint=endpoint) - ec2_conn = boto.ec2.EC2Connection(self.aws_access_key, self.aws_secret_key, region=connect_region) + ec2 = connect_to_aws(boto.ec2, self.region, + **self.aws_connect_params) except boto.exception.NoAuthHandlerFound, e: self.module.fail_json(msg=str(e)) - return ec2_conn.get_only_instances(instance_ids=[self.instance_id])[0] + return ec2.get_only_instances(instance_ids=[self.instance_id])[0] def main(): @@ -315,12 +297,12 @@ def main(): argument_spec=argument_spec, ) - # def get_ec2_creds(module): - # return ec2_url, ec2_access_key, ec2_secret_key, region - ec2_url, aws_access_key, aws_secret_key, region = get_ec2_creds(module) + region, ec2_url, aws_connect_params = get_aws_connection_info(module) + + if not region: + module.fail_json(msg="Region must be specified as a parameter, in EC2_REGION or AWS_REGION environment variables or in boto configuration file") ec2_elbs = module.params['ec2_elbs'] - region = module.params['region'] wait = module.params['wait'] enable_availability_zone = module.params['enable_availability_zone'] timeout = module.params['wait_timeout'] @@ -329,8 +311,8 @@ def main(): module.fail_json(msg="ELBs are required for registration") instance_id = module.params['instance_id'] - elb_man = ElbManager(module, instance_id, ec2_elbs, aws_access_key, - aws_secret_key, region=region) + elb_man = ElbManager(module, instance_id, ec2_elbs, + region=region, **aws_connect_params) if ec2_elbs is not None: for elb in ec2_elbs: diff --git a/library/cloud/ec2_elb_lb b/library/cloud/ec2_elb_lb index 0737b1a087..5de76cb5df 100644 --- a/library/cloud/ec2_elb_lb +++ b/library/cloud/ec2_elb_lb @@ -22,7 +22,6 @@ short_description: Creates or destroys Amazon ELB. - Returns information about the load balancer. - Will be marked changed when called only if state is changed. version_added: "1.5" -requirements: [ "boto" ] author: Jim Dalton options: state: @@ -62,32 +61,12 @@ options: - An associative array of health check configuration settigs (see example) require: false default: None - aws_secret_key: - description: - - AWS secret key. If not set then the value of the AWS_SECRET_KEY environment variable is used. - required: false - default: None - aliases: ['ec2_secret_key', 'secret_key'] - aws_access_key: - description: - - AWS access key. If not set then the value of the AWS_ACCESS_KEY environment variable is used. - required: false - default: None - aliases: ['ec2_access_key', 'access_key'] region: description: - The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used. required: false aliases: ['aws_region', 'ec2_region'] - validate_certs: - description: - - When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. - required: false - default: "yes" - choices: ["yes", "no"] - aliases: [] - version_added: "1.5" - +extends_documentation_fragment: aws """ EXAMPLES = """ @@ -190,7 +169,7 @@ class ElbManager(object): def __init__(self, module, name, listeners=None, purge_listeners=None, zones=None, purge_zones=None, security_group_ids=None, health_check=None, - aws_access_key=None, aws_secret_key=None, region=None): + region=None, **aws_connect_params): self.module = module self.name = name self.listeners = listeners @@ -200,8 +179,7 @@ class ElbManager(object): self.security_group_ids = security_group_ids self.health_check = health_check - self.aws_access_key = aws_access_key - self.aws_secret_key = aws_secret_key + self.aws_connect_params = aws_connect_params self.region = region self.changed = False @@ -271,11 +249,8 @@ class ElbManager(object): def _get_elb_connection(self): try: - endpoint = "elasticloadbalancing.%s.amazonaws.com" % self.region - connect_region = RegionInfo(name=self.region, endpoint=endpoint) - return boto.ec2.elb.ELBConnection(self.aws_access_key, - self.aws_secret_key, - region=connect_region) + return connect_to_aws(boto.ec2.elb, self.region, + **self.aws_connect_params) except boto.exception.NoAuthHandlerFound, e: self.module.fail_json(msg=str(e)) @@ -479,9 +454,9 @@ def main(): argument_spec=argument_spec, ) - # def get_ec2_creds(module): - # return ec2_url, ec2_access_key, ec2_secret_key, region - ec2_url, aws_access_key, aws_secret_key, region = get_ec2_creds(module) + region, ec2_url, aws_connect_params = get_aws_connection_info(module) + if not region: + module.fail_json(msg="Region must be specified as a parameter, in EC2_REGION or AWS_REGION environment variables or in boto configuration file") name = module.params['name'] state = module.params['state'] @@ -499,8 +474,8 @@ def main(): module.fail_json(msg="At least one availability zone is required for ELB creation") elb_man = ElbManager(module, name, listeners, purge_listeners, zones, - purge_zones, security_group_ids, health_check, aws_access_key, - aws_secret_key, region=region) + purge_zones, security_group_ids, health_check, + region=region, **aws_connect_params) if state == 'present': elb_man.ensure_ok()