Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc(autoinstall): Remove incorrect statements, be more direct #5545

Merged
merged 4 commits into from
Jul 25, 2024
Merged

doc(autoinstall): Remove incorrect statements, be more direct #5545

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
147d8c4
doc(autoinstall): Remove incorrect statements, be more direct
holmanb Jul 24, 2024
275688a
spelling
holmanb Jul 24, 2024
94e3260
comments
holmanb Jul 25, 2024
e148bb6
drop discourse reference
holmanb Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 9 additions & 19 deletions doc/rtd/reference/faq.rst
View file
Open in desktop
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
holmanb marked this conversation as resolved.
Show resolved Hide resolved
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
Loading