Skip to content
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

ref: remote updates #4062

Merged
merged 123 commits into from
Feb 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
123 commits
Select commit Hold shift + click to select a range
7350938
guide: draft structure of Data Mgmt and
jorgeorpinel Oct 13, 2022
203f6a6
guide: full text for draft intro to DM
jorgeorpinel Oct 14, 2022
90eaa5d
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Oct 17, 2022
eb246bb
guide: hide cloud versioning info
jorgeorpinel Oct 17, 2022
a3687ec
guide: clarify Data Mgmt parts and
jorgeorpinel Oct 18, 2022
fad0bad
guide: add figure drafts to Data Mgmt
jorgeorpinel Oct 19, 2022
4e3c3da
guide: SCM->VC (Data Mgmt)
jorgeorpinel Oct 19, 2022
7f02c15
guide: update 2 figs and add 1 more (Data Mgmt)
jorgeorpinel Oct 19, 2022
f41d16e
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Oct 20, 2022
3a9a045
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Oct 20, 2022
df40521
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Oct 20, 2022
adc13ee
Merge branch 'guide/data-mgmt-flows' into guide/data-mgmt/remote-config
jorgeorpinel Oct 21, 2022
c0b92f1
guide: roll back unrelated changes
jorgeorpinel Oct 21, 2022
636872a
Merge branch 'guide/data-mgmt-flows' into guide/data-mgmt/remote-config
jorgeorpinel Oct 22, 2022
c2303c0
guide: mention clouds first (DM) and
jorgeorpinel Oct 22, 2022
62997ab
guide: flatten DM index
jorgeorpinel Oct 22, 2022
fc74c53
guide: udpates to DM/ DV
jorgeorpinel Oct 22, 2022
8c40a03
guide: add DM/ Data Versioning page
jorgeorpinel Oct 22, 2022
1a8ca61
guide: update outdated link
jorgeorpinel Oct 22, 2022
27be87f
guide: revert more unrelatedly chaqnged files
jorgeorpinel Oct 22, 2022
aaee7af
guide: remove unused ref link
jorgeorpinel Oct 22, 2022
dd99f21
Merge branch 'guide/data-mgmt-flows' into guide/data-mgmt/remote-config
jorgeorpinel Oct 22, 2022
118e3eb
guide: DM/ Remote Storage (not just Setup) and
jorgeorpinel Oct 22, 2022
24c331a
guide: remove a comment
jorgeorpinel Oct 22, 2022
ff85dcc
Merge branch 'guide/data-mgmt-flows' into guide/data-mgmt/remote-config
jorgeorpinel Oct 22, 2022
266a8f7
guide: draft for DM/ Remote Storage content
jorgeorpinel Oct 22, 2022
b04f20a
ref: expand config.remote and link to/from Remotes guide
jorgeorpinel Oct 23, 2022
1c77de4
ref: fix remote config file examples
jorgeorpinel Oct 23, 2022
8e7c320
guide: complete Remote Config section and
jorgeorpinel Oct 23, 2022
bc9f588
ref: rewrite remote add and modify Descs
jorgeorpinel Oct 24, 2022
9b904f5
guide: complete list of supported storage types
jorgeorpinel Oct 24, 2022
c80f8ed
Merge branch 'guide/data-mgmt/remote-config' into guide/data-mgmt/rem…
jorgeorpinel Oct 24, 2022
33f46fc
ref: rewrite remote index page from
jorgeorpinel Oct 24, 2022
3b5e520
guide: clarify `remote modify` phrase in
jorgeorpinel Oct 24, 2022
abf3a87
Merge branch 'guide/data-mgmt/remote-config' into guide/data-mgmt/rem…
jorgeorpinel Oct 24, 2022
73e2f55
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Oct 27, 2022
7fc7fa3
Merge branch 'guide/data-mgmt-flows' into guide/data-mgmt/remote-config
jorgeorpinel Oct 27, 2022
d619d6b
Merge branch 'guide/data-mgmt/remote-config' into guide/data-mgmt/rem…
jorgeorpinel Oct 27, 2022
ff7e666
Update content/docs/user-guide/data-management/data-versioning.md
Oct 27, 2022
c0026fc
guide: update versioning config
jorgeorpinel Oct 27, 2022
71b599c
guide: don't call remote storage "additional" here
jorgeorpinel Oct 27, 2022
9774855
guide: pull -> download (DM/ RS intro)
jorgeorpinel Oct 27, 2022
e5c6f13
guide: remove "optional" from Remote Storage nav & title
jorgeorpinel Oct 27, 2022
ec1af6d
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Oct 28, 2022
2f31bb6
guide: splits and notes around Data Mgmt index page
jorgeorpinel Oct 28, 2022
a84c442
guide: Data Mgmt intro + note updates
jorgeorpinel Oct 29, 2022
ab55389
guide: draft of all contents +
jorgeorpinel Oct 29, 2022
31d5288
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Nov 1, 2022
a13f989
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Nov 2, 2022
601c99e
guide: small impros to Data Mgmt
jorgeorpinel Nov 2, 2022
a8bad84
guide: rewrite Data Mgmt index in before/after form
jorgeorpinel Nov 3, 2022
c8cc17b
guide: add draft figure for Data Mgmt
jorgeorpinel Nov 4, 2022
3cb84cb
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Nov 8, 2022
a13cb0f
guide: simplify/refocus data mgmt index
jorgeorpinel Nov 8, 2022
e3ba70b
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Nov 17, 2022
c29d9ec
work around commented header bug
jorgeorpinel Nov 17, 2022
875fba3
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Nov 23, 2022
831ad1d
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Nov 25, 2022
8ddda9c
guide: drop DM/ DV page
jorgeorpinel Nov 25, 2022
28322e5
guide: rewrite DM intro and
jorgeorpinel Nov 25, 2022
179d172
guide: use DM table instead of figure for now
jorgeorpinel Nov 25, 2022
d979a5e
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Nov 30, 2022
74bc156
guide: rewrite Data Mgmt story
jorgeorpinel Nov 30, 2022
e138096
guide: add draft figures to Data Mgmt
jorgeorpinel Nov 30, 2022
f904038
guide: simplify Data Mgmt story and benefits
jorgeorpinel Dec 1, 2022
e1772ea
guide: remove unused images (DM)
jorgeorpinel Dec 1, 2022
cc0390e
guide: update Data Mgmt figures (v1)
jorgeorpinel Dec 2, 2022
4ee3223
guide: rewrite text of Data Mgmt index
jorgeorpinel Dec 8, 2022
149599b
Merge branch 'main' of github.com:iterative/dvc.org into guide/data-m…
rogermparent Dec 8, 2022
f2acb66
guide: update Data Mgmt figures
jorgeorpinel Dec 8, 2022
723eb50
guide: iterate on Data Mgmt again
jorgeorpinel Dec 14, 2022
4b67b64
guide: update Data Mgmt figs
jorgeorpinel Dec 14, 2022
9eb7143
guide: more supporting info about Data Mgmt
jorgeorpinel Dec 18, 2022
e598839
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Dec 21, 2022
dd4466e
guide: update figures (much more concrete) and
jorgeorpinel Dec 21, 2022
d637179
guide: edits to How it works (Data Mgmt)
jorgeorpinel Dec 21, 2022
c007817
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Dec 22, 2022
5a0fd57
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Dec 22, 2022
3eb81ff
guide: update Data Mgmt figures
jorgeorpinel Dec 22, 2022
98e73ff
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Dec 23, 2022
67b1717
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Dec 27, 2022
f3af183
guide: emphaisze dataset versions in UG fig 1
jorgeorpinel Dec 27, 2022
206ce77
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Jan 4, 2023
075aaf3
guide: update Data Mgmt figures (with notes),
jorgeorpinel Jan 5, 2023
7377500
guide: more updates to text and figure styles,
jorgeorpinel Jan 5, 2023
baf5b4c
guide: update figures and text (Data Mgmt) ...
jorgeorpinel Jan 9, 2023
fb35df5
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Jan 11, 2023
4475f78
guide: Data Management text (section 1)
jorgeorpinel Jan 11, 2023
20fbaae
guide: Data Management (main text)
jorgeorpinel Jan 11, 2023
1da7b8a
guide: Data Management (secondary text)
jorgeorpinel Jan 12, 2023
61e2865
Merge branch 'guide/data-mgmt-flows' of github.com:iterative/dvc.org …
jorgeorpinel Jan 12, 2023
ed63127
guide: add DVC data mgmt technical diagram &
jorgeorpinel Jan 12, 2023
0109cf3
guide: update Data Mgmt text
jorgeorpinel Jan 18, 2023
77330cc
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Jan 18, 2023
956b03d
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Jan 19, 2023
7152ad3
guide: udpate text and 2nd figure (Data Mgmt)
jorgeorpinel Jan 19, 2023
f29da1e
guide: draft 2nd and 3rd figures
jorgeorpinel Jan 19, 2023
8f49a72
guide: rewrite Data Mgmt/ How it works &
jorgeorpinel Jan 20, 2023
f876c17
guide: update drafts of Data Mgmt figures 2, 3
jorgeorpinel Jan 20, 2023
ee3f721
guide: Data Mgmt improvements and
jorgeorpinel Jan 24, 2023
061a918
Merge branch 'main' into guide/data-mgmt-flows
jorgeorpinel Jan 24, 2023
ac50c94
Merge branch 'guide/data-mgmt-flows' into guide/data-mgmt/remote-config
jorgeorpinel Jan 24, 2023
d781fdd
guide: separate from Data Mgmt work
jorgeorpinel Jan 24, 2023
00f0993
Merge branch 'guide/data-mgmt/remote-config' into guide/data-mgmt/rem…
jorgeorpinel Jan 24, 2023
91a7384
Apply suggestions from code review
jorgeorpinel Jan 24, 2023
b07f81c
Merge branch main +
jorgeorpinel Jan 24, 2023
a10ac26
Merge branch 'main' into guide/data-mgmt/remote-storage-types
jorgeorpinel Jan 24, 2023
c6367b3
Merge branch 'main' into guide/data-mgmt/remote-storage-types
jorgeorpinel Jan 26, 2023
5713674
ref: bring cloud versioning copy edits of import-url
jorgeorpinel Jan 26, 2023
4fec3d2
ref: clarify import-url with cloud versioning
jorgeorpinel Jan 26, 2023
6d5b5fb
ref: updates to import-url --version-aware and
jorgeorpinel Jan 26, 2023
06da52e
ref: add import-url --version aware to Synopsis
jorgeorpinel Jan 26, 2023
e4c1ee6
Restyled by prettier (#4266)
restyled-io[bot] Jan 26, 2023
5586809
ref: updates around worktree updates (cloud versioning)
jorgeorpinel Jan 26, 2023
37478fc
Merge branch 'main' into guide/data-mgmt/remote-storage-types
jorgeorpinel Feb 2, 2023
3de0622
ref: link from `remote` (index) to storage types
jorgeorpinel Feb 2, 2023
60fb652
guide: roll back changes to dvc.yaml `rev` field spec
jorgeorpinel Feb 2, 2023
0e18b27
Update content/docs/command-reference/update.md
Feb 7, 2023
ade5e86
Merge branch 'main' into guide/data-mgmt/remote-storage-types
jorgeorpinel Feb 17, 2023
2cf3f1d
Merge branch 'guide/data-mgmt/remote-storage-types' of github.com:ite…
jorgeorpinel Feb 17, 2023
72948ca
guide: link refs in .dvc file spec
jorgeorpinel Feb 17, 2023
0e15321
Restyled by prettier (#4319)
restyled-io[bot] Feb 17, 2023
8dfa6e7
Update content/docs/command-reference/update.md
jorgeorpinel Feb 17, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/docs/command-reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ multiple projects or users, respectively.
> Note that the `--show-origin` flag can show you where a given config option
> `value` is currently stored.

## Command options (flags)
## Command options/flags
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

- `-u`, `--unset` - remove the specified config option `name` from a config
file. Don't provide a `value` argument when employing this flag.
Expand Down
41 changes: 26 additions & 15 deletions content/docs/command-reference/import-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,11 @@ etc.), and download it to the local project, or make a copy in

```usage
usage: dvc import-url [-h] [-q | -v] [--file <filename>]
[--to-remote] [-r <name>]
[--no-exec | --no-download]
[-j <number>] [--version-aware]
[--desc <text>] [--type <str>]
[--label <str>] [--meta key=value]
url [out]
[--to-remote] [-r <name>]
[--no-exec | --no-download] [-j <number>]
[--desc <text>] [--type <str>] [--label <str>]
[--meta key=value] [--version-aware]
url [out]

positional arguments:
url (See supported URLs in the description.)
Expand Down Expand Up @@ -109,15 +108,22 @@ DVC supports several types of external locations (protocols):
[ETag](https://en.wikipedia.org/wiki/HTTP_ETag#Strong_and_weak_validation) is
necessary to track if the specified URL changed.

DVC also supports capturing
[cloud versioning](/doc/user-guide/data-management/cloud-versioning) information
when importing data from certain cloud storage providers. When the
`--version-aware` option is provided or when the `url` argument includes a
supported cloud versioning ID, DVC will import the specified version of the
given data. When using versioned storage, DVC will always
[pull](/doc/command-reference/pull) the versioned data from its original source
location. Versioned data will also not be [pushed](/doc/command-reference/push)
to remote storage.
DVC also supports capturing [cloud versioning] information from certain cloud
storage providers. When the `--version-aware` option is provided or when the
`url` argument includes a supported cloud versioning ID, DVC will import the
specified version.

[cloud versioning]: /doc/user-guide/data-management/cloud-versioning

<admon type="info">

When using versioned storage, DVC will always [pull] the versioned data from
source. This will not [push] an additional version to remote storage.

[pull]: https://dvc.org/doc/command-reference/pull
[push]: https://dvc.org/doc/command-reference/push

</admon>

| Type | Description | Versioned `url` format example |
| ------- | ---------------------------- | ------------------------------------------------------ |
Expand Down Expand Up @@ -200,6 +206,11 @@ produces a regular stage in `dvc.yaml`.

- `--meta key=value` - custom metadata to add to the data.

- `--version-aware` - capture [cloud versioning] information (supported for
certain cloud storage providers). By default, DVC will automatically do so
only if the `url` contains a valid cloud versioning ID. Otherwsie, with this
flat DVC will import the latest version of the file.

- `-h`, `--help` - prints the usage/help message, and exit.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just noticed that this sentence is wrong hah. Should update everywhere (separate PR) to

Suggested change
- `-h`, `--help` - prints the usage/help message, and exit.
- `-h`, `--help` - print the usage/help message and exit.


- `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no
Expand Down
83 changes: 57 additions & 26 deletions content/docs/command-reference/remote/add.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# remote add

Register a new [DVC remote](/doc/user-guide/data-management/remote-storage).
Add a new `dvc remote` to the <abbr>project</abbr> configuration.

<admon type="tip">

Depending on your storage type, you may also need `dvc remote modify` to provide
credentials and/or configure other remote parameters.
You may also need `dvc remote modify` to provide credentials and/or configure
other remote parameters. See [Remote storage configuration] for more
information.

[remote storage configuration]:
/doc/user-guide/data-management/remote-storage#configuration

</admon>

Expand All @@ -23,41 +27,68 @@ positional arguments:

## Description

This command creates a `remote` section in the <abbr>DVC project</abbr>'s
[config file](/doc/command-reference/config) and optionally assigns a _default
remote_ in the `core` section, if the `--default` option is used (recommended
for the first remote):
Registers an [additional storage] location to save data files (besides the
<abbr>cache</abbr>) and optionally sets it as the `--default` remote. DVC
remotes can point to a cloud storage service, an SSH server, network-attached
storage, or even a directory in the local file system.
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

[additional storage]: /doc/user-guide/data-management/remote-storage

<admon type="tip">

A [default remote] is expected by `dvc push`, `dvc pull`, `dvc status`,
`dvc gc`, and `dvc fetch` unless their `--remote` option is used.

[default remote]: /doc/command-reference/remote/default

</admon>

The remote `name` (required) is used to identify the remote and must be unique.
DVC will determine the [type of remote](#supported-storage-types) based on the
provided `url` (also required), a URL or path for the location.

<admon type="info">

The storage type determines which config parameters you can access via
`dvc remote modify`. Note that the `url` itself can be modified.

</admon>

This command creates a [`remote`] section in the project's [config file]
(`.dvc/config`). The `--default` (`-d`) flag uses the [`core`] config section:

```cli
$ dvc remote add -d temp /tmp/dvcstore
```

```ini
['remote "myremote"']
# .dvc/config
['remote "temp"']
url = /tmp/dvcstore
[core]
remote = myremote
```

> 💡 Default remotes are expected by commands that accept a `-r`/`--remote`
> option (`dvc pull`, `dvc push`, `dvc status`, `dvc gc`, `dvc fetch`) when that
> option is omitted.
[config file]: /doc/command-reference/config
[`remote`]: /doc/command-reference/config#remote
[`core`]: /doc/command-reference/config#core

`name` and `url` are required. The `name` is used to identify the remote and
must be unique for the project.
<admon type="info">

`url` specifies a location to store your data. It can represent a cloud storage
service, an SSH server, network-attached storage, or even a directory in the
local file system (see all the supported remote storage types in the examples
below).
If you [installed DVC] via `pip` and plan to use cloud services as remote
storage, you might need to install these optional dependencies: `[s3]`,
`[azure]`, `[gdrive]`, `[gs]`, `[oss]`, `[ssh]`. Use `[all]` to include them
all. For example:

DVC will determine the [type of remote](#supported-storage-types) based on the
`url` provided. This may affect which parameters you can access later via
`dvc remote modify` (note that the `url` itself can be modified).
```cli
$ pip install "dvc[s3]"
```

[installed dvc]: /doc/install

> If you installed DVC via `pip` and plan to use cloud services as remote
> storage, you might need to install these optional dependencies: `[s3]`,
> `[azure]`, `[gdrive]`, `[gs]`, `[oss]`, `[ssh]`. Alternatively, use `[all]` to
> include them all. The command should look like this: `pip install "dvc[s3]"`.
> (This example installs `boto3` library along with DVC to support S3 storage.)
</admon>

## Options
## Command options/flags

- `--system` - save remote configuration to the system config file (e.g.
`/etc/xdg/dvc/config`) instead of `.dvc/config`.
Expand Down
3 changes: 1 addition & 2 deletions content/docs/command-reference/remote/default.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# remote default

Set/unset the default
[remote storage](/doc/user-guide/data-management/remote-storage).
Set/unset the default `dvc remote`.

## Synopsis

Expand Down
52 changes: 14 additions & 38 deletions content/docs/command-reference/remote/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,49 +26,25 @@ positional arguments:

## Description

What is data remote?
DVC remotes are distributed storage locations for your data sets and ML models
(similar to Git remotes, but for <abbr>cached</abbr> assets). This optional
feature is typically used to share or back up copies of all or some of your
data. Several types are supported: Amazon S3, Google Drive, SSH, HTTP, local
file systems, [among others].

The same way as GitHub provides storage hosting for Git repositories, DVC
remotes provide a location to store and share data and models. You can pull data
assets created by colleagues from DVC remotes without spending time and
resources to build or process them locally. Remote storage can also save space
on your local environment – DVC can [fetch](/doc/command-reference/fetch) into
the <abbr>cache directory</abbr> only the data you need for a specific
branch/commit.
[among others]:
/doc/user-guide/data-management/remote-storage#supported-storage-types

Using DVC with remote storage is optional. DVC commands use the local cache
(usually in dir `.dvc/cache`) as data storage by default. This enables the main
DVC usage scenarios out of the box.
<admon icon="book">

DVC supports several types of remote storage: local file system, SSH, Amazon S3,
Google Cloud Storage, HTTP, HDFS, among others. Refer to `dvc remote add` for
more details.

<admon type="info">

If you installed DVC via `pip` and plan to use cloud services as remote storage,
you might need to install these optional dependencies: `[s3]`, `[azure]`,
`[gdrive]`, `[gs]`, `[oss]`, `[ssh]`. Alternatively, use `[all]` to include them
all. The command should look like this: `pip install "dvc[s3]"`. (This example
installs `boto3` library along with DVC to support S3 storage.)

</admon>

### Managing remote storage

<admon type="info">

For an intro on DVC remote usage see [Storing and sharing data].

[storing and sharing data]:
/doc/start/data-management/data-versioning#storing-and-sharing
Learn more about [remote storage].

</admon>

`dvc remote` subcommands read or modify DVC [config files], where DVC remotes
are set up. Alternatively, `dvc config` can be used, or the config files can be
edited manually.
`dvc remote` subcommands read or modify DVC [config files] (`.dvc/config` by
default). Alternatively, the config files can be edited manually.

[types of storage]: /doc/command-reference/remote/add#supported-storage-types
[config files]: /doc/command-reference/config

## Options
Expand All @@ -88,8 +64,8 @@ edited manually.

While the term may seem contradictory, it doesn't have to be. The "local" part
refers to the type of location where the storage is: another directory in the
same file system. "Remote" is how we call storage for <abbr>DVC projects</abbr>.
It's essentially a local backup for data tracked by DVC.
same file system. "Remote" is what we call storage for <abbr>DVC
projects</abbr>. It's essentially a local backup for data tracked by DVC.

</details>

Expand Down
11 changes: 6 additions & 5 deletions content/docs/command-reference/remote/list.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# remote list

List all available
[DVC remotes](/doc/user-guide/data-management/remote-storage).
List all `dvc remote` names and locations.

## Synopsis

Expand All @@ -12,9 +11,11 @@ usage: dvc remote list [-h] [--global | --system | --project | --local]

## Description

Reads DVC configuration files and prints the list of available remotes,
including names and URLs. Remotes are read from the system, global, project, and
local config files (in that order).
Reads [DVC configuration] and prints the list of available remotes, including
their names and URLs/paths. Remotes are read from the system, global, project,
and local config files (in that order).

[dvc configuration]: /doc/command-reference/config#remote

## Options

Expand Down
53 changes: 41 additions & 12 deletions content/docs/command-reference/remote/modify.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# remote modify

Configure a [DVC remote](/doc/user-guide/data-management/remote-storage).
Configure an existing `dvc remote`.

<admon type="tip">

This command is commonly needed after `dvc remote add` or `dvc remote default`
to set up credentials or for other customizations specific to the
[storage type](#available-parameters-per-storage-type).
This command is commonly needed after `dvc remote add` to set up credentials or
other customizations. See [Remote storage configuration] for more information.

[remote storage configuration]:
/doc/user-guide/data-management/remote-storage#configuration

</admon>

Expand All @@ -25,16 +27,43 @@ positional arguments:

## Description

Remote `name` and `option` name are required. Config option names are specific
to the remote type. See `dvc remote add` and
[Available parameters](#available-parameters-per-storage-type) below for a list
of remote storage types.
The DVC remote's `name` and a valid `option` to modify are required. Remote
options or [config parameters](#available-parameters-per-storage-type) are
specific to the storage type and typically require a `value` as well.
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

This command updates a [`remote`] section in the [config file] (`.dvc/config`):

```cli
$ dvc remote modify temp url /mnt/c/tmp/dvcstore
```

```git
# .dvc/config
['remote "temp"']
- url = /tmp/dvcstore
+ url = /mnt/c/tmp/dvcstore
```

<admon type="info">

If you [installed DVC] via `pip` and plan to use cloud services as remote
storage, you might need to install these optional dependencies: `[s3]`,
`[azure]`, `[gdrive]`, `[gs]`, `[oss]`, `[ssh]`. Use `[all]` to include them
all. For example:

```cli
$ pip install "dvc[s3]"
```

[installed dvc]: /doc/install

</admon>

This command modifies a `remote` section in the project's
[config file](/doc/command-reference/config). Alternatively, `dvc config` or
manual editing could be used to change the configuration.
Comment on lines -34 to -35
Copy link
Contributor Author

@jorgeorpinel jorgeorpinel Oct 24, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dvc config ... could be used to change the configuration

Is this still a recommended alternative? I'm not mentioning it for now (to keep things simple and bc/ I don't know any advantages of it). Readers can still figure this out from reading the dvc config ref, I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This Q is pending, though probably minor ☝🏼

[config file]: /doc/command-reference/config
[`remote`]: /doc/command-reference/config#remote
[`core`]: /doc/command-reference/config#core

## Command options (flags)
## Command options/flags

- `-u`, `--unset` - remove the configuration `option` from a config file. Don't
provide a `value` argument when employing this flag.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/remote/remove.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# remote remove

Remove a [DVC remote](/doc/user-guide/data-management/remote-storage).
Remove a `dvc remote`.

<admon type="info">

Expand Down
2 changes: 1 addition & 1 deletion content/docs/command-reference/remote/rename.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# remote rename

Rename a [DVC remote](/doc/user-guide/data-management/remote-storage).
Rename a `dvc remote`.

<admon type="info">

Expand Down
Loading