[MRG] Add instructions for setting up an Azure Container Registry #878
Conversation
sgibson91
changed the title
doc/setup-binderhub.rst
Outdated
| where: | ||
|
|
||
| * `<ACR_NAME>` is the name you gave to your ACR, | ||
| * `<project-name>` is an arbitrary name that is required due to BinderHub's hard dependency on the `gcr.io` image structure above. |
There was a problem hiding this comment.
Can we replace "hard dependency" with "assumes that the image_prefix contains an extra level for the project name". We could fix this after all but so far haven't gotten round to it.
Do you think it would help people if we made a recommendation here as to what to use as a name? My recommendation would be to reuse <ACR_NAME>.
There was a problem hiding this comment.
Changing the language 👍
It's tough to suggest a name as it has to be unique across all of Azure. So I ended up with testregistry1234sgibson91THISHADBETTERWORK before my test registry was deployed into a unique namespace 🙂 This is why I suggested the check-name function in the setup registry docs.
There was a problem hiding this comment.
AH, I didn't mean to suggest a actual name name for ACR_NAME. I was thinking we should say that "a good value to use for <project-name> is the same value as you use for your <ACR_PROJECT>".
There was a problem hiding this comment.
Ah, I see! Yeah that would work. I've personally gone with the name I gave to the BinderHub, so if there's multiple Hubs attached, you can see what came from where.
betatim
changed the title
|
Looks excellent to me. I left one comment about "hard dependencies". I didn't try and follow the instructions (no AZR account) but read the commands and didn't spot any obvious typos. |
Summary
This PR will add documentation around setting up and connecting an Azure Container Registry (ACR) to a BinderHub.
fixes #869
Changes Proposed in this PR
doc/setup-registry.rst- Azure command line instructions for creating an ACR, assigning the correct permissions and collecting relevant information have been addeddoc/setup-binderhub.rst- templates forsecret.yamlandconfig.yamlhave been added to parse the information to BinderHubdoc/setup-binderhub.rstto point out the hard dependency on thegcr.ioimage name structure.