Skip to content

Relocate LXD to virtualisation section and modernize documentation#594

Open
Copilot wants to merge 7 commits intomainfrom
copilot/improve-lxd-documentation
Open

Relocate LXD to virtualisation section and modernize documentation#594
Copilot wants to merge 7 commits intomainfrom
copilot/improve-lxd-documentation

Conversation

Copy link

Copilot AI commented Jan 23, 2026

LXD Documentation Improvements - Complete ✅

All improvements from the issue have been successfully implemented and PR feedback addressed.

1. Relocated LXD Documentation ✅

  • Move docs/how-to/containers/lxd-containers.md to docs/how-to/virtualisation/lxd.md
  • Rename file from lxd-containers.md to lxd.md
  • Update title to "LXD containers and virtual machines" to reflect dual capabilities
  • Update docs/how-to/virtualisation.md to include LXD
  • Update docs/how-to/containers.md to reference LXD as a bullet point with toctree entry
  • Add redirect from old paths to new path in redirects.txt
  • Update all references throughout documentation from lxd-containers to lxd

2. Content Improvements ✅

  • Remove "swapaccount=1" kernel preparation section
  • Make lxd init command prominent in its own code block
  • Add Btrfs as a storage backend option (Directory, Btrfs, and ZFS)
  • Change adduser joe lxd to gpasswd -a joe lxd
  • Fix remote image aliases description positioning
  • Mention lxc init alongside lxc launch for creating containers
  • Add lxc launch --vm for creating virtual machines
  • Update all examples from bionic/18.04 to noble/24.04 (latest LTS)
  • Improve login command: use lxc exec n1 -- sudo -i -u ubuntu for proper login shell
  • Clarify difference between sudo -i and lxc shell commands
  • Remove problematic trust password paragraph with lxc config set core.trust_password PASSWORD command
  • Keep "Backing store" section (clarified per reviewer feedback)
  • Fix device add command: use opt-mount device name and /opt absolute path
  • Change snapshot examples from YYYY-MM-DD to snapshot-name
  • Rename example container from testcontainer to new-container
  • Fix grammar: 'Image' to 'Images' for consistency

3. Maintenance Updates ✅

  • Add "Noble" and "gpasswd" to custom wordlist
  • All spelling checks pass
  • Code review completed and all issues addressed
  • Documentation builds successfully
  • Security check completed (no vulnerabilities)
Original prompt

This section details on the original issue you should resolve

<issue_title>lxd improvements</issue_title>
<issue_description>- since it can also do virtualization, should not be in containers section only, rather move to virt - maybe unify both sections and include the remaining container articles incl docker.

  • generally, this article could be shorter and mainly refer to the lxd upstream documentation. it should contain a start guide and some practical examples, but refer to other docs otherwise.
  • "swapaccount=1 must be set." -> why? probably can just be left out.
  • lxd init:
    • this important command should be listed as a big command box, currently it's hidden in-line (and even wraps).
    • btrfs should be listed as an option (instead of just "Directory or ZFS container backend.")
  • adduser joe lxd rather use gpasswd -a joe lxd since adduser's usage is often being confused
  • the description about listing remote images mentions aliases like 18.04, but the code example below doesn't use it. the next command does so, so the bionic alias description should also be moved down to that command.
  • containers can also be created without starting them, so we should also mention lxc init ... (next to lxc start ...)
  • examples mentioning bionic should be updated to use resolute and 26.04
  • logging in: add a "true login shell" (which correctly initializes the environment, session, user session manager, pty ownership for gpg key entry, ...) instead of a plain bash invocation
    • lxc exec canonical -- sudo -i -u ubuntu
  • lxc config set core.trust_password PASSWORD returns Error: Cannot set "core.trust_password" to "PASSWORD": Unknown key (also for other passwords)
  • lxc config device add c1 opt disk source=/opt path=opt should say lxc config device add c1 opt-mount disk source=/opt path=/opt
  • lxc snapshot c1 YYYY-MM-DD should rather say snapshot-name instead of the date pattern.</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 3 commits January 23, 2026 11:19
Co-authored-by: TheJJ <673543+TheJJ@users.noreply.github.com>
…26.04

Co-authored-by: TheJJ <673543+TheJJ@users.noreply.github.com>
Co-authored-by: TheJJ <673543+TheJJ@users.noreply.github.com>
Copilot AI changed the title [WIP] Update LXD documentation for clarity and organization Relocate LXD to virtualisation section and modernize documentation Jan 23, 2026
Copilot AI requested a review from TheJJ January 23, 2026 11:28
…fferences, simplify structure

Co-authored-by: TheJJ <673543+TheJJ@users.noreply.github.com>
Copilot AI requested a review from TheJJ January 23, 2026 11:41
Copy link
Member

@TheJJ TheJJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please don't remove the backing store section. we just wanted to get rid of 'trust password'.

Co-authored-by: TheJJ <673543+TheJJ@users.noreply.github.com>
Copy link
Author

Copilot AI commented Jan 23, 2026

please don't remove the backing store section. we just wanted to get rid of 'trust password'.

Fixed - the backing store section has been restored. Only the trust password paragraph was removed. (88e68df)

Copilot AI requested a review from TheJJ January 23, 2026 11:58
Copy link
Member

@TheJJ TheJJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the filename should no longer be lxd-containers.md, but rather just lxd.md

Co-authored-by: TheJJ <673543+TheJJ@users.noreply.github.com>
Copy link
Author

Copilot AI commented Jan 23, 2026

the filename should no longer be lxd-containers.md, but rather just lxd.md

Renamed from lxd-containers.md to lxd.md and updated all references throughout the documentation. (4f1986d)

Copilot AI requested a review from TheJJ January 23, 2026 12:41
@TheJJ TheJJ requested a review from s-makin January 23, 2026 12:45
Copy link
Member

@TheJJ TheJJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

content-wise this looks good now i think.

@TheJJ TheJJ marked this pull request as ready for review January 23, 2026 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

lxd improvements

2 participants