LXD inventory: Support virtual machines #3519

ElieDeloumeau · 2021-10-06T15:51:59Z

SUMMARY

Adds full compatibility for LXD 4.x. It allows to list containers and VMs

The plugin is already only compatible with LXD 4 (due to a call to /1.0/networks/{interface}/state), this PR adds requirement and VM support

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

lxd inventory plugin

ADDITIONAL INFORMATION

I renamed "container" to "instance" (sed) and fixed some specific needs: L611, L632, L636, L649

My LXD instances:

$ lxc list -c nt volatile.last_state.power="RUNNING"
+----------------+-----------------+
|      NAME      |      TYPE       |
+----------------+-----------------+
| gitlab-runner  | VIRTUAL-MACHINE |
+----------------+-----------------+
| grafana        | CONTAINER       |
+----------------+-----------------+
| home-assistant | VIRTUAL-MACHINE |
+----------------+-----------------+
| influxdb       | CONTAINER       |
+----------------+-----------------+
| mqtt           | CONTAINER       |
+----------------+-----------------+
| mysql          | CONTAINER       |
+----------------+-----------------+
| pi-hole        | CONTAINER       |
+----------------+-----------------+
| sozu           | CONTAINER       |
+----------------+-----------------+
| test           | CONTAINER       |
+----------------+-----------------+
| test-centos8   | CONTAINER       |
+----------------+-----------------+
| test-debian11  | CONTAINER       |
+----------------+-----------------+

Before (containers only):

$ ansible-inventory -i inventory/lxd.yml --playbook-dir ./ --graph
@all:
  |--@ungrouped:
  |  |--grafana
  |  |--influxdb
  |  |--mqtt
  |  |--mysql
  |  |--pi-hole
  |  |--sozu
  |  |--test
  |  |--test-centos8
  |  |--test-debian11

After (containers and VM):

$ ansible-inventory -i inventory/lxd.yml --playbook-dir ./ --graph
@all:
  |--@ungrouped:
  |  |--gitlab-runner
  |  |--grafana
  |  |--home-assistant
  |  |--influxdb
  |  |--mqtt
  |  |--mysql
  |  |--pi-hole
  |  |--sozu
  |  |--test
  |  |--test-centos8
  |  |--test-debian11

ansibullbot · 2021-10-06T15:55:35Z

cc @conloos
click here for bot help

ElieDeloumeau · 2021-10-06T16:32:30Z

I will fix the tests

conloos · 2021-10-06T19:10:30Z

Hi @ElieDeloumeau,

this looks very good. I am currently working on caching and will put it on hold until it has been taken over.

Thanks Frank

felixfontein

Thanks for your contribution! Please add a changelog fragment.

Please note that all your changes must be backwards compatible, i.e. they must not break existing setups.

plugins/inventory/lxd.py

Co-authored-by: Felix Fontein <[email protected]>

changelogs/fragments/3519-inventory-support-lxd-4.yml

Co-authored-by: Felix Fontein <[email protected]>

plugins/inventory/lxd.py

felixfontein · 2021-11-22T18:20:12Z

@conloos how do you want to proceed? Is this PR ready for merging from your point of view? If you give your OK before tomorrow very early morning, I can merge it. I'll work on the 4.1.0 release very early tomorrow morning, if the PR doesn't make it in until then it has to wait for 4.2.0 in ~four weeks (of course it can get merged earlier, it just won't show up in a release before then).

conloos · 2021-11-23T06:29:18Z

Hi Felix,

I can't check everything today morning, including my tests.
I'll do the review by the weekend and suggest that I work on the caching then.
So we can ship both features in 4 weeks.

Greetings Frank

felixfontein · 2021-12-09T20:14:15Z

@conloos it has been a couple of weeks, any progress so far? :)

conloos · 2021-12-09T21:39:53Z

Hi @felixfontein,

in the last weeks I develop the next Inventory AixBOMS.
I hope to create the pull request in the next week.

At the weekend i check the changes at the lxd plungin to be prepared for the next release.

Thanks Frank

conloos · 2021-12-13T20:24:51Z

Hi @felixfontein,

everything is ok.
I checked the plugin on two servers.

But at the moment I am not able to get a working Unittest.
Its not a problem by the inventory its at ansible_collections.community.internal_test_tools.

