Merge pull request #64 from legoktm/patch-1

Add short name for curl

.github/workflows/test_inspect.yml

@@ -0,0 +1,26 @@
+---
+name: Check aliases
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+
+jobs:
+  check-inspect:
+    name: use skopeo to check whether all images in shortnames.conf are reachable
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: install poetry, skopeo and other dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y python3-poetry python3-toml skopeo
+
+      - name: try to inspect all container images
+        run: |
+          poetry config virtualenvs.create false
+          poetry run ./inspect-images.py

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

inspect-images.py

@@ -0,0 +1,88 @@
+#!/usr/bin/env python3
+import toml
+import asyncio
+
+
+def get_images_to_inspect() -> list[str]:
+    # exclude some images without a latest tag or are not accessible without a login
+    return [
+        url
+        for shortname, url in toml.load("shortnames.conf")["aliases"].items()
+        if shortname
+        not in (
+            "almalinux-minimal",
+            "rockylinux",
+            "rhel7/rhel-atomic",
+            "rhel-minimal",
+            "rhel7-minimal",
+            "leap-dnf",
+            "leap-microdnf",
+            "rhel9-bootc",
+        )
+    ]
+
+
+async def inspect_image(shortname: str) -> None:
+    proc = await asyncio.create_subprocess_shell(
+        cmd := f"skopeo inspect docker://{shortname}",
+        stderr=asyncio.subprocess.PIPE,
+        stdout=asyncio.subprocess.PIPE,
+    )
+    stdout, stderr = (out.decode() for out in await proc.communicate())
+    if proc.returncode != 0:
+        raise RuntimeError(
+            f"{cmd} failed with exit code {proc.returncode}, {stdout=}, {stderr=}"
+        )
+
+
+if __name__ == "__main__":
+
+    import argparse
+    import os
+    import pathlib
+    import shutil
+
+    parser = argparse.ArgumentParser(
+        description="""Copies the shortnames.conf to
+        ~/.config/containers/registries.conf.d or
+        /etc/containers/registries.conf.d/ and try to inspect all images in the
+        toml file."""
+    )
+    parser.add_argument(
+        "--system-wide",
+        action="store_true",
+        help="copy shortnames.conf to /etc/containers/registries.conf.d/ instead of into $HOME",
+    )
+
+    args = parser.parse_args()
+
+    shortnames_dest = (
+        "/etc/containers/registries.conf.d/000-shortnames.conf"
+        if args.system_wide
+        else os.path.expanduser(
+            "~/.config/containers/registries.conf.d/000-shortnames.conf"
+        )
+    )
+
+    pathlib.Path(os.path.dirname(shortnames_dest)).mkdir(exist_ok=True, parents=True)
+    restore_old_shortnames = os.path.exists(shortnames_dest)
+    if restore_old_shortnames:
+        shutil.copy(shortnames_dest, f"{shortnames_dest}.back")
+    shutil.copy("shortnames.conf", shortnames_dest)
+
+    try:
+        loop = asyncio.get_event_loop()
+
+        async def run():
+            tasks = []
+            for shortname in get_images_to_inspect():
+                tasks.append(inspect_image(shortname))
+
+            await asyncio.gather(*tasks)
+
+        loop.run_until_complete(run())
+
+    finally:
+        os.remove(shortnames_dest)
+        if restore_old_shortnames:
+            shutil.move(f"{shortnames_dest}.back", shortnames_dest)

pyproject.toml

