Skip to content

Commit 2d2486a

Browse files
committed
doc: do not suggest tweaking datasource_list
1 parent 0f87ff3 commit 2d2486a

File tree

1 file changed

+3
-15
lines changed

1 file changed

+3
-15
lines changed

doc/rtd/reference/base_config_reference.rst

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -296,24 +296,12 @@ Automatically includes ``cloudinit.sources``.
296296
``datasource_list``
297297
^^^^^^^^^^^^^^^^^^^
298298

299-
This key contains a prioritized list of datasources that ``cloud-init``
300-
attempts to discover on boot. By default, this is defined in
301-
:file:`/etc/cloud/cloud.cfg.d`.
302-
303-
There are a few reasons to modify the ``datasource_list``:
304-
305-
1. Override default datasource discovery priority order
306-
2. Force cloud-init to use a specific datasource: A single entry in
307-
the list (or a single entry and ``None``) will override datasource
308-
discovery, which will force the specified datasource to run.
309-
3. Remove known invalid datasources: this might improve boot speed on distros
310-
that do not use ``ds-identify`` to detect and select the datasource,
299+
This key contains a list of datasources that are checked on boot.
300+
``cloud-init`` skips checks if the list contains a single datasource.
311301

312302
.. warning::
313303

314-
This key is unique in that it uses a subset of YAML syntax. It **requires**
315-
that the key and its contents, a list, must share a single line - no
316-
newlines.
304+
This key and its values **must** be on a single line - no newlines.
317305

318306
``vendor_data``/``vendor_data2``
319307
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)