But here all checks passed.

So please ship it.

Thanks Frank

felixfontein · 2021-12-13T20:42:13Z

@conloos the problems you are experiencing with the unit tests are probably because you do not have https://galaxy.ansible.com/community/internal_test_tools installed where ansible-test will find it (I think it only looks for other collections in the same directory structure where the current collection is in).

plugins/inventory/lxd.py

conloos · 2021-12-13T20:56:42Z

@conloos the problems you are experiencing with the unit tests are probably because you do not have https://galaxy.ansible.com/community/internal_test_tools installed where ansible-test will find it (I think it only looks for other collections in the same directory structure where the current collection is in).

I use the Docker version: ansible-test units --docker -v

felixfontein · 2021-12-13T21:01:45Z

If you run git clone https://github.com/ansible-collections/community.internal_test_tools.git ../internal_test_tools before running that, the collection should be available.

patchback · 2021-12-13T21:01:55Z

Backport to stable-4: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-4/8825ef4711ab44598f9e480b3d5ea75c608701c8/pr-3519

Backported as #3900

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

* LXD 4.x compatibility (Containers and VMs) * add changelog fragment * update fixture * update plugin options * backwards compatible alias Co-authored-by: Felix Fontein <[email protected]> * Update changelogs/fragments/3519-inventory-support-lxd-4.yml Co-authored-by: Felix Fontein <[email protected]> * add lxd 4.0 requirement * filter for type of virtualization added. due to duplication in the namespace, "type" is not used as the keyword but "nature". * add type filter Since the first version of this inventory plugin only supports containers, a filter function was added to filter between containers and virtual machines or both. By default only containers are displayed, as in the first version of the plugin. This behavior will change in the future. * rename C(nature) to C(type) The term "nature" does not fit into the lxd namespace. Therefore i renamed nature to type. * update changelog fragment * Update plugins/inventory/lxd.py Co-authored-by: Felix Fontein <[email protected]> * Apply suggestions from code review Co-authored-by: Felix Fontein <[email protected]> * rename typefilter to type_filter * fix tests with type_filter * Update plugins/inventory/lxd.py * Update plugins/inventory/lxd.py Co-authored-by: Felix Fontein <[email protected]> Co-authored-by: Frank Dornheim <“[email protected]@users.noreply.github.com”> (cherry picked from commit 8825ef4)

felixfontein · 2021-12-13T21:02:15Z

@ElieDeloumeau thanks for your contribution!
@conloos thanks for reviewing!

ElieDeloumeau · 2021-12-14T00:41:38Z

@felixfontein @conloos Thanks for helping me 😃

* LXD 4.x compatibility (Containers and VMs) * add changelog fragment * update fixture * update plugin options * backwards compatible alias Co-authored-by: Felix Fontein <[email protected]> * Update changelogs/fragments/3519-inventory-support-lxd-4.yml Co-authored-by: Felix Fontein <[email protected]> * add lxd 4.0 requirement * filter for type of virtualization added. due to duplication in the namespace, "type" is not used as the keyword but "nature". * add type filter Since the first version of this inventory plugin only supports containers, a filter function was added to filter between containers and virtual machines or both. By default only containers are displayed, as in the first version of the plugin. This behavior will change in the future. * rename C(nature) to C(type) The term "nature" does not fit into the lxd namespace. Therefore i renamed nature to type. * update changelog fragment * Update plugins/inventory/lxd.py Co-authored-by: Felix Fontein <[email protected]> * Apply suggestions from code review Co-authored-by: Felix Fontein <[email protected]> * rename typefilter to type_filter * fix tests with type_filter * Update plugins/inventory/lxd.py * Update plugins/inventory/lxd.py Co-authored-by: Felix Fontein <[email protected]> Co-authored-by: Frank Dornheim <“[email protected]@users.noreply.github.com”> (cherry picked from commit 8825ef4) Co-authored-by: Élie <[email protected]>

LXD 4.x compatibility (Containers and VMs)

d85b59c

ansibullbot added feature This issue/PR relates to a feature request inventory inventory plugin new_contributor Help guide this first time contributor plugins plugin (any type) needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Oct 6, 2021

