Updates `lxd_container` to support new LXD API #7980

anthonyra · 2024-02-17T14:12:39Z

SUMMARY

Updates the lxd_container module to work with the new LXD API which deprecates /1.0/containers and /1.0/virtual-machines and adds /1.0/instances. It tries to keep backwards compatibility with a try and catch compared to detecting the API version then determining which API endpoint to use.

It also adds support for Incus

Fixes #7853

ISSUE TYPE

COMPONENT NAME

lxd_container

ADDITIONAL INFORMATION

felixfontein

Thanks for your contribution!

plugins/modules/lxd_container.py

felixfontein · 2024-02-20T19:57:04Z

plugins/modules/lxd_container.py

+        # LXD (3.19) Rest API provides instance endpoint, failback to containers and virtual-machines
+        self.api_endpoint = '/1.0/instances'
+        try:
+            self.client.do('GET', '{0}/{1}'.format(self.api_endpoint, ''), ok_error_codes=[404])


You need to check the return value whether it's a 404 error, instead of trying to catch an exception.

When working out the best approach to do this, I found/figured out that this approach would return 404 for endpoints that didn't exist even. For example, /1.0/test would result in 404 like /1.0/instances. However, adding the ?project filter with a blank project would result in the API response I was looking for.

felixfontein · 2024-02-22T20:23:36Z

The code change looks good to me (as far as I can judge). Can you please add a changelog fragment? Thanks.

sleepy-nols · 2024-02-22T20:34:07Z

can confirm, runs for me without problems

felixfontein · 2024-02-22T20:35:57Z

(And mark the PR as ready when you think you're done :) )

changelogs/fragments/lxd-instances-api-endpoint-added.yml

Co-authored-by: Felix Fontein <felix@fontein.de>

patchback · 2024-02-28T20:45:50Z

Backport to stable-7: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-7/74c15c12418bf2f7e1dcac1a88657c8aefaeeb6d/pr-7980

Backported as #8045

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

* feat: ✨ adds support for /1.0/instances endpoint * Update changelogs/fragments/lxd-instances-api-endpoint-added.yml Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 74c15c1)

patchback · 2024-02-28T20:45:58Z

Backport to stable-8: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-8/74c15c12418bf2f7e1dcac1a88657c8aefaeeb6d/pr-7980

Backported as #8046

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

* feat: ✨ adds support for /1.0/instances endpoint * Update changelogs/fragments/lxd-instances-api-endpoint-added.yml Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 74c15c1)

felixfontein · 2024-02-28T20:46:19Z

@anthonyra thanks a lot for your contribution!
@sleepy-nols thanks for testing this!

