diff options
| author | Wesley Wiedenmeier <wesley.wiedenmeier@gmail.com> | 2016-08-28 17:56:17 -0500 |
|---|---|---|
| committer | Scott Moser <smoser@brickies.net> | 2016-09-30 13:21:00 -0400 |
| commit | 1071b9940b4e114cd2eabf290b739f92fbab33de (patch) | |
| tree | a8fbef15c5be9510df93b4544e3bca1f74e2f29a /doc/rtd/topics/examples.rst | |
| parent | 02f6c4bb8cef17b3fe04ef4dc1ef199e20aeb4d9 (diff) | |
| download | vyos-cloud-init-1071b9940b4e114cd2eabf290b739f92fbab33de.tar.gz vyos-cloud-init-1071b9940b4e114cd2eabf290b739f92fbab33de.zip | |
Improve module documentation and doc cleanup.
This adds lots of config module documentation in a standard format.
It will greatly improve the content at readthedocs.
Additionally:
* Add a 'doc' env to tox.ini
* Changed default highlight language for sphinx conf from python to yaml
most examples in documentation are yaml configs
* Updated datasource examples to highlight sh code properly
Diffstat (limited to 'doc/rtd/topics/examples.rst')
| -rw-r--r-- | doc/rtd/topics/examples.rst | 52 |
1 files changed, 36 insertions, 16 deletions
diff --git a/doc/rtd/topics/examples.rst b/doc/rtd/topics/examples.rst index 36508bde..2e6cfa1e 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 @@ -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,21 +80,21 @@ 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 @@ -108,26 +108,46 @@ Adjust mount points mounted :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 + :linenos: .. _chef: http://www.opscode.com/chef/ .. _puppet: http://puppetlabs.com/ |