Skip to content

Document Artifact Registry usage #1960

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
30 changes: 30 additions & 0 deletions docs/source/zero-to-binderhub/setup-binderhub.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@ need to insert. Note that the first line is not indented at all::
"client_x509_cert_url": "<REPLACE>"
}

If you are using Artifact Registry
~~~~~~~~~~~~~~~~~~~~~~~~~~~

You do not need to do anything.

If you are using Docker Hub
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -179,6 +184,31 @@ your ``config.yaml`` file::
* Note that in both cases, you should remove the ``<`` and ``>`` symbols,
they are simply placeholders in the code above.

If you are using Artifact Registry
~~~~~~~~~~~~~~~~~~~~~~~~~~~

To configure BinderHub to use Artifact Registry, add the following to your `config.yaml` file::

config:
BinderHub:
use_registry: true
image_prefix: <region>-docker.pkg.dev/<google-project-id>/<prefix>-
registry_class: "binderhub.registry.GoogleArtifactRegistry"
DockerRegistry:
url: "https://<region>-docker.pkg.dev"

.. note::

* ``<region>`` This is the region of the Artifact Registry repository, such
as ``us-central1``.
* ``<google-project-id>`` This is the project *ID*, which may be different
from the project *name*.
* ``<prefix>`` can be any string, and will be prepended to image names. We
recommend something descriptive such as ``binder-dev-`` or ``binder-prod-``
(ending with a `-` is useful).
* Note that in all cases, you should remove the ``<`` and ``>`` symbols,
they are simply placeholders in the code above.

If you are using Docker Hub
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down