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_keys_to_console.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'cloudinit/config/cc_keys_to_console.py') diff --git a/cloudinit/config/cc_keys_to_console.py b/cloudinit/config/cc_keys_to_console.py index 9a02f056..d4b2013e 100644 --- a/cloudinit/config/cc_keys_to_console.py +++ b/cloudinit/config/cc_keys_to_console.py @@ -18,6 +18,30 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Keys to Console +--------------- +**Summary:** control which ssh keys may be written to console + +For security reasons it may be desirable not to write ssh fingerprints and keys +to the console. To avoid the fingerprint of types of ssh keys being written to +console the ``ssh_fp_console_blacklist`` config key can be used. By default all +types of keys will have their fingerprints written to console. To avoid keys +of a key type being written to console the ``ssh_key_console_blacklist`` config +key can be used. By default ``ssh-dss`` keys are not written to console. + +**Internal name:** ``cc_keys_to_console`` + +**Module frequency:** per instance + +**Supported distros:** all + +**Config keys**:: + + ssh_fp_console_blacklist: + ssh_key_console_blacklist: +""" + import os from cloudinit.settings import PER_INSTANCE -- cgit v1.2.3