Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updates lxd_container to support new LXD API #7980

Merged
merged 2 commits into from
Feb 28, 2024
Merged

Updates lxd_container to support new LXD API #7980

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85418a5
feat: :sparkles: adds support for /1.0/instances endpoint
anthonyra Feb 6, 2024
92c8478
Update changelogs/fragments/lxd-instances-api-endpoint-added.yml
anthonyra Feb 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelogs/fragments/lxd-instances-api-endpoint-added.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
minor_changes:
- "lxd_container - uses ``/1.0/instances`` API endpoint, if available. Falls back to ``/1.0/containers`` or ``/1.0/virtual-machines``. Fixes issue when using Incus or LXD 5.19 due to migrating to ``/1.0/instances`` endpoint. (https://github.com/ansible-collections/community.general/pull/7980)."
anthonyra marked this conversation as resolved.
Show resolved Hide resolved
25 changes: 16 additions & 9 deletions plugins/modules/lxd_container.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,12 +436,12 @@

# CONFIG_PARAMS is a list of config attribute names.
CONFIG_PARAMS = [
'architecture', 'config', 'devices', 'ephemeral', 'profiles', 'source'
'architecture', 'config', 'devices', 'ephemeral', 'profiles', 'source', 'type'
]

# CONFIG_CREATION_PARAMS is a list of attribute names that are only applied
# on instance creation.
CONFIG_CREATION_PARAMS = ['source']
CONFIG_CREATION_PARAMS = ['source', 'type']


class LXDContainerManagement(object):
Expand All @@ -467,13 +467,6 @@ def __init__(self, module):

self.type = self.module.params['type']

# LXD Rest API provides additional endpoints for creating containers and virtual-machines.
self.api_endpoint = None
if self.type == 'container':
self.api_endpoint = '/1.0/containers'
elif self.type == 'virtual-machine':
self.api_endpoint = '/1.0/virtual-machines'

self.key_file = self.module.params.get('client_key')
if self.key_file is None:
self.key_file = '{0}/.config/lxc/client.key'.format(os.environ['HOME'])
Expand All @@ -499,6 +492,18 @@ def __init__(self, module):
)
except LXDClientException as e:
self.module.fail_json(msg=e.msg)

# LXD (3.19) Rest API provides instances endpoint, failback to containers and virtual-machines
# https://documentation.ubuntu.com/lxd/en/latest/rest-api/#instances-containers-and-virtual-machines
self.api_endpoint = '/1.0/instances'
check_api_endpoint = self.client.do('GET', '{0}?project='.format(self.api_endpoint), ok_error_codes=[404])

if check_api_endpoint['error_code'] == 404:
if self.type == 'container':
self.api_endpoint = '/1.0/containers'
elif self.type == 'virtual-machine':
self.api_endpoint = '/1.0/virtual-machines'

self.trust_password = self.module.params.get('trust_password', None)
self.actions = []
self.diff = {'before': {}, 'after': {}}
Expand Down Expand Up @@ -551,6 +556,8 @@ def _create_instance(self):
url = '{0}?{1}'.format(url, urlencode(url_params))
config = self.config.copy()
config['name'] = self.name
if self.type not in self.api_endpoint:
config['type'] = self.type
if not self.module.check_mode:
self.client.do('POST', url, config, wait_for_container=self.wait_for_container)
self.actions.append('create')
Expand Down