From 016a20c0ff1805ca89809b8d7a3274c82fcdeb47 Mon Sep 17 00:00:00 2001 From: Jeremy Stanley Date: Wed, 31 Mar 2021 00:53:34 +0000 Subject: [PATCH] Document algorithm var for remove-build-sshkey A recent hotfix added a fallback zuul_ssh_key_algorithm value for the remove-build-sshkey role, reflect it in the role documentation. Also remove some redundancies with default values specified in prose for the add-build-sshkey role, when they were also indicated by the :default: parameter. Change-Id: If3f74256788283dedb17ad780da3ca4df4503cb4 --- roles/add-build-sshkey/README.rst | 6 ++---- roles/remove-build-sshkey/README.rst | 5 +++++ 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/roles/add-build-sshkey/README.rst b/roles/add-build-sshkey/README.rst index ec8697125..5528a88cf 100644 --- a/roles/add-build-sshkey/README.rst +++ b/roles/add-build-sshkey/README.rst @@ -30,11 +30,9 @@ newly generated private key. .. zuul:rolevar:: zuul_ssh_key_algorithm :default: rsa - The digital signature algorithm to be used to generate the key. Default value - 'rsa'. + The digital signature algorithm to be used to generate the key. .. zuul:rolevar:: zuul_ssh_key_size :default: 3072 - Specifies the number of bits in the key to create. The default length is - 3072 bits (RSA). + Specifies the number of bits in the key to create. diff --git a/roles/remove-build-sshkey/README.rst b/roles/remove-build-sshkey/README.rst index d046ac44a..c3d0199ee 100644 --- a/roles/remove-build-sshkey/README.rst +++ b/roles/remove-build-sshkey/README.rst @@ -8,3 +8,8 @@ build's SSH key from the authorized_keys files of all remote hosts. .. zuul:rolevar:: zuul_temp_ssh_key Where the per-build SSH private key was stored. + +.. zuul:rolevar:: zuul_ssh_key_algorithm + :default: rsa + + The digital signature algorithm which was used to generate the key.