Skip to content

Commit

Permalink
Add some additional info to help setup process
Browse files Browse the repository at this point in the history
  • Loading branch information
sgibson91 committed Jun 27, 2024
1 parent c7eab22 commit bbc66c3
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/howto/features/binderhub-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -379,20 +379,21 @@ Follow the guide at [](howto:features:imagebuilding-hub:image-registry) of the i
### 2. Configure BinderHub image_prefix

We need to configure BinderHub so that it knows under which prefix to push the images to the registry.
For example, use something like `quay.io/opensci-small-binder/binderhub-ui-`

```yaml
binderhub-service:
config:
BinderHub:
image_prefix: <repository_path>
image_prefix: <registry_url>/<prefix>-
```

### 2. Setup the the credentials needed to push the image to the container registry by the build pods

```yaml
binderhub-service:
buildPodsRegistryCredentials:
# registry server address like https://quay.io or https://us-central1-docker.pkg.dev
# registry server address like https://quay.io (nor org name required) or https://us-central1-docker.pkg.dev
server: <server_address>
# robot account namer or "_json_key" if using grc.io
username: <account_name>
Expand Down
3 changes: 3 additions & 0 deletions docs/howto/features/imagebuilding.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,13 @@ If the hub will be deployed on another cloud provider than GCP, we must setup a

1. Go to https://quay.io/organizations/new/ and create a new organization.
Give it a memorable name like `<cluster-name>-<hub-name>`.
1. Set the Organisation Email to `support+quay-<cluster-name>-<hub-name>@2i2c.org`, like `support+quay-opensci-small-binder@2i2c.org`. It will still be delivered to `support@2i2c.org` but functions as a unique username identifer. This is called [subaddressing](https://en.wikipedia.org/wiki/Email_address#Subaddressing).
1. Select the free "Open Source" plan and create the organisation.
1. Make sure this new organization is selected, by going to https://quay.io/organization/`<new-org-name>`.
1. Select the 'Robot Accounts' option on the left menu.
1. Click 'Create Robot account', give it a memorable name (such as `image_builder`) and click 'Create'.
1. In the next screen, don't select any of the existing repositories, as we need this robot account to have enough permissions to push **any** new repository under the organization, so permissions to existing repositories is not needed.
(You likely will not see this "next screen" for new organisations which do not have any repositories yet.)
1. Once done, click the name of the robot account again. This will give you its username and password.
```{important}
Store these somewhere safe as we will need them in a following step.
Expand Down

0 comments on commit bbc66c3

Please sign in to comment.