Skip to content

ECIR (Container Image Registry) Documentation#308

Merged
agngrant merged 5 commits intomainfrom
container-reg
Mar 10, 2026
Merged

ECIR (Container Image Registry) Documentation#308
agngrant merged 5 commits intomainfrom
container-reg

Conversation

@agngrant
Copy link
Copy Markdown
Collaborator

EIDF Documentation Pull Request

Description

Public version of the ECIR documentation added under the code collaboration heading in data services beside gitlab.

This contains work from A Grant, B Carpenter and suggestions from A Jackson.

This is the initial documentation to allow users to start with the Harbor registry in EIDF.

Type of change

Please delete options that are not relevant.

  • New Documentation

What has to be reviewed

  • docs/services/registry/faq.md
  • docs/services/registry/index.md
  • docs/services/registry/projects.md
  • docs/services/registry/working-with.md

Checklist

  • Documentation follows the project style guidelines
  • Ensure Contact details contain Service Emails and Numbers
  • Self-review of documentation using mkdocs on local system
  • Spellcheck has been performed
  • Pre-commit has been run and passed

…fork and work from Ben Carpenter and suggestions for A Jackson.
@agngrant agngrant self-assigned this Feb 11, 2026
@agngrant
Copy link
Copy Markdown
Collaborator Author

Updated to include some of B Carpenter additional updates.

Copy link
Copy Markdown
Contributor

@BenjaminCarpenter480 BenjaminCarpenter480 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me just some minor points for us to fix. I think worth another check from someone else as I have become quite familiar with a lot of the terms though/

Comment thread docs/services/registry/index.md
Comment thread docs/services/registry/projects.md Outdated
Comment thread docs/services/registry/working-with.md Outdated
Comment thread docs/services/registry/working-with.md Outdated
…projects with a bit making different between types of project and working with to update robot section with coming soon notice
Copy link
Copy Markdown
Contributor

@BenjaminCarpenter480 BenjaminCarpenter480 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me, minor typo to be fixed

Comment thread docs/services/registry/index.md Outdated
@agngrant agngrant requested a review from karacolada February 18, 2026 10:33

User tokens can be accessed from the User Profile from the dropdown under your Username at the top right hand corner of the page. These will be needed to log into the registry from Docker and other container services.

![UserProfile](../../images/registry/userprofile.png){: class="border-img"}
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't seem to be rendering quite right - at least not on GitHub, may be different in EIDF docs later which I'm less familiar with!

Image

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Occurs a few times throughout all docs - I take this to mean this works just fine in the official docs pages.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is fixed when it is served via rendered pages with the Github action or via mkdocs.

Comment thread docs/services/registry/index.md Outdated

ECIR hosts public cache projects for commonly used images. If you use an image which is commonly pulled from public repositories, using a cache copy can reduce the impact on public services.

Using ECIR for pulling and storing images should help with quick deployment and access control of images for projects. Reducing overhead of EIDF Services pulling repeatedly from external registries.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

images for projects, reducing overhead instead? Or just This reduces overhead ....

Comment thread docs/services/registry/projects.md Outdated
* Nvidia NGC Registry [https://nvcr.io](https://catalog.ngc.nvidia.com/) - Project nvidia-cache
* Quay.io [https://quay.io](http://quay.io) - Project quay-cache

To use a cache project, the ECIR address and the project name should be pre-pending the name of the image, for example to pull the image, `nvidia/pytorch:25.05-py3` from the Nvidia (NVCR.io) registry, you would use:
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this mean if I want to use an image from NVCR, instead of using docker pull nvcr.io/image_name I should pull from docker pull registry.eidf.ac.uk/nvidia-cache/image_name? Does that automatically add the NVCR image into the cache? Or does the image need to be pulled from NVCR, that adds it to the cache, and in the future I could pull from nvidia-cache?
It's not entirely clear to me how images get added to the cache, maybe this could be spelled out more clearly?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added automatic into summary and what to prepend images with to use the proxies.

Comment thread docs/services/registry/faq.md Outdated
![NoSBOMOutputReport](../../images/registry/nosbom.png){: class="border-img"}
*Missing SBOM Output Report*

Then you will have to click the folder next to the artifact name.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

folder icon?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added wording

Copy link
Copy Markdown
Contributor

@BenjaminCarpenter480 BenjaminCarpenter480 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me, addresses problems suggested!

@agngrant agngrant merged commit 7495a4b into main Mar 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants