canonical/open-documentation-academy

LXD: configure `cloud-init` from a file

Open

#63 opened on Apr 26, 2024

View on GitHub
 (6 comments) (0 reactions) (1 assignee)Python (99 forks)auto 404
good first issuehow-tosize 3

Repository metrics

Stars
 (119 stars)
PR merge metrics
 (PR metrics pending)

Description

Documentation: https://documentation.ubuntu.com/lxd/en/latest/ GitHub repo: https://github.com/canonical/lxd Contribution guide: https://documentation.ubuntu.com/lxd/en/latest/contributing/

To run some actions on an instance when it is started for the first time, you can use cloud-init. See How to use cloud-init in the LXD documentation.

The How to configure cloud-init section describes the format needed for the cloud-init configuration options, and how to configure it if you're using the API, but it's missing instructions for how to configure the options through the CLI.

You would usually do this by writing the configuration to a file (for example, cloud-init.yml) and then passing it in:

lxc config set <instance_name> cloud-init.user-data - < ~cloud-init.yml

This information should be added to the page.

Contributor guide

Research direction
Read the LXD documentation page on cloud init, locate the 'How to configure cloud init' section, and add CLI instructions for setting cloud init options from a file using `lxc config set <instance name> cloud init.user data < cloud init.yml`. Ensure the example matches the existing format.
Tech stack
None
Domain
documentationcli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90