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_keys_to_console.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_keys_to_console.py')
-rw-r--r-- | cloudinit/config/cc_keys_to_console.py | 24 |
1 files changed, 24 insertions, 0 deletions
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 <http://www.gnu.org/licenses/>. +""" +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: <list of key types> + ssh_key_console_blacklist: <list of key types> +""" + import os from cloudinit.settings import PER_INSTANCE |