…port new LXD API (#8045) Updates `lxd_container` to support new LXD API (#7980) * feat: ✨ adds support for /1.0/instances endpoint * Update changelogs/fragments/lxd-instances-api-endpoint-added.yml Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 74c15c1) Co-authored-by: Anthony Anderson <fnanderson93@gmail.com>

…port new LXD API (#8046) Updates `lxd_container` to support new LXD API (#7980) * feat: ✨ adds support for /1.0/instances endpoint * Update changelogs/fragments/lxd-instances-api-endpoint-added.yml Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 74c15c1) Co-authored-by: Anthony Anderson <fnanderson93@gmail.com>

…` to support new LXD API (#8045)" This reverts commit 8b2e658. (Considering this again, this looks a lot more like a feature than a bugfix. I shouldn't have backported it.)

This comment was marked as outdated.

Sign in to view

anthonyra mentioned this pull request Feb 17, 2024

Update lxd_container with new API endpoint #7854

Closed

This comment was marked as outdated.

Sign in to view

ansibullbot added the ci_verified Push fixes to PR branch to re-run CI label Feb 17, 2024

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-7 Automatically create a backport for the stable-7 branch backport-8 Automatically create a backport for the stable-8 branch labels Feb 17, 2024

felixfontein reviewed Feb 17, 2024

View reviewed changes

plugins/modules/lxd_container.py Outdated Show resolved Hide resolved

plugins/modules/lxd_container.py Outdated Show resolved Hide resolved

felixfontein reviewed Feb 18, 2024

View reviewed changes

plugins/modules/lxd_container.py Outdated Show resolved Hide resolved

plugins/modules/lxd_container.py Outdated Show resolved Hide resolved

plugins/modules/lxd_container.py Outdated Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

ansibullbot removed the ci_verified Push fixes to PR branch to re-run CI label Feb 20, 2024

This comment was marked as outdated.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI and removed ci_verified Push fixes to PR branch to re-run CI labels Feb 20, 2024

This comment was marked as outdated.

Sign in to view

ansibullbot added the ci_verified Push fixes to PR branch to re-run CI label Feb 20, 2024

anthonyra force-pushed the main branch from 1b1c8d4 to 94db8bd Compare February 20, 2024 16:47

ansibullbot added plugins plugin (any type) and removed merge_commit This PR contains at least one merge commit. Please resolve! needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html labels Feb 20, 2024

felixfontein reviewed Feb 20, 2024

View reviewed changes

ansibullbot added ci_verified Push fixes to PR branch to re-run CI and removed ci_verified Push fixes to PR branch to re-run CI labels Feb 21, 2024

anthonyra force-pushed the main branch 2 times, most recently from 015fecb to 6e20d71 Compare February 21, 2024 18:00

This comment was marked as outdated.

Sign in to view

ansibullbot added the ci_verified Push fixes to PR branch to re-run CI label Feb 21, 2024

anthonyra force-pushed the main branch from 20e00e5 to 61e60ae Compare February 21, 2024 18:41

ansibullbot removed the ci_verified Push fixes to PR branch to re-run CI label Feb 21, 2024

feat: ✨ adds support for /1.0/instances endpoint

85418a5

anthonyra force-pushed the main branch from ef9ac67 to 85418a5 Compare February 27, 2024 20:21

anthonyra marked this pull request as ready for review February 27, 2024 20:21

ansibullbot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR and removed WIP Work in progress labels Feb 27, 2024

felixfontein reviewed Feb 28, 2024

View reviewed changes

changelogs/fragments/lxd-instances-api-endpoint-added.yml Outdated Show resolved Hide resolved

Update changelogs/fragments/lxd-instances-api-endpoint-added.yml

92c8478

Co-authored-by: Felix Fontein <felix@fontein.de>

ansibullbot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Feb 28, 2024

felixfontein merged commit 74c15c1 into ansible-collections:main Feb 28, 2024
121 checks passed

felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Feb 28, 2024

patchback bot mentioned this pull request Feb 28, 2024

[PR #7980/74c15c12 backport][stable-7] Updates lxd_container to support new LXD API #8045

Merged

6 tasks

patchback bot mentioned this pull request Feb 28, 2024

[PR #7980/74c15c12 backport][stable-8] Updates lxd_container to support new LXD API #8046

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates `lxd_container` to support new LXD API #7980

Updates `lxd_container` to support new LXD API #7980

anthonyra commented Feb 17, 2024 •

edited

This comment was marked as outdated.

This comment was marked as outdated.

felixfontein left a comment

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

felixfontein Feb 20, 2024

anthonyra Feb 21, 2024

This comment was marked as outdated.

felixfontein commented Feb 22, 2024

sleepy-nols commented Feb 22, 2024

felixfontein commented Feb 22, 2024

patchback bot commented Feb 28, 2024 •

edited

patchback bot commented Feb 28, 2024 •

edited

felixfontein commented Feb 28, 2024

Updates lxd_container to support new LXD API #7980

Updates lxd_container to support new LXD API #7980

Conversation

anthonyra commented Feb 17, 2024 • edited

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

This comment was marked as outdated.

This comment was marked as outdated.

felixfontein left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

felixfontein Feb 20, 2024

Choose a reason for hiding this comment

anthonyra Feb 21, 2024

Choose a reason for hiding this comment

This comment was marked as outdated.

felixfontein commented Feb 22, 2024

sleepy-nols commented Feb 22, 2024

felixfontein commented Feb 22, 2024

patchback bot commented Feb 28, 2024 • edited

Backport to stable-7: 💚 backport PR created

patchback bot commented Feb 28, 2024 • edited

Backport to stable-8: 💚 backport PR created

felixfontein commented Feb 28, 2024

Updates `lxd_container` to support new LXD API #7980

Updates `lxd_container` to support new LXD API #7980

anthonyra commented Feb 17, 2024 •

edited

patchback bot commented Feb 28, 2024 •

edited

patchback bot commented Feb 28, 2024 •

edited