lxd_connection: Allow non-root users to connect to an instance

[yeetypete]

SUMMARY

Currently the lxd_connection only supports connecting to an instance as root. This PR extends the plugin to allow a non-root user, configurable via the ansible_user var to connect to the instance. The option lxd_become_method controls the command used to switch users, (su by default but could also be sudo -u). The defaults ensure the old behavior so this should be a non-breaking change.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

lxd_connection

ADDITIONAL INFORMATION

If it is beneficial I would also be happy to add this functionality to the incus_connection and lxc_connection plugins.

[ansibullbot]

cc @mattclay
click here for bot help

[ansibullbot]

@yeetypete this PR contains the following merge commits:

• 1192403

Please rebase your branch to remove these commits.

click here for bot help

[felixfontein]

Thanks for your contribution! Please add a changelog fragment. I've also added some first comments below.

[yeetypete]

@felixfontein will do, thanks for the comments!

[russoz]

LGTM

[yeetypete]

@felixfontein @russoz One issue came up during my testing which I have pushed a fix for:
If the lxd nonroot user and local user do not have the same uid and gid, pushing temp files to the remote causes permissions issues because they are copied with the wrong uid and gid. This came up when I was testing on a GitHub runner where the uid and gid of the local user is 1001 and the lxd nonroot user was 1000. This caused gather_facts to keep failing.

I have preserved the old behavior when root is the lxd user. I guess this issue was not noticable before when the root user was always used.

[ansibullbot]

The test ansible-test sanity --test pep8 [explain] failed with 3 errors:

plugins/connection/lxd.py:165:5: E303: too many blank lines (2)
plugins/connection/lxd.py:181:5: E303: too many blank lines (2)
plugins/connection/lxd.py:196:11: E111: indentation is not a multiple of 4

The test ansible-test sanity --test pep8 [explain] failed with 3 errors:

plugins/connection/lxd.py:165:5: E303: too many blank lines (2)
plugins/connection/lxd.py:181:5: E303: too many blank lines (2)
plugins/connection/lxd.py:196:11: E111: indentation is not a multiple of 4

The test ansible-test sanity --test pep8 [explain] failed with 3 errors:

plugins/connection/lxd.py:165:5: E303: too many blank lines (2)
plugins/connection/lxd.py:181:5: E303: too many blank lines (2)
plugins/connection/lxd.py:196:11: E111: indentation is not a multiple of 4

The test ansible-test sanity --test pep8 [explain] failed with 3 errors:

plugins/connection/lxd.py:165:5: E303: too many blank lines (2)
plugins/connection/lxd.py:181:5: E303: too many blank lines (2)
plugins/connection/lxd.py:196:11: E111: indentation is not a multiple of 4

click here for bot help