Skip to content

Commit

Permalink
Update docs (#99)
Browse files Browse the repository at this point in the history 
* Update docs

Remove .git from repo url so links in readme will generate correctly
Add required ansible version
Run latest version of add_docs.py
Add version_added string to modules

* galaxy.yml was missing authors
  • Loading branch information
@jillr
jillr committed Jun 17, 2020
1 parent 10853d9 commit 96ee268
Show file tree
Hide file tree
Showing 347 changed files with 5,394 additions and 11,895 deletions.
352 changes: 176 additions & 176 deletions README.md
View file

Large diffs are not rendered by default.

82 changes: 25 additions & 57 deletions docs/community.aws.aws_acm.rst
View file

Large diffs are not rendered by default.

70 changes: 22 additions & 48 deletions docs/community.aws.aws_acm_info.rst
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
:orphan:

.. _community.aws.aws_acm_info_:
.. _community.aws.aws_acm_info_module:


**************************
Expand All @@ -25,7 +26,7 @@ Synopsis

Requirements
------------
The below requirements are needed on the local master node that executes this .
The below requirements are needed on the host that executes this module.

- boto
- boto3
Expand All @@ -41,7 +42,6 @@ Parameters
<tr>
<th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th>Configuration</th>
<th width="100%">Comments</th>
</tr>
<tr>
Expand All @@ -55,9 +55,7 @@ Parameters
</td>
<td>
</td>
<td>
</td>
<td>
<td>
<div>AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_access_key, access_key</div>
</td>
Expand All @@ -73,9 +71,7 @@ Parameters
</td>
<td>
</td>
<td>
</td>
<td>
<td>
<div>A dictionary to modify the botocore configuration.</div>
<div>Parameters can be found at <a href='https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config'>https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config</a>.</div>
<div>Only the &#x27;user_agent&#x27; key is used for boto modules. See <a href='http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto'>http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto</a> for more boto configuration.</div>
Expand All @@ -92,9 +88,7 @@ Parameters
</td>
<td>
</td>
<td>
</td>
<td>
<td>
<div>AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
</td>
Expand All @@ -110,9 +104,7 @@ Parameters
</td>
<td>
</td>
<td>
</td>
<td>
<td>
<div>If provided, the results will be filtered to show only the certificate with this ARN.</div>
<div>If no certificate with this ARN exists, this task will fail.</div>
<div>If a certificate with this ARN exists in a different region, this task will fail</div>
Expand All @@ -134,9 +126,7 @@ Parameters
<li>yes</li>
</ul>
</td>
<td>
</td>
<td>
<td>
<div>Use a botocore.endpoint logger to parse the unique (rather than total) &quot;resource:action&quot; API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.</div>
</td>
</tr>
Expand All @@ -151,9 +141,7 @@ Parameters
</td>
<td>
</td>
<td>
</td>
<td>
<td>
<div>The domain name of an ACM certificate to limit the search to</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: name</div>
</td>
Expand All @@ -169,9 +157,7 @@ Parameters
</td>
<td>
</td>
<td>
</td>
<td>
<td>
<div>Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.</div>
</td>
</tr>
Expand All @@ -186,9 +172,7 @@ Parameters
</td>
<td>
</td>
<td>
</td>
<td>
<td>
<div>Uses a boto profile. Only works with boto &gt;= 2.24.0.</div>
</td>
</tr>
Expand All @@ -203,9 +187,7 @@ Parameters
</td>
<td>
</td>
<td>
</td>
<td>
<td>
<div>The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See <a href='http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region'>http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region</a></div>
<div style="font-size: small; color: darkgreen"><br/>aliases: aws_region, ec2_region</div>
</td>
Expand All @@ -221,9 +203,7 @@ Parameters
</td>
<td>
</td>
<td>
</td>
<td>
<td>
<div>AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: access_token</div>
</td>
Expand All @@ -248,9 +228,7 @@ Parameters
<li>FAILED</li>
</ul>
</td>
<td>
</td>
<td>
<td>
<div>Status to filter the certificate results</div>
</td>
</tr>
Expand All @@ -265,9 +243,7 @@ Parameters
</td>
<td>
</td>
<td>
</td>
<td>
<td>
<div>Filter results to show only certificates with tags that match all the tags specified here.</div>
</td>
</tr>
Expand All @@ -286,9 +262,7 @@ Parameters
<li><div style="color: blue"><b>yes</b>&nbsp;&larr;</div></li>
</ul>
</td>
<td>
</td>
<td>
<td>
<div>When set to &quot;no&quot;, SSL certificates will not be validated for boto versions &gt;= 2.6.0.</div>
</td>
</tr>
Expand All @@ -313,27 +287,27 @@ Examples


- name: obtain all ACM certificates
aws_acm_info:
community.aws.aws_acm_info:

- name: obtain all information for a single ACM certificate
aws_acm_info:
community.aws.aws_acm_info:
domain_name: "*.example_com"
- name: obtain all certificates pending validation
aws_acm_info:
community.aws.aws_acm_info:
statuses:
- PENDING_VALIDATION

- name: obtain all certificates with tag Name=foo and myTag=bar
aws_acm_info:
community.aws.aws_acm_info:
tags:
Name: foo
myTag: bar


# The output is still a list of certificates, just one item long.
- name: obtain information about a certificate with a particular ARN
aws_acm_info:
community.aws.aws_acm_info:
certificate_arn: "arn:aws:acm:ap-southeast-2:123456789876:certificate/abcdeabc-abcd-1234-4321-abcdeabcde12"


Expand All @@ -342,7 +316,7 @@ Examples

Return Values
-------------
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this :
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:

.. raw:: html

Expand Down
Loading

0 comments on commit 96ee268

Please sign in to comment.