ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

docker_swarm inventory: add aliases (#54355)

Browse source 
* Implement option type checking. Add support for aliases..

Add same aliases as for docker_* modules.

* Linting.
This commit is contained in:
Felix Fontein 2019-03-25 22:58:23 +01:00 committed by ansibot
parent 0c0f448a24
commit 8106502424
1 changed files with 18 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
lib/ansible/plugins/inventory/docker_swarm.py
View file

@ -38,6 +38,7 @@ DOCUMENTATION = '''
- "Use C(unix://var/run/docker.sock) to connect via local socket." - "Use C(unix://var/run/docker.sock) to connect via local socket."
type: str type: str
required: true required: true
aliases: [ docker_url ]
verbose_output: verbose_output:
description: Toggle to (not) include all available nodes metadata (e.g. Platform, Architecture,OS, description: Toggle to (not) include all available nodes metadata (e.g. Platform, Architecture,OS,
EngineVersion) EngineVersion)
@ -55,13 +56,16 @@ DOCUMENTATION = '''
key_path: key_path:
description: Path to the client's TLS key file. description: Path to the client's TLS key file.
type: path type: path
aliases: [ tls_client_key ]
cacert_path: cacert_path:
description: Use a CA certificate when performing server verification by providing the path to a CA description: Use a CA certificate when performing server verification by providing the path to a CA
certificate file. certificate file.
type: path type: path
aliases: [ tls_ca_cert ]
cert_path: cert_path:
description: Path to the client's TLS certificate file. description: Path to the client's TLS certificate file.
type: path type: path
aliases: [ tls_client_cert ]
tls_hostname: tls_hostname:
description: When verifying the authenticity of the Docker host server, provide the expected name of description: When verifying the authenticity of the Docker host server, provide the expected name of
the server. the server.
@ -74,6 +78,7 @@ DOCUMENTATION = '''
- The version of the Docker API running on the Docker Host. - The version of the Docker API running on the Docker Host.
- Defaults to the latest version of the API supported by docker-py. - Defaults to the latest version of the API supported by docker-py.
type: str type: str
aliases: [ docker_api_version ]
timeout: timeout:
description: description:
- The maximum amount of time in seconds to wait on a response from the API. - The maximum amount of time in seconds to wait on a response from the API.
@ -81,6 +86,7 @@ DOCUMENTATION = '''
will be used instead. If the environment variable is not set, the default value will be used. will be used instead. If the environment variable is not set, the default value will be used.
type: int type: int
default: 60 default: 60
aliases: [ time_out ]
include_host_uri: include_host_uri:
description: Toggle to return the additional attribute I(ansible_host_uri) which contains the URI of the description: Toggle to return the additional attribute I(ansible_host_uri) which contains the URI of the
swarm leader in format of M(tcp://172.16.0.1:2376). This value may be used without additional swarm leader in format of M(tcp://172.16.0.1:2376). This value may be used without additional
@ -164,15 +170,10 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
cert_path=self.get_option('cert_path'), cert_path=self.get_option('cert_path'),
tls_hostname=self.get_option('tls_hostname'), tls_hostname=self.get_option('tls_hostname'),
api_version=self.get_option('api_version'), api_version=self.get_option('api_version'),
timeout=self.get_option('timeout') or 60, timeout=self.get_option('timeout'),
ssl_version=self.get_option('ssl_version'), ssl_version=self.get_option('ssl_version'),
debug=None, debug=None,
) )
if raw_params['timeout'] is not None:
try:
raw_params['timeout'] = int(raw_params['timeout'])
except Exception as dummy:
raise AnsibleError('Argument to timeout function must be an integer')
update_tls_hostname(raw_params) update_tls_hostname(raw_params)
connect_params = get_connect_params(raw_params, fail_function=self._fail) connect_params = get_connect_params(raw_params, fail_function=self._fail)
self.client = docker.DockerClient(**connect_params) self.client = docker.DockerClient(**connect_params)
@ -182,13 +183,13 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
self.inventory.add_group('leader') self.inventory.add_group('leader')
self.inventory.add_group('nonleaders') self.inventory.add_group('nonleaders')
if self.get_option('include_host_uri', True): if self.get_option('include_host_uri'):
if self.get_option('include_host_uri_port'): if self.get_option('include_host_uri_port'):
host_uri_port = self.get_option('include_host_uri_port') host_uri_port = str(self.get_option('include_host_uri_port'))
elif self.get_option('tls') or self.get_option('tls_verify'): elif self.get_option('tls') or self.get_option('tls_verify'):
host_uri_port = "2376" host_uri_port = '2376'
else: else:
host_uri_port = "2375" host_uri_port = '2375'
try: try:
self.nodes = self.client.nodes.list() self.nodes = self.client.nodes.list()
@ -198,10 +199,10 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
self.inventory.add_host(self.node_attrs['ID'], group=self.node_attrs['Spec']['Role']) self.inventory.add_host(self.node_attrs['ID'], group=self.node_attrs['Spec']['Role'])
self.inventory.set_variable(self.node_attrs['ID'], 'ansible_host', self.inventory.set_variable(self.node_attrs['ID'], 'ansible_host',
self.node_attrs['Status']['Addr']) self.node_attrs['Status']['Addr'])
if self.get_option('include_host_uri', True): if self.get_option('include_host_uri'):
self.inventory.set_variable(self.node_attrs['ID'], 'ansible_host_uri', self.inventory.set_variable(self.node_attrs['ID'], 'ansible_host_uri',
"tcp://" + self.node_attrs['Status']['Addr'] + ":" + host_uri_port) 'tcp://' + self.node_attrs['Status']['Addr'] + ':' + host_uri_port)
if self.get_option('verbose_output', True): if self.get_option('verbose_output'):
self.inventory.set_variable(self.node_attrs['ID'], 'docker_swarm_node_attributes', self.node_attrs) self.inventory.set_variable(self.node_attrs['ID'], 'docker_swarm_node_attributes', self.node_attrs)
if 'ManagerStatus' in self.node_attrs: if 'ManagerStatus' in self.node_attrs:
if self.node_attrs['ManagerStatus'].get('Leader'): if self.node_attrs['ManagerStatus'].get('Leader'):
@ -209,9 +210,9 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
# Check moby/moby#35437 for details # Check moby/moby#35437 for details
swarm_leader_ip = parse_address(self.node_attrs['ManagerStatus']['Addr'])[0] or \ swarm_leader_ip = parse_address(self.node_attrs['ManagerStatus']['Addr'])[0] or \
self.node_attrs['Status']['Addr'] self.node_attrs['Status']['Addr']
if self.get_option('include_host_uri', True): if self.get_option('include_host_uri'):
self.inventory.set_variable(self.node_attrs['ID'], 'ansible_host_uri', "tcp://" + self.inventory.set_variable(self.node_attrs['ID'], 'ansible_host_uri',
swarm_leader_ip + ":" + host_uri_port) 'tcp://' + swarm_leader_ip + ':' + host_uri_port)
self.inventory.set_variable(self.node_attrs['ID'], 'ansible_host', swarm_leader_ip) self.inventory.set_variable(self.node_attrs['ID'], 'ansible_host', swarm_leader_ip)
self.inventory.add_host(self.node_attrs['ID'], group='leader') self.inventory.add_host(self.node_attrs['ID'], group='leader')
else: else:
@ -243,7 +244,7 @@ class InventoryModule(BaseInventoryPlugin, Constructable):
"""Return the possibly of a file being consumable by this plugin.""" """Return the possibly of a file being consumable by this plugin."""
return ( return (
super(InventoryModule, self).verify_file(path) and super(InventoryModule, self).verify_file(path) and
path.endswith((self.NAME + ".yaml", self.NAME + ".yml"))) path.endswith((self.NAME + '.yaml', self.NAME + '.yml')))
def parse(self, inventory, loader, path, cache=True): def parse(self, inventory, loader, path, cache=True):
if not HAS_DOCKER: if not HAS_DOCKER: