Skip to content

Commit

Permalink
cmd: remote copy edits
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel committed Aug 6, 2020
1 parent 6fb0c77 commit c9df0b1
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 39 deletions.
3 changes: 2 additions & 1 deletion content/docs/command-reference/remote/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,8 @@ For example:

```dvc
$ dvc remote add -d myremote s3://mybucket/path/to/dir
$ dvc remote modify myremote endpointurl https://object-storage.example.com
$ dvc remote modify myremote endpointurl \
https://object-storage.example.com
```

> See `dvc remote modify` for a full list of S3 API parameters.
Expand Down
86 changes: 48 additions & 38 deletions content/docs/command-reference/remote/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,19 +90,19 @@ these settings, you could use the following options:
$ dvc remote modify myremote region us-east-2
```

- `profile` - credentials profile name to use to access S3:
- `profile` - credentials profile name to access S3:

```dvc
$ dvc remote modify myremote profile myprofile
```

- `credentialpath` - credentials path to use to access S3:
- `credentialpath` - credentials path to access S3:

```dvc
$ dvc remote modify myremote credentialpath /path/to/my/creds
```

- `endpointurl` - endpoint URL to use to access S3:
- `endpointurl` - endpoint URL to access S3:

```dvc
$ dvc remote modify myremote endpointurl https://myendpoint.com
Expand Down Expand Up @@ -168,29 +168,33 @@ these settings, you could use the following options:
for specific grantees\*\*. Grantee can read object and its metadata.

```dvc
$ dvc remote modify myremote grant_read id=aws-canonical-user-id,id=another-aws-canonical-user-id
$ dvc remote modify myremote grant_read \
id=aws-canonical-user-id,id=another-aws-canonical-user-id
```

- `grant_read_acp`\* - grants `READ_ACP` permissions at object level access
control list for specific grantees\*\*. Grantee can read the object's ACP.

```dvc
$ dvc remote modify myremote grant_read_acp id=aws-canonical-user-id,id=another-aws-canonical-user-id
$ dvc remote modify myremote grant_read_acp \
id=aws-canonical-user-id,id=another-aws-canonical-user-id
```

- `grant_write_acp`\* - grants `WRITE_ACP` permissions at object level access
control list for specific grantees\*\*. Grantee can modify the object's ACP.

```dvc
$ dvc remote modify myremote grant_write_acp id=aws-canonical-user-id,id=another-aws-canonical-user-id
$ dvc remote modify myremote grant_write_acp \
id=aws-canonical-user-id,id=another-aws-canonical-user-id
```

- `grant_full_control`\* - grants `FULL_CONTROL` permissions at object level
access control list for specific grantees\*\*. Equivalent of grant_read +
grant_read_acp + grant_write_acp

```dvc
$ dvc remote modify myremote grant_full_control id=aws-canonical-user-id,id=another-aws-canonical-user-id
$ dvc remote modify myremote grant_full_control \
id=aws-canonical-user-id,id=another-aws-canonical-user-id
```

> \* `grant_read`, `grant_read_acp`, `grant_write_acp` and
Expand Down Expand Up @@ -221,7 +225,8 @@ For example:

```dvc
$ dvc remote add myremote s3://path/to/dir
$ dvc remote modify myremote endpointurl https://object-storage.example.com
$ dvc remote modify myremote endpointurl \
https://object-storage.example.com
```

S3 remotes can also be configured entirely via environment variables:
Expand Down Expand Up @@ -250,7 +255,8 @@ For more information about the variables DVC supports, please visit
- `connection_string` - connection string.

```dvc
$ dvc remote modify --local myremote connection_string "my-connection-string"
$ dvc remote modify --local myremote connection_string \
"my-connection-string"
```

