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

yeetypete · 2025-01-31T16:51:10Z

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 · 2025-01-31T16:55:33Z

cc @mattclay
click here for bot help

ansibullbot · 2025-01-31T19:09:17Z

@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.

plugins/connection/lxd.py

This reverts commit bb2ba14.

plugins/connection/lxd.py

russoz

Other than the already existing comments, LGTM

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

yeetypete · 2025-02-15T11:19:23Z

fyi I've also replicated this functionality in the incus plugin: #9743

patchback · 2025-02-15T12:00:18Z

Backport to stable-10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-10/06df717bc62fe3371acb2462b7694828b8e8196e/pr-9659

Backported as #9751

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

* fix: add support for non-root user * fix: show correct info for connection * fix: use build_exec_command to execute as nonroot * unset default user * feat: add options for setting remote user and become method * fix: add root as default remote_user * fix: remove ansible_ssh_user from remote_user vars * fix: use single quotes inside f-string * fix: ensure lxc exec comes first * fix: line length * fix: use -c flag with su * Update plugins/connection/lxd.py Co-authored-by: Felix Fontein <[email protected]> * Update plugins/connection/lxd.py Co-authored-by: Felix Fontein <[email protected]> * Update plugins/connection/lxd.py Co-authored-by: Felix Fontein <[email protected]> * doc: add changelog fragment * fix: use underscore for module name in fragment * Update 9659-lxd_connection-nonroot-user.yml Co-authored-by: Felix Fontein <[email protected]> * fix: add put command * feat: add get_remote_uid_gid placeholder function * feat: complete placeholder _get_remote_uid_gid function * fix: better logging * fix: ensure default values are of type str * fix: use ints for uid and gid * fix: print put command * fix: format * fix: display msg for PUT * fix: add comment about defaults * fix: format * fix: use os module to get uid and gid * Revert "fix: use os module to get uid and gid" This reverts commit bb2ba14. * Update plugins/connection/lxd.py Co-authored-by: Felix Fontein <[email protected]> * fix: omit uid, gid args in lxd file push if root --------- Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit 06df717)

felixfontein · 2025-02-15T12:00:26Z

@yeetypete thanks for your contribution!

felixfontein · 2025-02-15T12:00:36Z

@russoz thanks for reviewing!