ElieDeloumeau changed the title ~~LXD 4.x compatibility (Containers and VMs)~~ Draft: LXD 4.x compatibility (Containers and VMs) Oct 6, 2021

felixfontein reviewed Oct 6, 2021

View reviewed changes

plugins/inventory/lxd.py Show resolved Hide resolved

plugins/inventory/lxd.py Show resolved Hide resolved

felixfontein added backport-3 check-before-release PR will be looked at again shortly before release and merged if possible. labels Oct 6, 2021

ElieDeloumeau added 3 commits October 7, 2021 10:49

add changelog fragment

ef67609

update fixture

8ae3dd1

update plugin options

71e65e2

This comment has been minimized.

Sign in to view

ansibullbot added merge_commit This PR contains at least one merge commit. Please resolve! needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html labels Oct 7, 2021

backwards compatible alias

3fac89e

Co-authored-by: Felix Fontein <[email protected]>

felixfontein reviewed Oct 7, 2021

View reviewed changes

changelogs/fragments/3519-inventory-support-lxd-4.yml Outdated Show resolved Hide resolved

Update changelogs/fragments/3519-inventory-support-lxd-4.yml

7984add

Co-authored-by: Felix Fontein <[email protected]>

felixfontein reviewed Oct 9, 2021

View reviewed changes

plugins/inventory/lxd.py Show resolved Hide resolved

ElieDeloumeau added 2 commits November 22, 2021 17:29

rename typefilter to type_filter

5b5a166

fix tests with type_filter

c369303

felixfontein reviewed Nov 22, 2021

View reviewed changes

plugins/inventory/lxd.py Outdated Show resolved Hide resolved

Update plugins/inventory/lxd.py

3d5514c

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Dec 1, 2021

felixfontein reviewed Dec 13, 2021

View reviewed changes

plugins/inventory/lxd.py Outdated Show resolved Hide resolved

Update plugins/inventory/lxd.py

9fe7baf

ansibullbot removed the stale_ci CI is older than 7 days, rerun before merging label Dec 13, 2021

felixfontein merged commit 8825ef4 into ansible-collections:main Dec 13, 2021

felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Dec 13, 2021

patchback bot mentioned this pull request Dec 13, 2021

[PR #3519/8825ef47 backport][stable-4] LXD inventory: Support virtual machines #3900

Merged

ElieDeloumeau deleted the lxd_4 branch December 14, 2021 00:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LXD inventory: Support virtual machines #3519

LXD inventory: Support virtual machines #3519

ElieDeloumeau commented Oct 6, 2021 •

edited

Loading

ansibullbot commented Oct 6, 2021

ElieDeloumeau commented Oct 6, 2021

conloos commented Oct 6, 2021

felixfontein left a comment

This comment has been minimized.

felixfontein commented Nov 22, 2021

conloos commented Nov 23, 2021

felixfontein commented Dec 9, 2021

conloos commented Dec 9, 2021

conloos commented Dec 13, 2021

felixfontein commented Dec 13, 2021

conloos commented Dec 13, 2021

felixfontein commented Dec 13, 2021

patchback bot commented Dec 13, 2021 •

edited

Loading

felixfontein commented Dec 13, 2021

ElieDeloumeau commented Dec 14, 2021

LXD inventory: Support virtual machines #3519

LXD inventory: Support virtual machines #3519

Conversation

ElieDeloumeau commented Oct 6, 2021 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibullbot commented Oct 6, 2021

ElieDeloumeau commented Oct 6, 2021

conloos commented Oct 6, 2021

felixfontein left a comment

Choose a reason for hiding this comment

This comment has been minimized.

felixfontein commented Nov 22, 2021

conloos commented Nov 23, 2021

felixfontein commented Dec 9, 2021

conloos commented Dec 9, 2021

conloos commented Dec 13, 2021

felixfontein commented Dec 13, 2021

conloos commented Dec 13, 2021

felixfontein commented Dec 13, 2021

patchback bot commented Dec 13, 2021 • edited Loading

Backport to stable-4: 💚 backport PR created

felixfontein commented Dec 13, 2021

ElieDeloumeau commented Dec 14, 2021

ElieDeloumeau commented Oct 6, 2021 •

edited

Loading

patchback bot commented Dec 13, 2021 •

edited

Loading