zuul-jobs/roles/upload-git-mirror/README.rst
David Moreau Simard ed9f1d14a0
Add parameter to upload-git-mirror to specify ssh host key
If we attempt to push a mirror to a host we've never connected to
before, it won't be in the SSH known hosts and the mirror will fail.

This makes a new host_key parameter required and the role takes care
of setting it up in the known_hosts for the duration of the job.

Change-Id: I4bd40a289003fe3e88c9af4029576236c064fc3d
Depends-On: https://review.openstack.org/#/c/649183/
2019-04-01 16:34:59 -04:00

36 lines
906 B
ReStructuredText

Mirrors a git repository to a remote git server
Meant to be used after a change was successfully merged, this role mirrors a
tested git repository to a remote git server over SSH.
The role assumes that git has been previously installed and does not require
superuser privileges to run.
**Role Variables**
.. zuul:rolevar:: git_mirror_credentials
Dictionary that provides the remote git repository credentials
.. zuul:rolevar:: user
SSH user for the remote git repository
.. zuul:rolevar:: host
SSH host for the remote git repository
.. zuul:rolevar:: ssh_key
Literal private key contents.
Should start with something like ``-----BEGIN RSA PRIVATE KEY-----``.
.. zuul:rolevar:: host_key
SSH host key of the remote git server.
Can be obtained with ``ssh-keyscan -H <host>``.
.. zuul:rolevar:: git_mirror_repository
Path of the remote git repository