> The connection string contains sensitive user info. Therefore, it's safer to
Expand All @@ -274,8 +280,8 @@ a full guide on using Google Drive as DVC remote storage.
[possible formats](/doc/user-guide/setup-google-drive-remote#url-format).

```dvc
$ dvc remote modify myremote \
url gdrive://0AIac4JZqHhKmUk9PDA/dvcstore
$ dvc remote modify myremote url \
gdrive://0AIac4JZqHhKmUk9PDA/dvcstore
```

- `gdrive_client_id` - Client ID for authentication with OAuth 2.0 when using a
Expand Down Expand Up @@ -415,13 +421,13 @@ more information.
$ dvc remote modify myremote oss_endpoint endpoint
```

- `oss_key_id` - OSS key ID to use to access a remote.
- `oss_key_id` - OSS key ID to access the remote.

```dvc
$ dvc remote modify myremote --local oss_key_id my-key-id
```

- `oss_key_secret` - OSS secret key for authorizing access into a remote.
- `oss_key_secret` - OSS secret key for authorizing access into the remote.

```dvc
$ dvc remote modify myremote --local oss_key_secret my-key-secret
Expand All @@ -440,41 +446,43 @@ more information.
- `url` - remote location URL.

```dvc
$ dvc remote modify myremote url ssh://[email protected]:1234/path/to/remote
$ dvc remote modify myremote url \
ssh://[email protected]:1234/absolute/path
```

- `user` - username to use to access a remote. The order in which dvc searches
for username:

1. `user` specified in one of the dvc configs;
2. `user` specified in the url(e.g. `ssh://[email protected]/path`);
3. `user` specified in `~/.ssh/config` for remote host;
4. current user;
- `user` - username to access the remote.

```dvc
$ dvc remote modify --local myremote user myuser
```

- `port` - port to use to access a remote. The order in which dvc searches for
port:
The order in which DVC picks the username:

1. `port` specified in one of the dvc configs;
2. `port` specified in the url(e.g. `ssh://example.com:1234/path`);
3. `port` specified in `~/.ssh/config` for remote host;
4. default ssh port 22;
1. `user` parameter set with this command (found in `.dvc/config`);
2. User defined in the URL (e.g. `ssh://[email protected]/path`);
3. User defined in `~/.ssh/config` for this host (URL);
4. Current user

- `port` - port to access the remote.

```dvc
$ dvc remote modify myremote port 2222
```

- `keyfile` - path to private key to use to access a remote.
The order in which DVC decide the port number:

1. `port` parameter set with this command (found in `.dvc/config`);
2. Port defined in the URL (e.g. `ssh://example.com:1234/path`);
3. Port defined in `~/.ssh/config` for this host (URL);
4. Default SSH port 22

- `keyfile` - path to private key to access the remote.

```dvc
$ dvc remote modify myremote keyfile /path/to/keyfile
```

- `password` - a private key passphrase or a password to use to use when
accessing a remote.
- `password` - a private key passphrase or a password to access the remote.

```dvc
$ dvc remote modify --local myremote password mypassword
Expand All @@ -484,8 +492,8 @@ more information.
> safer to add them with the `--local` option, so they're written to a
> Git-ignored config file.
- `ask_password` - ask for a private key passphrase or a password to use when
accessing a remote.
- `ask_password` - ask for a private key passphrase or a password to access the
remote.

```dvc
$ dvc remote modify myremote ask_password true
Expand All @@ -509,7 +517,7 @@ more information.

### Click for HDFS

- `user` - username to use to access a remote.
- `user` - username to access the remote.

```dvc
$ dvc remote modify --local myremote user myuser
Expand All @@ -524,7 +532,7 @@ more information.

### Click for HTTP

- `auth` - authentication method to use when accessing a remote. The accepted
- `auth` - authentication method to use when accessing the remote. The accepted
values are:

- `basic` -
Expand All @@ -551,15 +559,17 @@ more information.
```

- `user` - username to use when the `auth` parameter is set to `basic` or
`digest`. The order in which DVC searches for username:

1. `user` specified in one of the DVC configs;
2. `user` specified in the url(e.g. `http://[email protected]/path`);
`digest`.

```dvc
$ dvc remote modify --local myremote user myuser
```

The order in which DVC picks the username:

1. `user` parameter set with this command (found in `.dvc/config`);
2. User defined in the URL (e.g. `http://[email protected]/path`);

- `password` - password to use for any `auth` method.

```dvc
Expand Down

0 comments on commit c9df0b1

Please sign in to comment.