Skip to content

Commit

Permalink
doc(autoinstall): Remove incorrect statements, be more direct (canoni…
Browse files Browse the repository at this point in the history
  • Loading branch information
holmanb committed Aug 2, 2024
1 parent f7bceff commit 6e7bb68
Showing 1 changed file with 9 additions and 19 deletions.
28 changes: 9 additions & 19 deletions doc/rtd/reference/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,15 @@ Having trouble? We would like to help!
- Find a bug? Check out the :ref:`reporting_bugs` topic to find out how to
report one

``autoinstall``, ``preruncmd``, ``postruncmd``
==============================================

Since ``cloud-init`` ignores top level user data ``cloud-config`` keys, other
projects such as `Juju`_ and `Subiquity autoinstaller`_ use a YAML-formatted
config that combines ``cloud-init``'s user data cloud-config YAML format with
their custom YAML keys. Since ``cloud-init`` ignores unused top level keys,
these combined YAML configurations may be valid ``cloud-config`` files,
however keys such as ``autoinstall``, ``preruncmd``, and ``postruncmd`` are
not used by ``cloud-init`` to configure anything.

Please direct bugs and questions about other projects that use ``cloud-init``
to their respective support channels. For Subiquity autoinstaller that is via
IRC (``#ubuntu-server`` on Libera) or Discourse. For Juju support see their
`discourse page`_.
``autoinstall``
===============

Other projects, such as `Subiquity autoinstaller`_, use cloud-init to implement
a subset of their features and have a YAML configuration format which combines
``cloud-init``'s cloud-config with additional keys.

If you are an autoinstall user, please direct questions to their IRC channel
(``#ubuntu-server`` on Libera).

Can I use cloud-init as a library?
==================================
Expand Down Expand Up @@ -83,8 +77,6 @@ Whitepapers:

.. _mailing list: https://launchpad.net/~cloud-init
.. _IRC channel on Libera: https://kiwiirc.com/nextclient/irc.libera.chat/cloud-init
.. _Juju: https://ubuntu.com/blog/topics/juju
.. _discourse page: https://discourse.charmhub.io
.. _do: https://github.com/canonical/ubuntu-pro-client/blob/9b46480b9e4b88e918bac5ced0d4b8edb3cbbeab/lib/auto_attach.py#L35

.. _cloud-init - The Good Parts: https://www.youtube.com/watch?v=2_m6EUo6VOI
Expand All @@ -106,5 +98,3 @@ Whitepapers:
.. _cloud-init Summit 2018: https://powersj.io/post/cloud-init-summit18/
.. _cloud-init Summit 2017: https://powersj.io/post/cloud-init-summit17/
.. _Subiquity autoinstaller: https://ubuntu.com/server/docs/install/autoinstall
.. _juju_project: https://discourse.charmhub.io/t/model-config-cloudinit-userdata/512
.. _discourse page: https://discourse.charmhub.io

0 comments on commit 6e7bb68

Please sign in to comment.