Add entries describing new gnt-cluster params to manpage
authorHrvoje Ribicic <riba@google.com>
Mon, 9 Nov 2015 17:49:53 +0000 (18:49 +0100)
committerHrvoje Ribicic <riba@google.com>
Fri, 20 Nov 2015 10:14:33 +0000 (11:14 +0100)
And also sprinkle reminders of when to update them across the codebase.

Signed-off-by: Hrvoje Ribicic <riba@google.com>
Reviewed-by: Helga Velroyen <helgav@google.com>

lib/ssh.py
man/gnt-cluster.rst
src/Ganeti/Constants.hs

index 7b27214..a8fe86d 100644 (file)
@@ -1100,6 +1100,7 @@ def ReadRemoteSshPubKeys(pub_key_file, node, cluster_name, port, ask_key,
   return result.stdout
 
 
+# Update gnt-cluster.rst when changing which combinations are valid.
 KeyBitInfo = namedtuple('KeyBitInfo', ['default', 'validation_fn'])
 SSH_KEY_VALID_BITS = {
   constants.SSHK_DSA: KeyBitInfo(1024, lambda b: b == 1024),
index b50d7d4..a958e22 100644 (file)
@@ -206,6 +206,8 @@ INIT
 | [\--zeroing-image *image*]
 | [\--compression-tools [*tool*, [*tool*]]]
 | [\--user-shutdown {yes \| no}]
+| [\--ssh-key-type *type*]
+| [\--ssh-key-bits *bits*]
 | {*clustername*}
 
 This commands is only run once initially on the first node of the
@@ -635,6 +637,18 @@ of testing whether the executable exists. These requirements are
 compatible with the gzip command line options, allowing many tools to
 be easily wrapped and used.
 
+The ``--ssh-key-type`` and ``--ssh-key-bits`` options determine the
+properties of the SSH keys Ganeti generates and uses to execute
+commands on nodes. The supported types are currently 'dsa', 'rsa', and
+'ecdsa'. The supported bit sizes vary across keys, reflecting the
+options **ssh-keygen**\(1) exposes. These are currently:
+
+- dsa: 1024 bits
+- rsa: >=768 bits
+- ecdsa: 256, 384, or 521 bits
+
+Ganeti defaults to using 2048-bit RSA keys.
+
 MASTER-FAILOVER
 ~~~~~~~~~~~~~~~
 
@@ -860,6 +874,7 @@ RENEW-CRYPTO
 | \--spice-ca-certificate *spice-ca-cert*]
 | [\--new-ssh-keys] [\--no-ssh-key-check]
 | [\--new-cluster-domain-secret] [\--cluster-domain-secret *filename*]
+| [\--ssh-key-type *type*] | [\--ssh-key-bits *bits*]
 
 This command will stop all Ganeti daemons in the cluster and start
 them again once the new certificates and keys are replicated. The
@@ -901,6 +916,10 @@ cluster domain secret, and ``--cluster-domain-secret`` reads the
 secret from a file. The cluster domain secret is used to sign
 information exchanged between separate clusters via a third party.
 
+The options ``--ssh-key-type`` and ``ssh-key-bits`` determine the
+properties of the disk types used. They are described in more detail
+in the ``init`` option description.
+
 REPAIR-DISK-SIZES
 ~~~~~~~~~~~~~~~~~
 
index c9ca540..08a4f21 100644 (file)
@@ -4703,6 +4703,7 @@ sshakAll :: FrozenSet String
 sshakAll = ConstantUtils.mkSet [sshakDss, sshakRsa]
 
 -- * SSH key default values
+-- Document the change in gnt-cluster.rst when changing these
 
 sshDefaultKeyType :: String
 sshDefaultKeyType = sshkRsa