-
Notifications
You must be signed in to change notification settings - Fork 394
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Misc. updates #2182
Merged
Merged
Misc. updates #2182
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
3a485da
config: better s3.configpath explanation (after #2140)
jorgeorpinel c965762
remote: review ssh// URLs and auth info.
jorgeorpinel 1e08ff8
cmd: note ~/ paths are for Linux in remote modify
jorgeorpinel 5576e32
Merge branch 'master' into jorge
jorgeorpinel 46ac6a1
Merge branch 'master' into jorge
jorgeorpinel c67ec08
typo in start/pipelines
jorgeorpinel 3edda90
Merge branch 'master' into jorge
jorgeorpinel d9597f8
Merge branch 'master' into jorge
jorgeorpinel 866243d
Merge branch 'master' into jorge
jorgeorpinel eac96f8
typos
jorgeorpinel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -37,6 +37,9 @@ certain `dvc remote` types. Currently, the following protocols are supported: | |
Let's take a look at defining and running a `download_file` stage that simply | ||
downloads a file from an external location, on all the supported location types. | ||
|
||
> See the [Remote alias example](#example-using-dvc-remote-aliases) for info. on | ||
> using remote locations that require manual authentication setup. | ||
|
||
<details> | ||
|
||
### Click for Amazon S3 | ||
|
@@ -88,7 +91,7 @@ $ dvc run -n download_file \ | |
$ dvc run -n download_file \ | ||
-d ssh://user@example.com/path/to/data.txt \ | ||
-o data.txt \ | ||
scp user@example.com:/path/to/data.txt data.txt | ||
scp ssh://user@example.com:/path/to/data.txt data.txt | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. hmm, I don't usually specify the protocol like this There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Right. Reverting this change. |
||
``` | ||
|
||
⚠️ DVC requires both SSH and SFTP access to work with remote SSH locations. | ||
|
@@ -144,10 +147,9 @@ $ dvc run -n download_file \ | |
## Example: Using DVC remote aliases | ||
|
||
You may want to encapsulate external locations as configurable entities that can | ||
be managed independently. This is useful if multiple dependencies (or stages) | ||
reuse the same location, or if its likely to change in the future. And if the | ||
location requires authentication, you need a way to configure it in order to | ||
connect. | ||
be managed independently. This is useful if the connection requires | ||
authentication, if multiple dependencies (or stages) reuse the same location, or | ||
if the URL is likely to change in the future. | ||
|
||
[DVC remotes](/doc/command-reference/remote) can do just this. You may use | ||
`dvc remote add` to define them, and then use a special URL with format | ||
|
@@ -157,12 +159,11 @@ dependency. | |
Let's see an example using SSH. First, register and configure the remote: | ||
|
||
```dvc | ||
$ dvc remote add myssh ssh://myserver.com | ||
$ dvc remote modify --local myssh user myuser | ||
$ dvc remote modify --local myssh password mypassword | ||
$ dvc remote add myssh ssh://user@example.com | ||
$ dvc remote modify --local myssh password 'mypassword' | ||
``` | ||
|
||
> Please refer to `dvc remote add` for more details like setting up access | ||
> Please refer to `dvc remote modify` for more details like setting up access | ||
> credentials for the different remote types. | ||
|
||
Now, use an alias to this remote when defining the stage: | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this can already the
- something is missing here?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah yes, "included". Thanks