Add a job that runs the upload-git-mirror role

This new job can be used by projects to mirror their repository to a
remote git server.

Change-Id: I6c51a6152f546dfdad2d0bfe260e8864e1803f8c

doc/source/general-jobs.rst

@@ -5,3 +5,4 @@ General Purpose Jobs
 .. zuul:autojob:: unittests
 .. zuul:autojob:: multinode
 .. zuul:autojob:: run-test-command
+.. zuul:autojob:: upload-git-mirror

playbooks/upload-git-mirror/run.yaml

@@ -0,0 +1,4 @@
+- name: Mirror git repository to a remote git server
+  hosts: all
+  roles:
+    - upload-git-mirror

zuul.yaml

@@ -50,6 +50,34 @@
     nodeset:
       nodes: []
 
+- job:
+    name: upload-git-mirror
+    description: |
+      Mirrors a tested project repository to a remote git server.
+
+      .. zuul:jobvar:: git_mirror_credentials
+        :type: dict
+
+        This is expected to be a Zuul Secret with these keys:
+
+        .. zuul:jobvar:: user
+
+          SSH user for the remote git repository
+
+        .. zuul:jobvar:: host
+
+          SSH host for the remote git repository
+
+        .. zuul:jobvar:: key
+
+          Literal private key contents.
+          Should start with something like ``-----BEGIN RSA PRIVATE KEY-----``.
+
+      .. zuul:jobvar:: git_mirror_repository
+
+        Path of the remote git repository
+    run: playbooks/upload-git-mirror/run.yaml
+
 - job:
     name: tox
     parent: unittests