Skip to content

Commit

Permalink
Added Invalid authentication for Git Remote to troubleshooting (#2731)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
daavoo and jorgeorpinel authored Sep 13, 2021
1 parent c0ba287 commit bbae045
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 10 deletions.
7 changes: 3 additions & 4 deletions content/docs/command-reference/exp/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ usage: dvc exp list [-h] [-q | -v] [--rev <rev>]
[git_remote]
positional arguments:
git_remote Optional Git remote name or repo URL
git_remote Optional Git remote name or Git URL
```

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

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

> Note that this utility doesn't require an existing <abbr>DVC project</abbr> to
> run from when a `git_remote` URL is given.
Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/exp/pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ usage: dvc exp pull [-h] [-q | -v] [-f] [--no-cache]
git_remote experiment
positional arguments:
git_remote Git remote name or repo URL
git_remote Git remote name or Git URL
experiment Experiment to pull
```

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

The first action of `dvc exp pull` is to download the `experiment` so it's
available in the local repository (equivalent to
Expand Down
6 changes: 3 additions & 3 deletions content/docs/command-reference/exp/push.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ usage: dvc exp push [-h] [-q | -v] [-f] [--no-cache]
git_remote experiment
positional arguments:
git_remote Git remote name or repo URL
git_remote Git remote name or Git URL
experiment Experiment to push
```

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

The first action of `dvc exp push` is to upload the `experiment` to the Git
remote so it can be pulled later from other repo clones (equivalent to
Expand Down
15 changes: 15 additions & 0 deletions content/docs/user-guide/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,18 @@ using:
```dvc
$ dvc checkout --relink
```

## HTTP Git authentication is not supported {#git-auth}

[Experiment sharing](/doc/user-guide/experiment-management/sharing-experiments)
commands accept a `git_remote` argument. In order to access the Git remote, you
may need to authenticate for _write_ (`dvc exp push`) or _read_ (`dvc exp list`,
`dvc exp pull`) permissions.

DVC does not currently support authentication with [Git credentials]. This means
that unless the Git server allows unauthenticated HTTP write/read, you should
use an [SSH Git URL] when listing, pulling or pushing experiments.

[git credentials]: https://git-scm.com/docs/gitcredentials
[ssh git url]:
https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_protocols

0 comments on commit bbae045

Please sign in to comment.