summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/examples.rst
diff options
context:
space:
mode:
authorScott Moser <smoser@brickies.net>2016-11-10 16:42:43 -0500
committerScott Moser <smoser@brickies.net>2016-11-10 16:48:58 -0500
commit127f0f5076bf8e5c53dd538899199455ebc08fbc (patch)
treeb749345cefd3c003a8e7960af32d50ea98fa2de3 /doc/rtd/topics/examples.rst
parent25c218e5659445ecf64febe03c08c6fd9ca016e6 (diff)
downloadvyos-cloud-init-127f0f5076bf8e5c53dd538899199455ebc08fbc.tar.gz
vyos-cloud-init-127f0f5076bf8e5c53dd538899199455ebc08fbc.zip
doc: make the RST files consistently formated and other improvements.
The biggest things here are: * move doc/sources/*/README.rst to doc/rtd/topics/datasources This gives each datasource a page in the rtd docs, which make it easier to read. * consistently use the same header style throughout. As suggested at http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html use: # with overline, for parts * with overline, for chapters =, for sections -, for subsections ^, for subsubsections “, for paragraphs Also, move and re-format vendor-data documentation to rtd.
Diffstat (limited to 'doc/rtd/topics/examples.rst')
-rw-r--r--doc/rtd/topics/examples.rst43
1 files changed, 22 insertions, 21 deletions
diff --git a/doc/rtd/topics/examples.rst b/doc/rtd/topics/examples.rst
index 2e6cfa1e..a110721c 100644
--- a/doc/rtd/topics/examples.rst
+++ b/doc/rtd/topics/examples.rst
@@ -1,11 +1,11 @@
.. _yaml_examples:
-=====================
+*********************
Cloud config examples
-=====================
+*********************
Including users and groups
---------------------------
+==========================
.. literalinclude:: ../../examples/cloud-config-user-groups.txt
:language: yaml
@@ -13,7 +13,7 @@ Including users and groups
Writing out arbitrary files
----------------------------
+===========================
.. literalinclude:: ../../examples/cloud-config-write-files.txt
:language: yaml
@@ -21,21 +21,21 @@ Writing out arbitrary files
Adding a yum repository
------------------------
+=======================
.. literalinclude:: ../../examples/cloud-config-yum-repo.txt
:language: yaml
:linenos:
Configure an instances trusted CA certificates
-----------------------------------------------
+==============================================
.. literalinclude:: ../../examples/cloud-config-ca-certs.txt
:language: yaml
:linenos:
Configure an instances resolv.conf
-----------------------------------
+==================================
*Note:* when using a config drive and a RHEL like system resolv.conf
will also be managed 'automatically' due to the available information
@@ -47,28 +47,28 @@ that wish to have different settings use this module.
:linenos:
Install and run `chef`_ recipes
--------------------------------
+===============================
.. literalinclude:: ../../examples/cloud-config-chef.txt
:language: yaml
:linenos:
Setup and run `puppet`_
------------------------
+=======================
.. literalinclude:: ../../examples/cloud-config-puppet.txt
:language: yaml
:linenos:
Add apt repositories
---------------------
+====================
.. literalinclude:: ../../examples/cloud-config-add-apt-repos.txt
:language: yaml
:linenos:
Run commands on first boot
---------------------------
+==========================
.. literalinclude:: ../../examples/cloud-config-boot-cmds.txt
:language: yaml
@@ -80,70 +80,70 @@ Run commands on first boot
Alter the completion message
-----------------------------
+============================
.. literalinclude:: ../../examples/cloud-config-final-message.txt
:language: yaml
:linenos:
Install arbitrary packages
---------------------------
+==========================
.. literalinclude:: ../../examples/cloud-config-install-packages.txt
:language: yaml
:linenos:
Run apt or yum upgrade
-----------------------
+======================
.. literalinclude:: ../../examples/cloud-config-update-packages.txt
:language: yaml
:linenos:
Adjust mount points mounted
----------------------------
+===========================
.. literalinclude:: ../../examples/cloud-config-mount-points.txt
:language: yaml
:linenos:
Call a url when finished
-------------------------
+========================
.. literalinclude:: ../../examples/cloud-config-phone-home.txt
:language: yaml
:linenos:
Reboot/poweroff when finished
------------------------------
+=============================
.. literalinclude:: ../../examples/cloud-config-power-state.txt
:language: yaml
:linenos:
Configure instances ssh-keys
-----------------------------
+============================
.. literalinclude:: ../../examples/cloud-config-ssh-keys.txt
:language: yaml
:linenos:
Additional apt configuration
-----------------------------
+============================
.. literalinclude:: ../../examples/cloud-config-apt.txt
:language: yaml
:linenos:
Disk setup
-----------
+==========
.. literalinclude:: ../../examples/cloud-config-disk-setup.txt
:language: yaml
:linenos:
Register RedHat Subscription
-----------------------------
+============================
.. literalinclude:: ../../examples/cloud-config-rh_subscription.txt
:language: yaml
@@ -151,3 +151,4 @@ Register RedHat Subscription
.. _chef: http://www.opscode.com/chef/
.. _puppet: http://puppetlabs.com/
+.. vi: textwidth=78