@@ -0,0 +1,17 @@
+[tool.poetry]
+name = "shortnames"
+version = "2022.02.08"
+description = "Shortnames project is collecting registry alias names for shortnames to fully specified container image names."
+authors = ["Daniel J Walsh <dwalsh@redhat.com>", "Valentin Rothberg <rothberg@redhat.com>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+toml = "^0.10"
+
+[tool.poetry.group.dev.dependencies]
+black = ">=22.12"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

shortnames.conf

@@ -2,23 +2,29 @@
   # almalinux
   "almalinux" = "docker.io/library/almalinux"
   "almalinux-minimal" = "docker.io/library/almalinux-minimal"
+  # Amazon Linux
+  "amazonlinux" = "public.ecr.aws/amazonlinux/amazonlinux"
   # Arch Linux
-  "archlinux" = "docker.io/archlinux/archlinux"
+  "archlinux" = "docker.io/library/archlinux"
   # centos
   "centos" = "quay.io/centos/centos"
   # containers
   "skopeo" = "quay.io/skopeo/stable"
   "buildah" = "quay.io/buildah/stable"
   "podman" = "quay.io/podman/stable"
+  "hello" = "quay.io/podman/hello"
+  "hello-world" = "quay.io/podman/hello"
   # docker
   "alpine" = "docker.io/library/alpine"
   "docker" = "docker.io/library/docker"
   "registry" = "docker.io/library/registry"
-  "hello-world" = "docker.io/library/hello-world"
   "swarm" = "docker.io/library/swarm"
   # Fedora
+  "fedora-bootc" = "registry.fedoraproject.org/fedora-bootc"
   "fedora-minimal" = "registry.fedoraproject.org/fedora-minimal"
   "fedora" = "registry.fedoraproject.org/fedora"
+  # Gentoo
+  "gentoo" = "docker.io/gentoo/stage3"
   # openSUSE
   "opensuse/tumbleweed" = "registry.opensuse.org/opensuse/tumbleweed"
   "opensuse/tumbleweed-dnf" = "registry.opensuse.org/opensuse/tumbleweed-dnf"
@@ -32,6 +38,21 @@
   "leap-dnf" = "registry.opensuse.org/opensuse/leap-dnf"
   "leap-microdnf" = "registry.opensuse.org/opensuse/leap-microdnf"
   "tw-busybox" = "registry.opensuse.org/opensuse/busybox"
+  # OTel (Open Telemetry) - opentelemetry.io
+  "otel/autoinstrumentation-go" = "docker.io/otel/autoinstrumentation-go"
+  "otel/autoinstrumentation-nodejs" = "docker.io/otel/autoinstrumentation-nodejs"
+  "otel/autoinstrumentation-python" = "docker.io/otel/autoinstrumentation-python"
+  "otel/autoinstrumentation-java" = "docker.io/otel/autoinstrumentation-java"
+  "otel/autoinstrumentation-dotnet" = "docker.io/otel/autoinstrumentation-dotnet"
+  "otel/opentelemetry-collector" = "docker.io/otel/opentelemetry-collector"
+  "otel/opentelemetry-collector-contrib" = "docker.io/otel/opentelemetry-collector-contrib"
+  "otel/opentelemetry-collector-contrib-dev" = "docker.io/otel/opentelemetry-collector-contrib-dev"
+  "otel/opentelemetry-collector-k8s" = "docker.io/otel/opentelemetry-collector-k8s"
+  "otel/opentelemetry-operator" = "docker.io/otel/opentelemetry-operator"
+  "otel/opentelemetry-operator-bundle" = "docker.io/otel/opentelemetry-operator-bundle"
+  "otel/operator-opamp-bridge" = "docker.io/otel/operator-opamp-bridge"
+  "otel/semconvgen" = "docker.io/otel/semconvgen"
+  "otel/weaver" = "docker.io/otel/weaver"
   # SUSE
   "suse/sle15" = "registry.suse.com/suse/sle15"
   "suse/sles12sp5" = "registry.suse.com/suse/sles12sp5"
@@ -41,16 +62,25 @@
   "sles12sp5" = "registry.suse.com/suse/sles12sp5"
   "sles12sp4" = "registry.suse.com/suse/sles12sp4"
   "sles12sp3" = "registry.suse.com/suse/sles12sp3"
+  "bci-base" = "registry.suse.com/bci/bci-base"
+  "bci/bci-base" = "registry.suse.com/bci/bci-base"
+  "bci-micro" = "registry.suse.com/bci/bci-micro"
+  "bci/bci-micro" = "registry.suse.com/bci/bci-micro"
+  "bci-minimal" = "registry.suse.com/bci/bci-minimal"
+  "bci/bci-minimal" = "registry.suse.com/bci/bci-minimal"
+  "bci-busybox" = "registry.suse.com/bci/bci-busybox"
+  "bci/bci-busybox" = "registry.suse.com/bci/bci-busybox"
   # Red Hat Enterprise Linux
   "rhel" = "registry.access.redhat.com/rhel"
   "rhel6" = "registry.access.redhat.com/rhel6"
   "rhel7" = "registry.access.redhat.com/rhel7"
   "rhel7.9" = "registry.access.redhat.com/rhel7.9"
   "rhel-atomic" = "registry.access.redhat.com/rhel-atomic"
-  "rhel-minimal" = "registry.access.redhat.com/rhel-minimum"
+  "rhel9-bootc" = "registry.redhat.io/rhel9/rhel-bootc"
+  "rhel-minimal" = "registry.access.redhat.com/rhel-minimal"
   "rhel-init" = "registry.access.redhat.com/rhel-init"
   "rhel7-atomic" = "registry.access.redhat.com/rhel7-atomic"
-  "rhel7-minimal" = "registry.access.redhat.com/rhel7-minimum"
+  "rhel7-minimal" = "registry.access.redhat.com/rhel7-minimal"
   "rhel7-init" = "registry.access.redhat.com/rhel7-init"
   "rhel7/rhel" = "registry.access.redhat.com/rhel7/rhel"
   "rhel7/rhel-atomic" = "registry.access.redhat.com/rhel7/rhel7/rhel-atomic"
@@ -72,6 +102,9 @@
   "ubi8/ubi-minimal" = "registry.access.redhat.com/ubi8-minimal"
   "ubi8/ubi-init" = "registry.access.redhat.com/ubi8-init"
   "ubi8/ubi-micro" = "registry.access.redhat.com/ubi8-micro"
+  "ubi8/podman" = "registry.access.redhat.com/ubi8/podman"
+  "ubi8/buildah" = "registry.access.redhat.com/ubi8/buildah"
+  "ubi8/skopeo" = "registry.access.redhat.com/ubi8/skopeo"
   "rhel9" = "registry.access.redhat.com/ubi9"
   "rhel9-init" = "registry.access.redhat.com/ubi9-init"
   "rhel9-minimal" = "registry.access.redhat.com/ubi9-minimal"
@@ -84,8 +117,11 @@
   "ubi9/ubi-minimal" = "registry.access.redhat.com/ubi9-minimal"
   "ubi9/ubi-init" = "registry.access.redhat.com/ubi9-init"
   "ubi9/ubi-micro" = "registry.access.redhat.com/ubi9-micro"
+  "ubi9/podman" = "registry.access.redhat.com/ubi9/podman"
+  "ubi9/buildah" = "registry.access.redhat.com/ubi9/buildah"
+  "ubi9/skopeo" = "registry.access.redhat.com/ubi9/skopeo"
   # Rocky Linux
-  "rockylinux" = "docker.io/library/rockylinux"
+  "rockylinux" = "quay.io/rockylinux/rockylinux"
   # Debian
   "debian" = "docker.io/library/debian"
   # Kali Linux
@@ -100,9 +136,24 @@
   "oraclelinux" = "container-registry.oracle.com/os/oraclelinux"
   # busybox
   "busybox" = "docker.io/library/busybox"
+  # golang
+  "golang" = "docker.io/library/golang"
   # php
   "php" = "docker.io/library/php"
   # python
   "python" = "docker.io/library/python"
+  # rust
+  "rust" = "docker.io/library/rust"
   # node
   "node" = "docker.io/library/node"
+  # Grafana Labs
+  "grafana/agent" = "docker.io/grafana/agent"
+  "grafana/grafana" = "docker.io/grafana/grafana"
+  "grafana/k6" = "docker.io/grafana/k6"
+  "grafana/loki" = "docker.io/grafana/loki"
+  "grafana/mimir" = "docker.io/grafana/mimir"
+  "grafana/oncall" = "docker.io/grafana/oncall"
+  "grafana/pyroscope" = "docker.io/grafana/pyroscope"
+  "grafana/tempo" = "docker.io/grafana/tempo"
+  # curl
+  "curl" = "quay.io/curl/curl"