Authentication examples for Azure Blob Storage #2634
Conversation
Added some examples how to remoge modify dvc for various azure blob storage authentication scenarios.
shcheklein
requested review from
jorgeorpinel and
isidentical
and removed request for
jorgeorpinel
There was a problem hiding this comment.
Thanks @meierale ! I have a few questions on possibly unrelated/unnecessary changes for now (@isidentical will take a look at the examples when possible).
minor adjustments due to feedback
| $ dvc remote add -d myremote azure://mycontainer/object | ||
| $ dvc remote modify --local myremote connection_string 'storageaccountaccesskeyconnectionstring' | ||
| $ dvc remote push |
There was a problem hiding this comment.
Wait... We already have these examples under each config option. E.g.
The hope is that the remote add and push/pull commands are obvious to people reading this section.
There was a problem hiding this comment.
My point (and thus I included the dvc remote push command) is that I wanted to provide examples of correctly working combinations of authentication settings.
The already existing examples only show what parameters can be added, but not in which way they should be combined.
There was a problem hiding this comment.
not in which way they should be combined
The ways in which they should be combined is there, pretty close to the beginning of this section:
|
@meierale thanks a lot for this contribution. I'm not sure what information we're adding though. Full usage examples, I guess? Was it pretty hard to put together If we are to keep these I would definitely move to a proper example after https://dvc.org/doc/command-reference/remote/modify#example-customize-an-s3-remote. But at the moment I incline to wait as it should be addressed along with #1859 |
|
My 2cs - we should merge this. These examples look very useful, since Azure is the most convoluted provider of those we support. It looks like a good contribution. If/when we have a full page we can move it. At the moment, this information probably is even more useful than everything we had before for Azure :) |
change L347 back to how it originally was.
make `az cli` credential example the first example, add note about contributor role.
|
@meierale thanks for the PR @jorgeorpinel any concerns merging this :)? |
jorgeorpinel
requested review from
jorgeorpinel
and removed request for
jorgeorpinel
Yes @shcheklein , the Azure section is long already and with these examples it seems unreadable to me (I checked on the dev app locally). They're also somewhat repetitive and incomplete. I understand the value of having the combinations somewhere, but the ref of |
There was a problem hiding this comment.
For now I moved this to an actual example in this same page and copy edited, but I still think #1859 will take care of this properly... Feel free to merge though. Thanks!
|
Can we add a link to these examples from the add/modify Azure sections ? |
|
Linked from Thanks again @meierale ! |
Added some examples how to remote modify dvc for various azure blob storage authentication scenarios.
❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.
🐛 Please make sure to mention
Fix #issue(if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.Please choose to allow us to edit your branch when creating the PR.
Thank you for the contribution - we'll try to review it as soon as possible. 🙏