Skip to content

Commit a567e50

Browse files
daavoojorgeorpinel
authored andcommitted
Added Invalid authentication for Git Remote to troubleshooting (#2731)
* Added note about [SSH Git URLs] in dvc exp commands * Applied suggestions * Updated warning * Removed SSH from synopsis * Added Invalid authentication for Git Remote to troubleshooting * Added shorter title * Applied P.R. suggestions * Update content/docs/user-guide/troubleshooting.md * Update content/docs/user-guide/troubleshooting.md * Apply suggestions from code review Co-authored-by: Jorge Orpinel <[email protected]> * valid -> authenticated * Format * Update troubleshooting.md * Removed authenticated * Added note about git credentials Co-authored-by: Jorge Orpinel <[email protected]>
1 parent 400e544 commit a567e50

File tree

4 files changed

+24
-10
lines changed

4 files changed

+24
-10
lines changed

content/docs/command-reference/exp/list.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ usage: dvc exp list [-h] [-q | -v] [--rev <rev>]
1010
[git_remote]
1111
1212
positional arguments:
13-
git_remote Optional Git remote name or repo URL
13+
git_remote Optional Git remote name or Git URL
1414
```
1515

1616
## Description
@@ -20,9 +20,8 @@ or commit they're based on. This is similar to `dvc exp show --no-pager`, but
2020
limited to experiment names and with very simple formatting. See also
2121
`dvc exp run`.
2222

23-
If a working `git_remote` name (e.g. `origin`) or valid Git repo's URL is
24-
provided, lists experiments in that <abbr>repository</abbr> instead (if any,
25-
based on the `dvc remote default`).
23+
If a working `git_remote` name (e.g. `origin`) or Git URL is provided, lists
24+
experiments in that <abbr>repository</abbr> instead (if any).
2625

2726
> Note that this utility doesn't require an existing <abbr>DVC project</abbr> to
2827
> run from when a `git_remote` URL is given.

content/docs/command-reference/exp/pull.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ usage: dvc exp pull [-h] [-q | -v] [-f] [--no-cache]
1111
git_remote experiment
1212
1313
positional arguments:
14-
git_remote Git remote name or repo URL
14+
git_remote Git remote name or Git URL
1515
experiment Experiment to pull
1616
```
1717

@@ -24,8 +24,8 @@ experiments across <abbr>repository</abbr> copies via Git (and DVC) remotes.
2424
> these are saved under custom Git references. See **How does DVC track
2525
> experiments?** in `dvc exp run` to learn more about DVC experiment storage.
2626
27-
A working `git_remote` name (e.g. `origin`) or valid Git repo's URL is required,
28-
as well as an `experiment` name or hash (see `dvc exp run`) to pull.
27+
A working `git_remote` name (e.g. `origin`) or Git URL is required, as well as
28+
an `experiment` name or hash (see `dvc exp run`) to pull.
2929

3030
The first action of `dvc exp pull` is to download the `experiment` so it's
3131
available in the local repository (equivalent to

content/docs/command-reference/exp/push.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ usage: dvc exp push [-h] [-q | -v] [-f] [--no-cache]
1111
git_remote experiment
1212
1313
positional arguments:
14-
git_remote Git remote name or repo URL
14+
git_remote Git remote name or Git URL
1515
experiment Experiment to push
1616
```
1717

@@ -24,8 +24,8 @@ experiments across <abbr>repository</abbr> copies via Git (and DVC) remotes.
2424
> these are saved under custom Git references. See **How does DVC track
2525
> experiments?** in `dvc exp run` to learn more about DVC experiment storage.
2626
27-
A working `git_remote` name (e.g. `origin`) or valid Git repo's URL is required,
28-
as well as an `experiment` name or hash (see `dvc exp run`) to push.
27+
A working `git_remote` name (e.g. `origin`) or Git URL is required, as well as
28+
an `experiment` name or hash (see `dvc exp run`) to push.
2929

3030
The first action of `dvc exp push` is to upload the `experiment` to the Git
3131
remote so it can be pulled later from other repo clones (equivalent to

content/docs/user-guide/troubleshooting.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,3 +91,18 @@ using:
9191
```dvc
9292
$ dvc checkout --relink
9393
```
94+
95+
## HTTP Git authentication is not supported {#git-auth}
96+
97+
[Experiment sharing](/doc/user-guide/experiment-management/sharing-experiments)
98+
commands accept a `git_remote` argument. In order to access the Git remote, you
99+
may need to authenticate for _write_ (`dvc exp push`) or _read_ (`dvc exp list`,
100+
`dvc exp pull`) permissions.
101+
102+
DVC does not currently support authentication with [Git credentials]. This means
103+
that unless the Git server allows unauthenticated HTTP write/read, you should
104+
use an [SSH Git URL] when listing, pulling or pushing experiments.
105+
106+
[git credentials]: https://git-scm.com/docs/gitcredentials
107+
[ssh git url]:
108+
https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_protocols

0 commit comments

Comments
 (0)