minor doc fixes
This commit is contained in:
parent
4b78b5597f
commit
8227b48a6a
9 changed files with 14 additions and 59 deletions
|
@ -26,35 +26,28 @@ options:
|
||||||
description:
|
description:
|
||||||
- name of the cloudformation stack
|
- name of the cloudformation stack
|
||||||
required: true
|
required: true
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
disable_rollback:
|
disable_rollback:
|
||||||
description:
|
description:
|
||||||
- If a stacks fails to form, rollback will remove the stack
|
- If a stacks fails to form, rollback will remove the stack
|
||||||
required: false
|
required: false
|
||||||
default: "false"
|
default: "false"
|
||||||
choices: [ "true", "false" ]
|
choices: [ "true", "false" ]
|
||||||
aliases: []
|
|
||||||
template_parameters:
|
template_parameters:
|
||||||
description:
|
description:
|
||||||
- a list of hashes of all the template variables for the stack
|
- a list of hashes of all the template variables for the stack
|
||||||
required: false
|
required: false
|
||||||
default: {}
|
default: {}
|
||||||
aliases: []
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- If state is "present", stack will be created. If state is "present" and if stack exists and template has changed, it will be updated.
|
- If state is "present", stack will be created. If state is "present" and if stack exists and template has changed, it will be updated.
|
||||||
If state is "absent", stack will be removed.
|
If state is "absent", stack will be removed.
|
||||||
required: true
|
required: true
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
template:
|
template:
|
||||||
description:
|
description:
|
||||||
- The local path of the cloudformation template. This parameter is mutually exclusive with 'template_url'. Either one of them is required if "state" parameter is "present"
|
- The local path of the cloudformation template. This parameter is mutually exclusive with 'template_url'. Either one of them is required if "state" parameter is "present"
|
||||||
Must give full path to the file, relative to the working directory. If using roles this may look like "roles/cloudformation/files/cloudformation-example.json"
|
Must give full path to the file, relative to the working directory. If using roles this may look like "roles/cloudformation/files/cloudformation-example.json"
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
notification_arns:
|
notification_arns:
|
||||||
description:
|
description:
|
||||||
- The Simple Notification Service (SNS) topic ARNs to publish stack related events.
|
- The Simple Notification Service (SNS) topic ARNs to publish stack related events.
|
||||||
|
@ -66,7 +59,6 @@ options:
|
||||||
- the path of the cloudformation stack policy
|
- the path of the cloudformation stack policy
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
version_added: "1.9"
|
version_added: "1.9"
|
||||||
tags:
|
tags:
|
||||||
description:
|
description:
|
||||||
|
@ -74,13 +66,11 @@ options:
|
||||||
Requires at least Boto version 2.6.0.
|
Requires at least Boto version 2.6.0.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
version_added: "1.4"
|
version_added: "1.4"
|
||||||
region:
|
region:
|
||||||
description:
|
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.
|
- 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
|
required: true
|
||||||
default: null
|
|
||||||
aliases: ['aws_region', 'ec2_region']
|
aliases: ['aws_region', 'ec2_region']
|
||||||
version_added: "1.5"
|
version_added: "1.5"
|
||||||
template_url:
|
template_url:
|
||||||
|
|
|
@ -18,7 +18,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: ec2_ami_find
|
module: ec2_ami_find
|
||||||
version_added: 2.0
|
version_added: '2.0'
|
||||||
short_description: Searches for AMIs to obtain the AMI ID and other information
|
short_description: Searches for AMIs to obtain the AMI ID and other information
|
||||||
description:
|
description:
|
||||||
- Returns list of matching AMIs with AMI ID, along with other useful information
|
- Returns list of matching AMIs with AMI ID, along with other useful information
|
||||||
|
|
|
@ -5,7 +5,7 @@ module: ec2_eip
|
||||||
short_description: associate an EC2 elastic IP with an instance.
|
short_description: associate an EC2 elastic IP with an instance.
|
||||||
description:
|
description:
|
||||||
- This module associates AWS EC2 elastic IP addresses with instances
|
- This module associates AWS EC2 elastic IP addresses with instances
|
||||||
version_added: 1.4
|
version_added: "1.4"
|
||||||
options:
|
options:
|
||||||
instance_id:
|
instance_id:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -29,7 +29,7 @@ options:
|
||||||
required: false
|
required: false
|
||||||
default: 'yes'
|
default: 'yes'
|
||||||
choices: ['yes', 'no']
|
choices: ['yes', 'no']
|
||||||
version_added: 1.5.1
|
version_added: '1.5.1'
|
||||||
description:
|
description:
|
||||||
- This module fetches data from the metadata servers in ec2 (aws) as per
|
- This module fetches data from the metadata servers in ec2 (aws) as per
|
||||||
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html.
|
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html.
|
||||||
|
|
|
@ -26,73 +26,59 @@ options:
|
||||||
description:
|
description:
|
||||||
- Specifies the action to take.
|
- Specifies the action to take.
|
||||||
required: true
|
required: true
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
choices: [ 'get', 'create', 'delete' ]
|
choices: [ 'get', 'create', 'delete' ]
|
||||||
zone:
|
zone:
|
||||||
description:
|
description:
|
||||||
- The DNS zone to modify
|
- The DNS zone to modify
|
||||||
required: true
|
required: true
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
hosted_zone_id:
|
hosted_zone_id:
|
||||||
description:
|
description:
|
||||||
- The Hosted Zone ID of the DNS zone to modify
|
- The Hosted Zone ID of the DNS zone to modify
|
||||||
required: false
|
required: false
|
||||||
version_added: 2.0
|
version_added: "2.0"
|
||||||
default: null
|
default: null
|
||||||
record:
|
record:
|
||||||
description:
|
description:
|
||||||
- The full DNS record to create or delete
|
- The full DNS record to create or delete
|
||||||
required: true
|
required: true
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
ttl:
|
ttl:
|
||||||
description:
|
description:
|
||||||
- The TTL to give the new record
|
- The TTL to give the new record
|
||||||
required: false
|
required: false
|
||||||
default: 3600 (one hour)
|
default: 3600 (one hour)
|
||||||
aliases: []
|
|
||||||
type:
|
type:
|
||||||
description:
|
description:
|
||||||
- The type of DNS record to create
|
- The type of DNS record to create
|
||||||
required: true
|
required: true
|
||||||
default: null
|
|
||||||
aliases: []
|
|
||||||
choices: [ 'A', 'CNAME', 'MX', 'AAAA', 'TXT', 'PTR', 'SRV', 'SPF', 'NS' ]
|
choices: [ 'A', 'CNAME', 'MX', 'AAAA', 'TXT', 'PTR', 'SRV', 'SPF', 'NS' ]
|
||||||
alias:
|
alias:
|
||||||
description:
|
description:
|
||||||
- Indicates if this is an alias record.
|
- Indicates if this is an alias record.
|
||||||
required: false
|
required: false
|
||||||
version_added: 1.9
|
version_added: "1.9"
|
||||||
default: False
|
default: False
|
||||||
aliases: []
|
|
||||||
choices: [ 'True', 'False' ]
|
choices: [ 'True', 'False' ]
|
||||||
alias_hosted_zone_id:
|
alias_hosted_zone_id:
|
||||||
description:
|
description:
|
||||||
- The hosted zone identifier.
|
- The hosted zone identifier.
|
||||||
required: false
|
required: false
|
||||||
version_added: 1.9
|
version_added: "1.9"
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
value:
|
value:
|
||||||
description:
|
description:
|
||||||
- The new value when creating a DNS record. Multiple comma-spaced values are allowed for non-alias records. When deleting a record all values for the record must be specified or Route53 will not delete it.
|
- The new value when creating a DNS record. Multiple comma-spaced values are allowed for non-alias records. When deleting a record all values for the record must be specified or Route53 will not delete it.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
overwrite:
|
overwrite:
|
||||||
description:
|
description:
|
||||||
- Whether an existing record should be overwritten on create if values do not match
|
- Whether an existing record should be overwritten on create if values do not match
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
retry_interval:
|
retry_interval:
|
||||||
description:
|
description:
|
||||||
- In the case that route53 is still servicing a prior request, this module will wait and try again after this many seconds. If you have many domain names, the default of 500 seconds may be too long.
|
- In the case that route53 is still servicing a prior request, this module will wait and try again after this many seconds. If you have many domain names, the default of 500 seconds may be too long.
|
||||||
required: false
|
required: false
|
||||||
default: 500
|
default: 500
|
||||||
aliases: []
|
|
||||||
private_zone:
|
private_zone:
|
||||||
description:
|
description:
|
||||||
- If set to true, the private zone matching the requested name within the domain will be used if there are both public and private zones. The default is to use the public zone.
|
- If set to true, the private zone matching the requested name within the domain will be used if there are both public and private zones. The default is to use the public zone.
|
||||||
|
|
|
@ -53,7 +53,7 @@ options:
|
||||||
required: false
|
required: false
|
||||||
default: private
|
default: private
|
||||||
headers:
|
headers:
|
||||||
version_added: 2.0
|
version_added: "2.0"
|
||||||
description:
|
description:
|
||||||
- Headers to attach to object.
|
- Headers to attach to object.
|
||||||
required: false
|
required: false
|
||||||
|
|
|
@ -32,77 +32,65 @@ options:
|
||||||
- image string to use for the instance
|
- image string to use for the instance
|
||||||
required: false
|
required: false
|
||||||
default: "debian-7"
|
default: "debian-7"
|
||||||
aliases: []
|
|
||||||
instance_names:
|
instance_names:
|
||||||
description:
|
description:
|
||||||
- a comma-separated list of instance names to create or destroy
|
- a comma-separated list of instance names to create or destroy
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
machine_type:
|
machine_type:
|
||||||
description:
|
description:
|
||||||
- machine type to use for the instance, use 'n1-standard-1' by default
|
- machine type to use for the instance, use 'n1-standard-1' by default
|
||||||
required: false
|
required: false
|
||||||
default: "n1-standard-1"
|
default: "n1-standard-1"
|
||||||
aliases: []
|
|
||||||
metadata:
|
metadata:
|
||||||
description:
|
description:
|
||||||
- a hash/dictionary of custom data for the instance; '{"key":"value",...}'
|
- a hash/dictionary of custom data for the instance; '{"key":"value",...}'
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
service_account_email:
|
service_account_email:
|
||||||
version_added: 1.5.1
|
version_added: "1.5.1"
|
||||||
description:
|
description:
|
||||||
- service account email
|
- service account email
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
service_account_permissions:
|
service_account_permissions:
|
||||||
version_added: 2.0
|
version_added: "2.0"
|
||||||
description:
|
description:
|
||||||
- service account permissions (see U(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create), --scopes section for detailed information)
|
- service account permissions (see U(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create), --scopes section for detailed information)
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
choices: ["bigquery", "cloud-platform", "compute-ro", "compute-rw", "computeaccounts-ro", "computeaccounts-rw", "datastore", "logging-write", "monitoring", "sql", "sql-admin", "storage-full", "storage-ro", "storage-rw", "taskqueue", "userinfo-email"]
|
choices: ["bigquery", "cloud-platform", "compute-ro", "compute-rw", "computeaccounts-ro", "computeaccounts-rw", "datastore", "logging-write", "monitoring", "sql", "sql-admin", "storage-full", "storage-ro", "storage-rw", "taskqueue", "userinfo-email"]
|
||||||
pem_file:
|
pem_file:
|
||||||
version_added: 1.5.1
|
version_added: "1.5.1"
|
||||||
description:
|
description:
|
||||||
- path to the pem file associated with the service account email
|
- path to the pem file associated with the service account email
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
project_id:
|
project_id:
|
||||||
version_added: 1.5.1
|
version_added: "1.5.1"
|
||||||
description:
|
description:
|
||||||
- your GCE project ID
|
- your GCE project ID
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- identifier when working with a single instance
|
- identifier when working with a single instance
|
||||||
required: false
|
required: false
|
||||||
aliases: []
|
|
||||||
network:
|
network:
|
||||||
description:
|
description:
|
||||||
- name of the network, 'default' will be used if not specified
|
- name of the network, 'default' will be used if not specified
|
||||||
required: false
|
required: false
|
||||||
default: "default"
|
default: "default"
|
||||||
aliases: []
|
|
||||||
persistent_boot_disk:
|
persistent_boot_disk:
|
||||||
description:
|
description:
|
||||||
- if set, create the instance with a persistent boot disk
|
- if set, create the instance with a persistent boot disk
|
||||||
required: false
|
required: false
|
||||||
default: "false"
|
default: "false"
|
||||||
aliases: []
|
|
||||||
disks:
|
disks:
|
||||||
description:
|
description:
|
||||||
- a list of persistent disks to attach to the instance; a string value gives the name of the disk; alternatively, a dictionary value can define 'name' and 'mode' ('READ_ONLY' or 'READ_WRITE'). The first entry will be the boot disk (which must be READ_WRITE).
|
- a list of persistent disks to attach to the instance; a string value gives the name of the disk; alternatively, a dictionary value can define 'name' and 'mode' ('READ_ONLY' or 'READ_WRITE'). The first entry will be the boot disk (which must be READ_WRITE).
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
version_added: "1.7"
|
version_added: "1.7"
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
|
@ -110,40 +98,34 @@ options:
|
||||||
required: false
|
required: false
|
||||||
default: "present"
|
default: "present"
|
||||||
choices: ["active", "present", "absent", "deleted"]
|
choices: ["active", "present", "absent", "deleted"]
|
||||||
aliases: []
|
|
||||||
tags:
|
tags:
|
||||||
description:
|
description:
|
||||||
- a comma-separated list of tags to associate with the instance
|
- a comma-separated list of tags to associate with the instance
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
zone:
|
zone:
|
||||||
description:
|
description:
|
||||||
- the GCE zone to use
|
- the GCE zone to use
|
||||||
required: true
|
required: true
|
||||||
default: "us-central1-a"
|
default: "us-central1-a"
|
||||||
aliases: []
|
|
||||||
ip_forward:
|
ip_forward:
|
||||||
version_added: "1.9"
|
version_added: "1.9"
|
||||||
description:
|
description:
|
||||||
- set to true if the instance can forward ip packets (useful for gateways)
|
- set to true if the instance can forward ip packets (useful for gateways)
|
||||||
required: false
|
required: false
|
||||||
default: "false"
|
default: "false"
|
||||||
aliases: []
|
|
||||||
external_ip:
|
external_ip:
|
||||||
version_added: "1.9"
|
version_added: "1.9"
|
||||||
description:
|
description:
|
||||||
- type of external ip, ephemeral by default
|
- type of external ip, ephemeral by default
|
||||||
required: false
|
required: false
|
||||||
default: "ephemeral"
|
default: "ephemeral"
|
||||||
aliases: []
|
|
||||||
disk_auto_delete:
|
disk_auto_delete:
|
||||||
version_added: "1.9"
|
version_added: "1.9"
|
||||||
description:
|
description:
|
||||||
- if set boot disk will be removed after instance destruction
|
- if set boot disk will be removed after instance destruction
|
||||||
required: false
|
required: false
|
||||||
default: "true"
|
default: "true"
|
||||||
aliases: []
|
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 2.6"
|
- "python >= 2.6"
|
||||||
|
|
|
@ -30,7 +30,6 @@ import os
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: command
|
module: command
|
||||||
version_added: historical
|
|
||||||
short_description: Executes a command on a remote node
|
short_description: Executes a command on a remote node
|
||||||
description:
|
description:
|
||||||
- The M(command) module takes the command name followed by a list of space-delimited arguments.
|
- The M(command) module takes the command name followed by a list of space-delimited arguments.
|
||||||
|
@ -45,7 +44,6 @@ options:
|
||||||
See the examples!
|
See the examples!
|
||||||
required: true
|
required: true
|
||||||
default: null
|
default: null
|
||||||
aliases: []
|
|
||||||
creates:
|
creates:
|
||||||
description:
|
description:
|
||||||
- a filename or glob pattern, when it already exists, this step will B(not) be run.
|
- a filename or glob pattern, when it already exists, this step will B(not) be run.
|
||||||
|
|
|
@ -3,7 +3,6 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: raw
|
module: raw
|
||||||
version_added: historical
|
|
||||||
short_description: Executes a low-down and dirty SSH command
|
short_description: Executes a low-down and dirty SSH command
|
||||||
options:
|
options:
|
||||||
free_form:
|
free_form:
|
||||||
|
|
Loading…
Reference in a new issue