summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorScott Wittenburg <scott.wittenburg@kitware.com>2020-04-07 14:35:08 -0600
committerScott Wittenburg <scott.wittenburg@kitware.com>2020-04-07 15:20:01 -0600
commitde95a9f5f3f6ac29eab425a490a9adc280dfc74b (patch)
tree60ad560c07624d441a36a7fc6ed5359c78b14f2f
parentfc19f7de6c961a867dabbc9c2ca22fc7d18714d4 (diff)
downloadspack-de95a9f5f3f6ac29eab425a490a9adc280dfc74b.tar.gz
spack-de95a9f5f3f6ac29eab425a490a9adc280dfc74b.tar.bz2
spack-de95a9f5f3f6ac29eab425a490a9adc280dfc74b.tar.xz
spack-de95a9f5f3f6ac29eab425a490a9adc280dfc74b.zip
pipelines: Document dynamic generation limitations
-rw-r--r--lib/spack/docs/pipelines.rst24
1 files changed, 23 insertions, 1 deletions
diff --git a/lib/spack/docs/pipelines.rst b/lib/spack/docs/pipelines.rst
index a8f8198852..0f092d5c5c 100644
--- a/lib/spack/docs/pipelines.rst
+++ b/lib/spack/docs/pipelines.rst
@@ -117,6 +117,27 @@ created has the same name as the current branch being tested, but has ``multi-ci
prepended to the branch name. Once Gitlab CI has full support for dynamically
defined workloads, this command will be deprecated.
+Until this command is no longer needed and can be deprecated, there are
+a few gotchas to note. While you can embed your username and password in the
+`DOWNSTREAM_CI_REPO` url, you may not be able to have Gitlab mask the value, as
+it will likely contain characters that Gitlab cannot currently mask. Another
+option is to set up an SSH token, but for this to work, the associated SSH
+key must be passphrase-less so that it can be provided in an automated manner.
+
+If you attempt to set up an SSH token that does require a passphrase, you may
+see a log message similar to:
+
+```
+fatal: https://<instance-url>/<org>/<project>:<port>/info/refs not valid: is this a git repository?
+```
+
+In this case, you can try a passphrase-less SSH key, or else embed your gitlab
+username and password in the `DOWNSTREAM_CI_REPO` as in the following example:
+
+```
+https://<username>:<password>@<instance-url>/<org>/<project>.git
+```
+
.. _cmd_spack_ci_rebuild:
^^^^^^^^^^^^^^^^^^^^
@@ -436,4 +457,5 @@ DOWNSTREAM_CI_REPO
^^^^^^^^^^^^^^^^^^
Needed until Gitlab CI supports dynamic job generation. Can contain connection
-credentials, and could be the same repository or a different one.
+credentials embedded in the url, and could be the same repository or a different
+one.