zuul/zuul-jobs
Code Issues Proposed changes

Document algorithm var for remove-build-sshkey

Browse Source 
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
This commit is contained in:
Jeremy Stanley 2021-03-31 00:53:34 +00:00
parent b5ffcea04d
commit 016a20c0ff
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
roles/add-build-sshkey/README.rst
View File

@ -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.

5
roles/remove-build-sshkey/README.rst
View File

@ -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.