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_rh_subscription.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_rh_subscription.py')
-rw-r--r-- | cloudinit/config/cc_rh_subscription.py | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/cloudinit/config/cc_rh_subscription.py b/cloudinit/config/cc_rh_subscription.py index d4ad724a..d858f65c 100644 --- a/cloudinit/config/cc_rh_subscription.py +++ b/cloudinit/config/cc_rh_subscription.py @@ -16,6 +16,40 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. +""" +RedHat Subscription +------------------- +**Summary:** register red hat enterprise linux based system + +Register a RedHat system either by username and password *or* activation and +org. Following a sucessful registration, you can auto-attach subscriptions, set +the service level, add subscriptions based on pool id, enable/disable yum +repositories based on repo id, and alter the rhsm_baseurl and server-hostname +in ``/etc/rhsm/rhs.conf``. For more details, see the ``Register RedHat +Subscription`` example config. + +**Internal name:** ``cc_rh_subscription`` + +**Module frequency:** per instance + +**Supported distros:** rhel, fedora + +**Config keys**:: + + rh_subscription: + username: <username> + password: <password> + activation-key: <activation key> + org: <org number> + auto-attach: <true/false> + service-level: <service level> + add-pool: <list of pool ids> + enable-repo: <list of yum repo ids> + disable-repo: <list of yum repo ids> + rhsm-baseurl: <url> + server-hostname: <hostname> +""" + from cloudinit import util distros = ['fedora', 'rhel'] |