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 /cloudinit/config/cc_spacewalk.py | |
| 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 'cloudinit/config/cc_spacewalk.py')
| -rw-r--r-- | cloudinit/config/cc_spacewalk.py | 25 |
1 files changed, 20 insertions, 5 deletions
diff --git a/cloudinit/config/cc_spacewalk.py b/cloudinit/config/cc_spacewalk.py index f3c1a664..99b63a84 100644 --- a/cloudinit/config/cc_spacewalk.py +++ b/cloudinit/config/cc_spacewalk.py @@ -13,15 +13,30 @@ # along with this program. If not, see <http://www.gnu.org/licenses/>. """ -**Summary:** helper to setup https://fedorahosted.org/spacewalk/ +Spacewalk +--------- +**Summary:** install and configure spacewalk -**Description:** This module will enable for configuring the needed -actions to setup spacewalk on redhat based systems. +This module installs spacewalk and applies basic configuration. If the +``spacewalk`` config key is present spacewalk will be installed. The server to +connect to after installation must be provided in the ``server`` in spacewalk +configuration. A proxy to connect through and a activation key may optionally +be specified. -It can be configured with the following option structure:: +For more information about spacewalk see: https://fedorahosted.org/spacewalk/ + +**Internal name:** ``cc_spacewalk`` + +**Module frequency:** per instance + +**Supported distros:** redhat, fedora + +**Config keys**:: spacewalk: - server: spacewalk api server (required) + server: <url> + proxy: <proxy host> + activation_key: <key> """ from cloudinit import util |