Ghcr.io docker HTTP API

[MJRichardson]

Hi,

Does the GitHub container registry (ghcr.io) support the docker V2 HTTP API’s?

Specifically, does it support listing repositories and tags (https://docs.docker.com/registry/spec/api/#listing-repositories)?

[christian-korneck]

I guess the answer is “yes”. I’m assuming this from:

I can list the tags of a ghcr.io repo with skopeo:

docker run --rm quay.io/skopeo/stable list-tags docker://ghcr.io/my-github-user/hello-world
{
    "Repository": "ghcr.io/my-github-user/hello-world",
    "Tags": [
        "latest"
    ]
}

and when I run it with --debug there are clues that it’s indeed using the v2 endpoint:

level=debug msg="GET https://ghcr.io/v2/my-github-user/hello-world/manifests/latest"

[clarkbw]

/v2/_catalog support is in our backlog! It hasn’t arrived yet but we know we need it.

[MJRichardson]

Thanks for the confirmation.

For context (and just in case it helps nudge it up the priority list), we make Octopus Deploy, and when integrating with container registries we use the HTTP catalog API to list the available repositories and tags in the UI.

[clarkbw]

Thanks for that context! It does help.

Are there any other features / APIs that would be useful?

[jgamblin]

I know I am not the OP but here is what the DockerHub API provides now and it would be useful to have parity.

https://hub.docker.com/v2/repositories/jgamblin/tiny-tor/

[nohaapav]

I guess it will be much more easy to publish graphql v4 api to list all repositories in registry related to user or organization than enabling /_catalog api which list basically all images. But both can do the job here.

[Nicceboy]

It would be really useful to modify README and package descriptions through API. Not every package could be linked to single GitHub repository, or the repository might have multiple packages.

Also, if the implementation of repository listing shows last modified time or Manifest hash, that would be neat - based on the list I could see which packages have changed since querying API last time.

[minor-fixes]

Is there a way to list all ghcr containers in an organization?

We would use the _catalog endpoint, but as mentioned above it is not implemented.

GraphQL can be used to list images on the old Docker packages, but this does not include ghcr images as per this question.

The Packages REST API can supposedly be used to interact with ghcr images, but only if you know the image name already!

How can one programmatically list all ghcr image names in an org?

[lioskaderon]

@clarkbw is there any update regarding the v2 support?

Thanks

[gumpt]

Have the same question, would love to know if/when this is planned.

[elasticdotventures]

@clarkbw FYI - this is blocking vscode issue #869

  <a href="https://github.com/microsoft/vscode-docker/issues/869" target="_blank" rel="noopener nofollow ugc">github.com/microsoft/vscode-docker</a>

Support third-party registries

<div class="github-info">
  <div class="date">
    opened <span class="discourse-local-date" data-format="ll" data-date="2019-03-27" data-time="22:42:59" data-timezone="UTC">10:42PM - 27 Mar 19 UTC</span>
  </div>


  <div class="user">
    <a href="https://github.com/StephenWeatherford" target="_blank" rel="noopener nofollow ugc">
      <img alt="StephenWeatherford" src="https://user-images.githubusercontent.com/35611074/181096734-c6cd5abf-ab5d-4734-ac7b-bb59ff90900a.png" class="onebox-avatar-inline" width="20" height="20">
      StephenWeatherford
    </a>
  </div>
</div>

<div class="labels">
    <span style="display:inline-block;margin-top:2px;background-color: #B8B8B8;padding: 2px;border-radius: 4px;color: #fff;margin-left: 3px;">
      enhancement
    </span>
    <span style="display:inline-block;margin-top:2px;background-color: #B8B8B8;padding: 2px;border-radius: 4px;color: #fff;margin-left: 3px;">
      registries
    </span>
</div>

Specifically requested (but goal is generic support), in no particular order:

…
Open:

• goharbor.io (see #878, Pull Request - Switch Base and Compare #3449)
• ECR (Amazon, see #3202)
• GCR (Google) (+3 see #394, New discussion link leads to 404 if user is logged out #2890)
• quay.io (+4 see #390)
• DTR (Enterprise Docker trusted registry) (see #3325)
• Cloudsmith (see #1887)
• Aliyun (see #1964)
• Portus (see #2735)
• Digital Ocean (see #2879)

Blocked on no/partial Registry V2 support:

• GitHub (see #1525, #1938)
• GitLab self-hosted (+5 see #1832, #2457, #2735, Possible Typo in param 'energy_kWhdoy' #3119, Notification says “requested your review” even though the request was not for me #3271)
• harbor.korporate.org (see #1927)
• GitLab Groups (see #1970)

Done:

• DockerHub

• Azure

• GitLab (+25-ish see #162)

• Generic V2 registry (+2)

Seems the ball has been dropped, is there an open issue for this backlog feature request?

[tclose]

A fix to his issue is would be +1 from me too

[cpotter302]

Are there any updates on this? I am currently working on a use case to download blobs from third party registries including ghcr.io

[mirkobrombin]

Updates on this?

[dtrunk90]

I can't use ghcr.io on my Synology DSM Container Manager as a registry due to this missing feature. I had to run the containers manually through SSH. As a result I'm not getting notified about image updates.

[anuragagrawal0430]

Is anyone working on this backlog item?

[Denney-tech]

Would love to see an update on this backlog item.

[BROngineer]

Any update on this feature?