…t users to connect to an instance (#9751) lxd_connection: Allow non-root users to connect to an instance (#9659) * fix: add support for non-root user * fix: show correct info for connection * fix: use build_exec_command to execute as nonroot * unset default user * feat: add options for setting remote user and become method * fix: add root as default remote_user * fix: remove ansible_ssh_user from remote_user vars * fix: use single quotes inside f-string * fix: ensure lxc exec comes first * fix: line length * fix: use -c flag with su * Update plugins/connection/lxd.py Co-authored-by: Felix Fontein <[email protected]> * Update plugins/connection/lxd.py Co-authored-by: Felix Fontein <[email protected]> * Update plugins/connection/lxd.py Co-authored-by: Felix Fontein <[email protected]> * doc: add changelog fragment * fix: use underscore for module name in fragment * Update 9659-lxd_connection-nonroot-user.yml Co-authored-by: Felix Fontein <[email protected]> * fix: add put command * feat: add get_remote_uid_gid placeholder function * feat: complete placeholder _get_remote_uid_gid function * fix: better logging * fix: ensure default values are of type str * fix: use ints for uid and gid * fix: print put command * fix: format * fix: display msg for PUT * fix: add comment about defaults * fix: format * fix: use os module to get uid and gid * Revert "fix: use os module to get uid and gid" This reverts commit bb2ba14. * Update plugins/connection/lxd.py Co-authored-by: Felix Fontein <[email protected]> * fix: omit uid, gid args in lxd file push if root --------- Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit 06df717) Co-authored-by: Peter Siegel <[email protected]>

This comment was marked as outdated.

Sign in to view

ansibullbot added 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 Jan 31, 2025

yeetypete added 10 commits January 31, 2025 20:40

fix: add support for non-root user

433ed7c

fix: show correct info for connection

bb81a7b

fix: use build_exec_command to execute as nonroot

4ebd4a6

unset default user

28fb13b

feat: add options for setting remote user and become method

4a66137

fix: add root as default remote_user

de8272c

fix: remove ansible_ssh_user from remote_user vars

daf5eaa

fix: use single quotes inside f-string

8457056

fix: ensure lxc exec comes first

30a6f46

fix: line length

297f3c0

yeetypete force-pushed the main branch from 1192403 to 297f3c0 Compare January 31, 2025 19:41

yeetypete marked this pull request as ready for review January 31, 2025 19:50

ansibullbot removed WIP Work in progress 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 Jan 31, 2025

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-10 Automatically create a backport for the stable-10 branch labels Jan 31, 2025

felixfontein reviewed Jan 31, 2025

View reviewed changes

plugins/connection/lxd.py Show resolved Hide resolved

plugins/connection/lxd.py Show resolved Hide resolved

plugins/connection/lxd.py Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Feb 2, 2025

yeetypete added 2 commits February 2, 2025 13:34

fix: format

ab11857

fix: display msg for PUT

e2d3fe7

yeetypete requested review from felixfontein and russoz February 2, 2025 12:39

yeetypete added 2 commits February 2, 2025 13:44

fix: add comment about defaults

bb32620

fix: format

06fb16c

ansibullbot removed ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Feb 2, 2025

russoz reviewed Feb 10, 2025

View reviewed changes

plugins/connection/lxd.py Show resolved Hide resolved

yeetypete added 2 commits February 10, 2025 11:13

fix: use os module to get uid and gid

bb2ba14

Revert "fix: use os module to get uid and gid"

12f770a

This reverts commit bb2ba14.

felixfontein reviewed Feb 13, 2025

View reviewed changes

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

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

russoz reviewed Feb 14, 2025

View reviewed changes

yeetypete and others added 2 commits February 14, 2025 20:55

Update plugins/connection/lxd.py

bff936a

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

fix: omit uid, gid args in lxd file push if root

fe96c1b

This was referenced Feb 14, 2025

incus_connection: Allow non-root users to connect to an instance #9742

Closed

incus_connection: Allow non-root users to connect to an instance #9743

Merged

felixfontein merged commit 06df717 into ansible-collections:main Feb 15, 2025
125 checks passed

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

patchback bot mentioned this pull request Feb 15, 2025

[PR #9659/06df717b backport][stable-10] lxd_connection: Allow non-root users to connect to an instance #9751

Merged

patchback bot mentioned this pull request Feb 17, 2025

[PR #9743/94e15110 backport][stable-10] incus_connection: Allow non-root users to connect to an instance #9765

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

yeetypete commented Jan 31, 2025 •

edited

Loading

This comment was marked as outdated.

ansibullbot commented Jan 31, 2025

ansibullbot commented Jan 31, 2025

felixfontein left a comment

This comment was marked as outdated.

russoz left a comment

yeetypete commented Feb 15, 2025

patchback bot commented Feb 15, 2025 •

edited

Loading

felixfontein commented Feb 15, 2025

felixfontein commented Feb 15, 2025

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

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

Conversation

yeetypete commented Jan 31, 2025 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

This comment was marked as outdated.

ansibullbot commented Jan 31, 2025

ansibullbot commented Jan 31, 2025

felixfontein left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

russoz left a comment

Choose a reason for hiding this comment

yeetypete commented Feb 15, 2025

patchback bot commented Feb 15, 2025 • edited Loading

Backport to stable-10: 💚 backport PR created

felixfontein commented Feb 15, 2025

felixfontein commented Feb 15, 2025

yeetypete commented Jan 31, 2025 •

edited

Loading

patchback bot commented Feb 15, 2025 •

edited

Loading