canonical / open-documentation-academy

Learn open-source software documentation skills with Canonical
https://canonical.com/documentation
Apache License 2.0
48 stars 30 forks source link

LXD: Document the preseed file format for `lxc init` #17

Closed ru-fu closed 2 months ago

ru-fu commented 4 months ago

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/


You can initialize LXD through a preseed file - see Non-interactive configuration. This section also contains an example for a preseed file. However, this is only an example and does not contain all available fields. For example, it is missing the fields for clusters (some of these are included in How to form a cluster).

The top-level struct is:

config: {}
    networks: []
    storage_pools: []
    profiles: []
    projects: []
    cluster:
      server_name: ""
      enabled: false
      member_config: []
      cluster_address: ""
      cluster_certificate: ""
      server_address: ""
      cluster_password: ""
      cluster_certificate_path: ""
      cluster_token: ""

We should add a reference page that contains the full file format, and link to it from the initialization and clustering how-tos. This requires some research/checking the code and testing.

activus-d commented 2 months ago

Hi @ru-fu! I would like to work on this issue.

ru-fu commented 2 months ago

Thanks @activus-d ! I've assigned the issue to you now.

Let me know if anything is unclear!

ru-fu commented 2 months ago

Thanks a lot @activus-d ! This has now been merged. :)

https://documentation.ubuntu.com/lxd/en/latest/reference/preseed_yaml_fields/