From 1071b9940b4e114cd2eabf290b739f92fbab33de Mon Sep 17 00:00:00 2001 From: Wesley Wiedenmeier Date: Sun, 28 Aug 2016 17:56:17 -0500 Subject: 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 --- cloudinit/config/cc_puppet.py | 45 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) (limited to 'cloudinit/config/cc_puppet.py') diff --git a/cloudinit/config/cc_puppet.py b/cloudinit/config/cc_puppet.py index 774d3322..bfd630d2 100644 --- a/cloudinit/config/cc_puppet.py +++ b/cloudinit/config/cc_puppet.py @@ -18,6 +18,51 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Puppet +------ +**Summary:** install, configure and start puppet + +This module handles puppet installation and configuration. If the ``puppet`` +key does not exist in global configuration, no action will be taken. If a +config entry for ``puppet`` is present, then by default the latest version of +puppet will be installed. If ``install`` is set to ``false``, puppet will not +be installed. However, this may result in an error if puppet is not already +present on the system. The version of puppet to be installed can be specified +under ``version``, and defaults to ``none``, which selects the latest version +in the repos. If the ``puppet`` config key exists in the config archive, this +module will attempt to start puppet even if no installation was performed. + +Puppet configuration can be specified under the ``conf`` key. The configuration +is specified as a dictionary which is converted into ``=`` format +and appended to ``puppet.conf`` under the ``[puppetd]`` section. The +``certname`` key supports string substitutions for ``%i`` and ``%f``, +corresponding to the instance id and fqdn of the machine respectively. +If ``ca_cert`` is present under ``conf``, it will not be written to +``puppet.conf``, but instead will be used as the puppermaster certificate. +It should be specified in pem format as a multi-line string (using the ``|`` +yaml notation). + +**Internal name:** ``cc_puppet`` + +**Module frequency:** per instance + +**Supported distros:** all + +**Config keys**:: + + puppet: + install: + version: + conf: + server: "puppetmaster.example.org" + certname: "%i.%f" + ca_cert: | + -------BEGIN CERTIFICATE------- + + -------END CERTIFICATE------- +""" + from six import StringIO import os -- cgit v1.2.3