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.

Sign up for GitHub

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

S3 access_key_id & secret_access_key args #1589

Merged
merged 10 commits into from
Jul 20, 2020
Merged

S3 access_key_id & secret_access_key args #1589

Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2d9dc4f
S3 access_key_id & secret_access_key args
farizrahman4u Jul 18, 2020
e0bc286
Update content/docs/command-reference/remote/modify.md
jorgeorpinel Jul 18, 2020
270010c
Update content/docs/command-reference/remote/modify.md
farizrahman4u Jul 19, 2020
747f712
Update content/docs/command-reference/remote/modify.md
farizrahman4u Jul 19, 2020
9af97ca
ws fix
farizrahman4u Jul 19, 2020
1b7e279
better explanation
farizrahman4u Jul 19, 2020
0dfe154
ws fix
farizrahman4u Jul 19, 2020
56611c6
Update content/docs/command-reference/remote/modify.md
jorgeorpinel Jul 19, 2020
3d5fc40
Update content/docs/command-reference/remote/modify.md
jorgeorpinel Jul 20, 2020
bdc961d
Update content/docs/command-reference/remote/modify.md
jorgeorpinel Jul 20, 2020
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
14 changes: 14 additions & 0 deletions content/docs/command-reference/remote/modify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,20 @@ these settings, you could use the following options:
$ dvc remote modify myremote endpointurl https://myendpoint.com
```

- `access_key_id` - (optional) AWS Access Key ID. Overrides credentials from
`credentialpath`:

```dvc
$ dvc remote modify myremote access_key_id my-access-key-id
```

- `secret_access_key` - (optional) AWS Secret Access Key. Overrides credentials
from `credentialpath`:
Copy link
Contributor

Choose a reason for hiding this comment

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

But actually... All of these settings are optional, even credentialpath. So why/when does credentialpath need to be overridden?

From the section's description: "To override some of these settings, you could use the following options".

Copy link
Contributor

@jorgeorpinel jorgeorpinel Jul 19, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Are these new ones just an alternative to credentialpath?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

iterative/dvc#4175

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, all of these are optional except for the url. You can override default credentialpath (~/.aws/credentials) when you want to use a different creds file.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks, I get it. My questions are geared towards improving the explanation for the users.

So maybe credentialpath should state it is the default AWS credentials file if omitted, or something like this? Another option is to say these new options can be used "instead of credentialpath" (and not call them optional). The way they're described now may be confusing.

This comment was marked as resolved.

Sign in to view

Copy link
Contributor

Choose a reason for hiding this comment

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

These config options will override not only what is in credentialpath but also what is in the env or boto3-specific config, so the hierarchy is more complex and, ideally, it should be described (a note about us using boto3 and a reference to https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html might suffice) once for the whole s3-related section. We could create a ticket for that for later, but for now just say that these newly added options are optional.

Copy link
Contributor

@jorgeorpinel jorgeorpinel Jul 20, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

We could create a ticket for that for later, but for now just say that these newly added options are optional.

Sure, feel free to open the ticket. Seems like a note we should have... For now I applied my suggestion and merged this. It does already imply all these settings are optional at the beginning of the section, and per the nature of dvc remote modify.


```dvc
$ dvc remote modify myremote secret_access_key my-secret_access_key
```

- `url` - remote location URL
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

```dvc
Expand Down