changed modules to use common ec2 docs for region

10 years ago · c4f64d822c
parent 661a0cb9ee
commit c4f64d822c
22 changed files with 67 additions and 113 deletions
--- a/cloud/amazon/ec2_ami.py
+++ b/cloud/amazon/ec2_ami.py
@ -47,12 +47,6 @@ options:
      - create or deregister/delete image
    required: false
    default: 'present'
-  region:
-    description:
-      - The AWS region to use.  Must be specified if ec2_url is not used. If not specified then the value of the EC2_REGION environment variable, if any, is used.
-    required: false
-    default: null
-    aliases: [ 'aws_region', 'ec2_region' ]
  description:
    description:
      - An optional human-readable string describing the contents and purpose of the AMI.
@ -89,7 +83,9 @@ options:
    version_added: "2.0"

 author: "Evan Duffield (@scicoin-project) <eduffield@iacquire.com>"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 # Thank you to iAcquire for sponsoring development of this module.
--- a/cloud/amazon/ec2_asg.py
+++ b/cloud/amazon/ec2_asg.py
@ -80,11 +80,6 @@ options:
    required: false
    version_added: "1.8"
    default: True
-  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']
  vpc_zone_identifier:
    description:
      - List of VPC subnets to use
@ -134,7 +129,9 @@ options:
    default: Default
    choices: ['OldestInstance', 'NewestInstance', 'OldestLaunchConfiguration', 'ClosestToNextInstanceHour', 'Default']
    version_added: "2.0"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 """

 EXAMPLES = '''
--- a/cloud/amazon/ec2_eip.py
+++ b/cloud/amazon/ec2_eip.py
@ -40,12 +40,6 @@ options:
    required: false
    choices: ['present', 'absent']
    default: present
-  region:
-    description:
-      - the EC2 region to use
-    required: false
-    default: null
-    aliases: [ ec2_region ]
  in_vpc:
    description:
      - allocate an EIP inside a VPC or not
@ -64,7 +58,9 @@ options:
    required: false
    default: false
    version_added: "2.0"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 author: "Lorin Hochstein (@lorin) <lorin@nimbisservices.com>"
 author: "Rick Mendes (@rickmendes) <rmendes@illumina.com>"
 notes:
--- a/cloud/amazon/ec2_elb.py
+++ b/cloud/amazon/ec2_elb.py
@ -41,11 +41,6 @@ options:
      - 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
-  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']
  enable_availability_zone:
    description:
      - Whether to enable the availability zone of the instance on the target ELB if the availability zone has not already
@ -73,7 +68,9 @@ options:
    required: false
    default: 0
    version_added: "1.6"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 """

 EXAMPLES = """
--- a/cloud/amazon/ec2_elb_lb.py
+++ b/cloud/amazon/ec2_elb_lb.py
@ -69,11 +69,6 @@ options:
      - An associative array of health check configuration settings (see example)
    require: false
    default: None
-  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']
  subnets:
    description:
      - A list of VPC subnets to use when creating ELB. Zones should be empty if using this.
@ -121,7 +116,9 @@ options:
    required: false
    version_added: "2.0"

-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 """

 EXAMPLES = """
--- a/cloud/amazon/ec2_group.py
+++ b/cloud/amazon/ec2_group.py
@ -45,12 +45,6 @@ options:
      - List of firewall outbound rules to enforce in this group (see example). If none are supplied, a default all-out rule is assumed. If an empty list is supplied, no outbound rules will be enabled.
    required: false
    version_added: "1.6"
-  region:
-    description:
-      - the EC2 region to use
-    required: false
-    default: null
-    aliases: []
  state:
    version_added: "1.4"
    description:
@ -74,7 +68,9 @@ options:
    default: 'true'
    aliases: []

-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2

 notes:
  - If a rule declares a group_name and that group doesn't exist, it will be
--- a/cloud/amazon/ec2_key.py
+++ b/cloud/amazon/ec2_key.py
@ -31,12 +31,6 @@ options:
    description:
      - Public key material.
    required: false
-  region:
-    description:
-      - the EC2 region to use
-    required: false
-    default: null
-    aliases: []
  state:
    description:
      - create or delete keypair
@ -58,7 +52,9 @@ options:
    aliases: []
    version_added: "1.6"

-extends_documentation_fragment: aws
+extends_documentation_fragment:
+ - aws
+ - ec2
 author: "Vincent Viallet (@zbal)"
 '''

--- a/cloud/amazon/ec2_lc.py
+++ b/cloud/amazon/ec2_lc.py
@ -55,11 +55,6 @@ options:
    description:
      - A list of security groups into which instances should be found
    required: false
-  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']
  volumes:
    description:
      - a list of volume dicts, each containing device name and optionally ephemeral id or snapshot id. Size and type (and number of iops for io device type) must be specified for a new volume or a root volume, and may be passed for a snapshot volume. For any volume, a volume size less than 1 will be interpreted as a request not to create the volume.
@ -128,7 +123,9 @@ options:
    required: false
    default: null
    version_added: "2.0"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 """

 EXAMPLES = '''
--- a/cloud/amazon/ec2_metric_alarm.py
+++ b/cloud/amazon/ec2_metric_alarm.py
@ -89,7 +89,9 @@ options:
        description:
          - A list of the names of action(s) to take when the alarm is in the 'ok' status
        required: false
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 """

 EXAMPLES = '''
