From e77adff0b76e13ce932dde6ab26ea320335d7476 Mon Sep 17 00:00:00 2001 From: Kellin Date: Fri, 27 Aug 2021 00:20:04 -0400 Subject: [PATCH] Linode Inventory can use full IP data from APIv4 (#3203) * Linode Inventory can use full IP data from APIv4 - The Linode dynamic inventory module does not currently distinguish between private and public IP addresses even though the Linode APIv4 contains this information. This change keeps the current behavior as the default and adds an option to set `ip_style: api`. When set, this option allows administrators to differentiate between private, public, slaac, local_link, and pool network addresses providing a more nuanced and granular view of the remote host's network information. Signed-off-by: Kellin * Review - amend changelog details - Adds a link back to this pull request - Uses markdown styles for easier to read publishing in the changelogs - Amends the wording style to match the existing changelog styles Co-authored-by: Felix Fontein * Add scope to example invocation - Adds the `community.general` scope to invocation example Co-authored-by: Felix Fontein * Convert lamda to list comprehension - Change the ip type filter from a lambda to a list comprehension Co-authored-by: Felix Fontein * Add punctuation to description sentence - Adds a period to the end of the description sentence Co-authored-by: Felix Fontein Co-authored-by: Felix Fontein --- ...node-inventory-return-full-api-ip-data.yml | 2 + plugins/inventory/linode.py | 46 +++++++++++++++++++ tests/unit/plugins/inventory/test_linode.py | 1 + 3 files changed, 49 insertions(+) create mode 100644 changelogs/fragments/3203-linode-inventory-return-full-api-ip-data.yml diff --git a/changelogs/fragments/3203-linode-inventory-return-full-api-ip-data.yml b/changelogs/fragments/3203-linode-inventory-return-full-api-ip-data.yml new file mode 100644 index 0000000000..fa7581e820 --- /dev/null +++ b/changelogs/fragments/3203-linode-inventory-return-full-api-ip-data.yml @@ -0,0 +1,2 @@ +minor_changes: + - "linode inventory plugin - adds the ``ip_style`` configuration key. Set to ``api`` to get more detailed network details back from the remote Linode host (https://github.com/ansible-collections/community.general/pull/3203)." diff --git a/plugins/inventory/linode.py b/plugins/inventory/linode.py index 5af9effd52..0ce510852a 100644 --- a/plugins/inventory/linode.py +++ b/plugins/inventory/linode.py @@ -26,6 +26,15 @@ DOCUMENTATION = r''' description: Marks this as an instance of the 'linode' plugin. required: true choices: ['linode', 'community.general.linode'] + ip_style: + description: Populate hostvars with all information available from the Linode APIv4. + type: string + default: + - plain + choices: + - plain + - api + version_added: 3.6.0 access_token: description: The Linode account personal access token. required: true @@ -83,6 +92,13 @@ compose: # replace it with the first IPv4 address of the linode as follows: ansible_ssh_host: ipv4[0] ansible_port: 2222 + +# Example where control traffic limited to internal network +plugin: community.general.linode +access_token: foobar +ip_style: api +compose: + ansible_host: "ipv4 | community.general.json_query('[?public==`false`].address') | first" ''' import os @@ -170,14 +186,44 @@ class InventoryModule(BaseInventoryPlugin, Constructable): def _add_hostvars_for_instances(self): """Add hostvars for instances in the dynamic inventory.""" + ip_style = self.get_option('ip_style') for instance in self.instances: hostvars = instance._raw_json for hostvar_key in hostvars: + if ip_style == 'api' and hostvar_key in ['ipv4', 'ipv6']: + continue self.inventory.set_variable( instance.label, hostvar_key, hostvars[hostvar_key] ) + if ip_style == 'api': + ips = instance.ips.ipv4.public + instance.ips.ipv4.private + ips += [instance.ips.ipv6.slaac, instance.ips.ipv6.link_local] + ips += instance.ips.ipv6.pools + + for ip_type in set(ip.type for ip in ips): + self.inventory.set_variable( + instance.label, + ip_type, + self._ip_data([ip for ip in ips if ip.type == ip_type]) + ) + + def _ip_data(self, ip_list): + data = [] + for ip in list(ip_list): + data.append( + { + 'address': ip.address, + 'subnet_mask': ip.subnet_mask, + 'gateway': ip.gateway, + 'public': ip.public, + 'prefix': ip.prefix, + 'rdns': ip.rdns, + 'type': ip.type + } + ) + return data def _validate_option(self, name, desired_type, option_value): """Validate user specified configuration data against types.""" diff --git a/tests/unit/plugins/inventory/test_linode.py b/tests/unit/plugins/inventory/test_linode.py index f2627d850d..501f95b1f2 100644 --- a/tests/unit/plugins/inventory/test_linode.py +++ b/tests/unit/plugins/inventory/test_linode.py @@ -49,6 +49,7 @@ def test_access_token_lookup(inventory): def test_validate_option(inventory): assert ['eu-west'] == inventory._validate_option('regions', list, 'eu-west') assert ['eu-west'] == inventory._validate_option('regions', list, ['eu-west']) + assert 'api' == inventory._validate_option('ip_style', str, 'api') def test_validation_option_bad_option(inventory):