Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/estesp/mquery
Multi-platform (manifest list/OCI index) registry image query utility
https://github.com/estesp/mquery
docker lambda-functions manifest-lists multi-platform oci-image
Last synced: 13 days ago
JSON representation
Multi-platform (manifest list/OCI index) registry image query utility
- Host: GitHub
- URL: https://github.com/estesp/mquery
- Owner: estesp
- License: apache-2.0
- Created: 2017-09-18T18:51:08.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-08-09T21:27:44.000Z (3 months ago)
- Last Synced: 2024-10-12T18:56:58.739Z (27 days ago)
- Topics: docker, lambda-functions, manifest-lists, multi-platform, oci-image
- Language: Go
- Homepage:
- Size: 8.01 MB
- Stars: 81
- Watchers: 5
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - estesp/mquery - Multi-platform (manifest list/OCI index) registry image query utility (docker)
README
# mquery
A simple utility and serverless-based backend for querying Docker v2 & OCI v1 container images
and reporting on "manifest list"/OCI "index" multi-platform image support.
## About
This project uses [AWS Lambda](https://aws.amazon.com/lambda/) as a backend, in concert
with the [manifest-tool](https://github.com/estesp/manifest-tool) inspect API capability
to easily report on the status of whether an image is a manifest list/OCI index entry in a
registry, and if so, what platforms are supported by the image.
## Usage
You can use the public endpoint with `curl` and JSON formatting tools to query images directly.
See the next section for a tool which performs this for you and provides a simple text output.
This tool is published as a multi-platform image on DockerHub as `mplatform/mquery`; for example
you can look up the `mplatform/mquery:latest` image as follows:
```
$ docker run --rm mplatform/mquery mplatform/mquery:latest
Image: mplatform/mquery:latest (digest: sha256:d0989420b6f0d2b929fd9355f15c767f62d0e9a72cdf999d1eb16e6073782c71)
* Manifest List: Yes (Image type: application/vnd.docker.distribution.manifest.list.v2+json)
* Supported platforms:
- linux/ppc64le
- linux/amd64
- linux/386
- linux/s390x
- linux/riscv64
- linux/arm64/v8
- linux/arm/v7
- linux/arm/v6
- windows/amd64:10.0.17763.2300
- windows/amd64:10.0.14393.4770
```
#### Using the `mquery` tool
This project also includes a tool for querying the Lambda API Gateway-fronted endpoint with
a simple/readable output format for showing the list of platforms supported by a specific
image. You can build the tool yourself using the `Makefile`, or you can use a pre-packaged
multi-platform image on DockerHub as shown in the section above.
This Go program requires the [github.com/dghubble/sling](https://github.com/dghubble/sling) and
[github.com/opencontainers/image-spec/specs-go/v1](https://github.com/opencontainers/image-spec) packages.
You can add these to your Go development environment with:
```
$ go get -u github.com/dghubble/sling
$ go get -u github.com/opencontainers/image-spec/specs-go/v1
```
## References
More information about manifest lists and multi-platform image support is available in these blog posts:
- [DockerHub Official Images Go Multi-platform!](https://integratedcode.us/2017/09/13/dockerhub-official-images-go-multi-platform/) - 13 Sep 2017
- [[Docker Blog] Docker Official Images are now Multi-platform](https://blog.docker.com/2017/09/docker-official-images-now-multi-platform/) - 19 Sep 2017
- [A big step towards multi-platform Docker images](https://integratedcode.us/2016/04/22/a-step-towards-multi-platform-docker-images/) - 22 April 2016
Also see the [manifest-tool project](https://github.com/estesp/manifest-tool) for an easy to use tool
for assembling and pushing manifest lists and OCI index images.
## License
This project is licensed under the Apache Public License, v2.0.