Merge pull request #1122 from jtpio/ovh-registry-docs

Author: betatim

doc/zero-to-binderhub/ovh/generate_id_details.png

@@ -116,6 +116,23 @@ where:
 * `<SERVICE_PRINCIPAL_ID>` is the AppID of the Service Principal with AcrPush role assignment,
 * `<SERVICE_PRINCIPAL_PASSWORD>` is the password for the Service Principal.
 
+If you are using OVH Container Registry
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Update `secret.yaml` to include the following::
+
+    registry:
+      url: https://<hash>.<region>.container-registry.ovh.net
+      username: <harbor-username>
+      password: <harbor-password>
+
+where:
+
+* `<hash>` is the hash of the registry
+* `<region>` is the region of the registry
+* `<harbor-username>` is the Harbor username
+* `<harbor-password>` is the Harbor password
+
 Create ``config.yaml``
 ----------------------
 
@@ -183,6 +200,37 @@ where:
   If this is not provided, you may find BinderHub rebuilds images every launch instead of pulling them from the ACR.
   Suggestions for `<project-name>` could be `ACR_NAME` or the name you give your BinderHub.
 
+If you are using OVH Container Registry
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you want your BinderHub to push and pull images from an OVH Container Registry, then the `config.yaml` file will look the following::
+
+    config:
+      BinderHub:
+        use_registry: true
+        image_prefix: <hash>.<region>.container-registry.ovh.net/<prefix>-
+      DockerRegistry:
+        url: https://<hash>.<region>.container-registry.ovh.net
+        token_url: https://<hash>.<region>.container-registry.ovh.net/service/token?service=harbor-registry
+
+where:
+
+* `<hash>` is the hash of the registry
+* `<region>` is the region of the registry
+* `<prefix>` corresponds to the image prefix. If you created a new project called ``myproject`` in the previous section,
+  then ``<prefix>`` should start with ``myproject/``
+
+As an example, the config should look like the following::
+
+    config:
+      BinderHub:
+        use_registry: true
+        image_prefix: abcde.gra7.container-registry.ovh.net/myproject/binder-
+      DockerRegistry:
+        url: https://abcde.gra7.container-registry.ovh.net
+        token_url: https://abcde.gra7.container-registry.ovh.net/service/token?service=harbor-registry
+
+
 If you are using a custom registry
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

doc/zero-to-binderhub/ovh/new_project.png

@@ -7,7 +7,7 @@ BinderHub will build Docker images out of Git repositories, and then push
 them to a Docker registry so that JupyterHub can launch user servers based
 on these images. You can use any registry that
 you like, though this guide covers how to properly configure several popular
-registries. The next step, :doc:`setup-binderhub`, explains how you can 
+registries. The next step, :doc:`setup-binderhub`, explains how you can
 properly configure BinderHub to use one of these registries.
 
 .. _use-gcr:
@@ -137,6 +137,36 @@ where:
        SERVICE_PRINCIPAL_PASSWORD=$(az ad sp create-for-rbac --name <SP_NAME> --role AcrPush --scopes <ACR_ID> --query password --output tsv)
        SERVICE_PRINCIPAL_ID=$(az ad sp show --id http://<SP_NAME> --query appId --output tsv)
 
+Set up the OVH Container Registry
+---------------------------------
+
+To use the OVH Container Registry, log in to the `OVH Control Panel <https://www.ovh.com/manager/public-cloud>`_.
+
+1. Click on **Managed Private Registry**
+
+2. Click on the **Create a private registry** button
+
+3. Select a **Region**, a **Name** for the registry and a **Plan**.
+
+4. Generate the **Harbor identification details** to connect to the registry
+
+.. figure:: ovh/generate_id_details.png
+
+  Generate the identification details to connect to
+  the registry.
+
+5. Then click on **Harbor API** to retrieve the URL of the registry
+
+6. Log in to the Harbor Interface using the identification details, and create a new project:
+
+.. figure:: ovh/new_project.png
+
+  Create a new Harbor project.
+
+7. The name of the project will be used when setting up the registry config in the next section
+
+For more information about these steps, check out the `OVH Documentation <https://docs.ovh.com/gb/en/private-registry/creating-a-private-registry>`_
+
 Next step
 ---------