mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Added ecs_taskdefinition_facts module (#30752)
* Added ecs_taskdefinition_facts module * Expanding documentation Now includes all possible return values * Fixed boto dependency * Converting results to snake case. * Remove EcsTaskManager class, move to main() Remove unnecessary `except` block * Change botocore import method Also make Profile exception message less redundant * Changing case conversion of the results Now converts only the root level keys Commented is a version that would not convert only container_definitions
This commit is contained in:
Gustavo Maia
Sloane Hertel
parent
97858d91ac
commit
4f67e855ed
1 changed files with 342 additions and 0 deletions
342
lib/ansible/modules/cloud/amazon/ecs_taskdefinition_facts.py
Normal file
342
lib/ansible/modules/cloud/amazon/ecs_taskdefinition_facts.py
Normal file
|
|
@ -0,0 +1,342 @@
|
|||
#!/usr/bin/python
|
||||
# Copyright: Ansible Project
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ecs_taskdefinition_facts
|
||||
short_description: describe a task definition in ecs
|
||||
notes:
|
||||
- for details of the parameters and returns see U(http://boto3.readthedocs.io/en/latest/reference/services/ecs.html#ECS.Client.describe_task_definition)
|
||||
description:
|
||||
- Describes a task definition in ecs.
|
||||
version_added: "2.5"
|
||||
author:
|
||||
- Gustavo Maia(@gurumaia)
|
||||
- Mark Chance(@Java1Guy)
|
||||
- Darek Kaczynski (@kaczynskid)
|
||||
requirements: [ json, botocore, boto3 ]
|
||||
options:
|
||||
task_definition:
|
||||
description:
|
||||
- The name of the task definition to get details for
|
||||
required: true
|
||||
extends_documentation_fragment:
|
||||
- aws
|
||||
- ec2
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Note: These examples do not set authentication details, see the AWS Guide for details.
|
||||
|
||||
- ecs_taskdefinition_facts:
|
||||
task_definition: test-td
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
container_definitions:
|
||||
description: Returns a list of complex objects representing the containers
|
||||
returned: success
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description: The name of a container.
|
||||
returned: always
|
||||
type: string
|
||||
image:
|
||||
description: The image used to start a container.
|
||||
returned: always
|
||||
type: string
|
||||
cpu:
|
||||
description: The number of cpu units reserved for the container.
|
||||
returned: always
|
||||
type: int
|
||||
memoryReservation:
|
||||
description: The soft limit (in MiB) of memory to reserve for the container.
|
||||
returned: when present
|
||||
type: int
|
||||
links:
|
||||
description: Links to other containers.
|
||||
returned: when present
|
||||
type: string
|
||||
portMappings:
|
||||
description: The list of port mappings for the container.
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
containerPort:
|
||||
description: The port number on the container.
|
||||
returned: when present
|
||||
type: int
|
||||
hostPort:
|
||||
description: The port number on the container instance to reserve for your container.
|
||||
returned: when present
|
||||
type: int
|
||||
protocol:
|
||||
description: The protocol used for the port mapping.
|
||||
returned: when present
|
||||
type: string
|
||||
essential:
|
||||
description: Whether this is an essential container or not.
|
||||
returned: always
|
||||
type: bool
|
||||
entryPoint:
|
||||
description: The entry point that is passed to the container.
|
||||
returned: when present
|
||||
type: string
|
||||
command:
|
||||
description: The command that is passed to the container.
|
||||
returned: when present
|
||||
type: string
|
||||
environment:
|
||||
description: The environment variables to pass to a container.
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description: The name of the environment variable.
|
||||
returned: when present
|
||||
type: string
|
||||
value:
|
||||
description: The value of the environment variable.
|
||||
returned: when present
|
||||
type: string
|
||||
mountPoints:
|
||||
description: The mount points for data volumes in your container.
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
sourceVolume:
|
||||
description: The name of the volume to mount.
|
||||
returned: when present
|
||||
type: string
|
||||
containerPath:
|
||||
description: The path on the container to mount the host volume at.
|
||||
returned: when present
|
||||
type: string
|
||||
readOnly:
|
||||
description: If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume.
|
||||
returned: when present
|
||||
type: bool
|
||||
volumesFrom:
|
||||
description: Data volumes to mount from another container.
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
sourceContainer:
|
||||
description: The name of another container within the same task definition to mount volumes from.
|
||||
returned: when present
|
||||
type: string
|
||||
readOnly:
|
||||
description: If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume.
|
||||
returned: when present
|
||||
type: bool
|
||||
hostname:
|
||||
description: The hostname to use for your container.
|
||||
returned: when present
|
||||
type: string
|
||||
user:
|
||||
description: The user name to use inside the container.
|
||||
returned: when present
|
||||
type: string
|
||||
workingDirectory:
|
||||
description: The working directory in which to run commands inside the container.
|
||||
returned: when present
|
||||
type: string
|
||||
disableNetworking:
|
||||
description: When this parameter is true, networking is disabled within the container.
|
||||
returned: when present
|
||||
type: bool
|
||||
privileged:
|
||||
description: When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).
|
||||
returned: when present
|
||||
type: bool
|
||||
readonlyRootFilesystem:
|
||||
description: When this parameter is true, the container is given read-only access to its root file system.
|
||||
returned: when present
|
||||
type: bool
|
||||
dnsServers:
|
||||
description: A list of DNS servers that are presented to the container.
|
||||
returned: when present
|
||||
type: string
|
||||
dnsSearchDomains:
|
||||
description: A list of DNS search domains that are presented to the container.
|
||||
returned: when present
|
||||
type: string
|
||||
extraHosts:
|
||||
description: A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.
|
||||
returned: when present
|
||||
type: complex
|
||||
contains:
|
||||
hostname:
|
||||
description: The hostname to use in the /etc/hosts entry.
|
||||
returned: when present
|
||||
type: string
|
||||
ipAddress:
|
||||
description: The IP address to use in the /etc/hosts entry.
|
||||
returned: when present
|
||||
type: string
|
||||
dockerSecurityOptions:
|
||||
description: A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.
|
||||
returned: when present
|
||||
type: string
|
||||
dockerLabels:
|
||||
description: A key/value map of labels to add to the container.
|
||||
returned: when present
|
||||
type: string
|
||||
ulimits:
|
||||
description: A list of ulimits to set in the container.
|
||||
returned: when present
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description: The type of the ulimit .
|
||||
returned: when present
|
||||
type: string
|
||||
softLimit:
|
||||
description: The soft limit for the ulimit type.
|
||||
returned: when present
|
||||
type: int
|
||||
hardLimit:
|
||||
description: The hard limit for the ulimit type.
|
||||
returned: when present
|
||||
type: int
|
||||
logConfiguration:
|
||||
description: The log configuration specification for the container.
|
||||
returned: when present
|
||||
type: string
|
||||
options:
|
||||
description: The configuration options to send to the log driver.
|
||||
returned: when present
|
||||
type: string
|
||||
|
||||
family:
|
||||
description: The family of your task definition, used as the definition name
|
||||
returned: always
|
||||
type: string
|
||||
task_definition_arn:
|
||||
description: ARN of the task definition
|
||||
returned: always
|
||||
type: string
|
||||
task_role_arn:
|
||||
description: The ARN of the IAM role that containers in this task can assume
|
||||
returned: when role is set
|
||||
type: string
|
||||
network_mode:
|
||||
description: Network mode for the containers
|
||||
returned: always
|
||||
type: string
|
||||
revision:
|
||||
description: Revision number that was queried
|
||||
returned: always
|
||||
type: int
|
||||
volumes:
|
||||
description: The list of volumes in a task
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description: The name of the volume.
|
||||
returned: when present
|
||||
type: string
|
||||
host:
|
||||
description: The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored.
|
||||
returned: when present
|
||||
type: bool
|
||||
source_path:
|
||||
description: The path on the host container instance that is presented to the container.
|
||||
returned: when present
|
||||
type: string
|
||||
status:
|
||||
description: The status of the task definition
|
||||
returned: always
|
||||
type: string
|
||||
requires_attributes:
|
||||
description: The container instance attributes required by your task
|
||||
returned: when present
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description: The name of the attribute.
|
||||
returned: when present
|
||||
type: string
|
||||
value:
|
||||
description: The value of the attribute.
|
||||
returned: when present
|
||||
type: string
|
||||
targetType:
|
||||
description: The type of the target with which to attach the attribute.
|
||||
returned: when present
|
||||
type: string
|
||||
targetId:
|
||||
description: The ID of the target.
|
||||
returned: when present
|
||||
type: string
|
||||
placement_constraints:
|
||||
description: A list of placement constraint objects to use for tasks
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
type:
|
||||
description: The type of constraint.
|
||||
returned: when present
|
||||
type: string
|
||||
expression:
|
||||
description: A cluster query language expression to apply to the constraint.
|
||||
returned: when present
|
||||
type: string
|
||||
''' # NOQA
|
||||
|
||||
try:
|
||||
import boto3
|
||||
HAS_BOTO3 = True
|
||||
except ImportError:
|
||||
HAS_BOTO3 = False
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.ec2 import _camel_to_snake, camel_dict_to_snake_dict, boto3_conn, ec2_argument_spec, get_aws_connection_info
|
||||
|
||||
try:
|
||||
import botocore
|
||||
except ImportError:
|
||||
pass # will be detected by imported HAS_BOTO3
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = ec2_argument_spec()
|
||||
argument_spec.update(dict(
|
||||
task_definition=dict(required=True, type='str')
|
||||
))
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
|
||||
|
||||
if not HAS_BOTO3:
|
||||
module.fail_json(msg='boto3 is required.')
|
||||
|
||||
try:
|
||||
region, ec2_url, aws_connect_kwargs = get_aws_connection_info(module, boto3=True)
|
||||
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")
|
||||
ecs = boto3_conn(module, conn_type='client', resource='ecs', region=region, endpoint=ec2_url, **aws_connect_kwargs)
|
||||
except botocore.exceptions.ProfileNotFound as e:
|
||||
module.fail_json(msg=str(e))
|
||||
|
||||
ecs_td = ecs.describe_task_definition(taskDefinition=module.params['task_definition'])['taskDefinition']
|
||||
ecs_td_snake = {}
|
||||
for k, v in ecs_td.items():
|
||||
ecs_td_snake[_camel_to_snake(k)] = v
|
||||
|
||||
ecs_td_facts_result = dict(changed=False, ansible_facts=ecs_td_snake)
|
||||
module.exit_json(**ecs_td_facts_result)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue