From 9b655c8d5d058509bc2b5530a51cb86f62857756 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 23 Jan 2020 17:08:22 +0100 Subject: [PATCH] Update roles/prepare-workspace-openshift/README.rst Use a proper link to the referenced role and mention in the short description that this is related to OpenShift. While it might work with any Kubernetes, it uses an openshift tool, oc. Change-Id: Ia4fba00c8a3adec4dc26a2d32a21df8ff548a120 --- roles/prepare-workspace-openshift/README.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/roles/prepare-workspace-openshift/README.rst b/roles/prepare-workspace-openshift/README.rst index caa516316..46057f454 100644 --- a/roles/prepare-workspace-openshift/README.rst +++ b/roles/prepare-workspace-openshift/README.rst @@ -1,8 +1,9 @@ -Prepare remote workspaces +Prepare remote workspaces in OpenShift -This role can be used instead of the `prepare-workspace` role when the -synchronize module doesn't work with kubectl connection. It copies the -prepared source repos to the pods' cwd using the `oc rsync` command. +This role can be used instead of the :zuul:role:`prepare-workspace` +role when the synchronize module doesn't work with kubectl connection. +It copies the prepared source repos to the pods' cwd using the `oc +rsync` command. This role is intended to run once before any other role in a Zuul job. This role requires the origin-clients to be installed.