--- a/cloud/amazon/ec2_scaling_policy.py
+++ b/cloud/amazon/ec2_scaling_policy.py
@ -53,7 +53,9 @@ options:
    description:
      - The minimum period of time between which autoscaling actions can take place
    required: false
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 """

 EXAMPLES = '''
--- a/cloud/amazon/ec2_snapshot.py
+++ b/cloud/amazon/ec2_snapshot.py
@ -22,11 +22,6 @@ description:
    - creates an EC2 snapshot from an existing EBS volume
 version_added: "1.5"
 options:
-  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']
  volume_id:
    description:
      - volume from which to take the snapshot
@ -82,7 +77,9 @@ options:
    version_added: "1.9"

 author: "Will Thames (@willthames)"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/cloud/amazon/ec2_tag.py
+++ b/cloud/amazon/ec2_tag.py
@ -22,12 +22,6 @@ description:
    - Creates, removes and lists tags from any EC2 resource.  The resource is referenced by its resource id (e.g. an instance being i-XXXXXXX). It is designed to be used with complex args (tags), see the examples.  This module has a dependency on python-boto.
 version_added: "1.3"
 options:
-  region:
-    description:
-      - region in which the resource exists. 
-    required: false
-    default: null
-    aliases: ['aws_region', 'ec2_region']
  resource:
    description:
      - The EC2 resource id. 
@ -49,7 +43,9 @@ options:
    aliases: []

 author: "Lester Wade (@lwade)"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/cloud/amazon/ec2_vol.py
+++ b/cloud/amazon/ec2_vol.py
@ -74,12 +74,6 @@ options:
    required: false
    default: null
    aliases: []
-  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
-    default: null
-    aliases: ['aws_region', 'ec2_region']
  zone:
    description:
      - zone in which to create the volume, if unset uses the zone the instance is in (if set) 
@ -108,7 +102,9 @@ options:
    choices: ['absent', 'present', 'list']
    version_added: "1.6"
 author: "Lester Wade (@lwade)"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/cloud/amazon/ec2_vpc.py
+++ b/cloud/amazon/ec2_vpc.py
@ -94,14 +94,10 @@ options:
    required: true
    default: present
    aliases: []
-  region:
-    description:
-      - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used.
-    required: true
-    default: null
-    aliases: ['aws_region', 'ec2_region']
 author: "Carson Gee (@carsongee)"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/cloud/amazon/ec2_vpc_net.py
+++ b/cloud/amazon/ec2_vpc_net.py
@ -72,7 +72,9 @@ options:
    default: false
    required: false

-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/cloud/amazon/elasticache.py
+++ b/cloud/amazon/elasticache.py
@ -97,13 +97,9 @@ options:
    required: false
    default: no
    choices: [ "yes", "no" ]
-  region:
-    description:
-      - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used.
-    required: true
-    default: null
-    aliases: ['aws_region', 'ec2_region']
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 """

 EXAMPLES = """
--- a/cloud/amazon/elasticache_subnet_group.py
+++ b/cloud/amazon/elasticache_subnet_group.py
@ -42,13 +42,10 @@ options:
      - List of subnet IDs that make up the Elasticache subnet group.
    required: false
    default: null
-  region:
-    description:
-      - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used.
-    required: true
-    aliases: ['aws_region', 'ec2_region']
 author: "Tim Mahoney (@timmahoney)"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/cloud/amazon/iam.py
+++ b/cloud/amazon/iam.py
@ -97,10 +97,12 @@ options:
    aliases: [ 'ec2_access_key', 'access_key' ]
 notes:
  - 'Currently boto does not support the removal of Managed Policies, the module will error out if your user/group/role has managed policies when you try to do state=absent. They will need to be removed manually.'
-author: 
+author:
    - "Jonathan I. Davila (@defionscode)"
    - "Paul Seiffert (@seiffert)"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/cloud/amazon/iam_cert.py
+++ b/cloud/amazon/iam_cert.py
@ -85,7 +85,9 @@ options:

 requirements: [ "boto" ]
 author: Jonathan I. Davila
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/cloud/amazon/iam_policy.py
+++ b/cloud/amazon/iam_policy.py
@ -58,7 +58,9 @@ options:
 notes:
  - 'Currently boto does not support the removal of Managed Policies, the module will not work removing/adding managed policies.'
 author: "Jonathan I. Davila (@defionscode)"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/cloud/amazon/rds_param_group.py
+++ b/cloud/amazon/rds_param_group.py
@ -61,14 +61,10 @@ options:
    default: null
    aliases: []
    choices: [ 'mysql5.1', 'mysql5.5', 'mysql5.6', 'oracle-ee-11.2', 'oracle-se-11.2', 'oracle-se1-11.2', 'postgres9.3', 'postgres9.4', 'sqlserver-ee-10.5', 'sqlserver-ee-11.0', 'sqlserver-ex-10.5', 'sqlserver-ex-11.0', 'sqlserver-se-10.5', 'sqlserver-se-11.0', 'sqlserver-web-10.5', 'sqlserver-web-11.0']
-  region:
-    description:
-      - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used.
-    required: true
-    default: null
-    aliases: ['aws_region', 'ec2_region']
 author: "Scott Anderson (@tastychutney)"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''
--- a/cloud/amazon/rds_subnet_group.py
+++ b/cloud/amazon/rds_subnet_group.py
@ -47,14 +47,10 @@ options:
    required: false
    default: null
    aliases: []
-  region:
-    description:
-      - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used.
-    required: true
-    default: null
-    aliases: ['aws_region', 'ec2_region']
 author: "Scott Anderson (@tastychutney)"
-extends_documentation_fragment: aws
+extends_documentation_fragment:
+    - aws
+    - ec2
 '''

 EXAMPLES = '''