zuul-jobs/roles/remove-build-sshkey/README.rst
Jeremy Stanley 016a20c0ff 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
2021-04-01 15:29:01 +00:00

16 lines
418 B
ReStructuredText

Remove the per-build SSH key from all hosts
The complement to :zuul:role:`add-build-sshkey`. It removes the
build's SSH key from the authorized_keys files of all remote hosts.
**Role Variables**
.. 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.