diff --git a/src/bci_build/package/__init__.py b/src/bci_build/package/__init__.py index 32f00fe64..9d0bf59c9 100644 --- a/src/bci_build/package/__init__.py +++ b/src/bci_build/package/__init__.py @@ -1565,6 +1565,7 @@ def generate_disk_size_constraints(size_gb: int) -> str: from .appcontainers import HELM_CONTAINERS # noqa: E402 from .appcontainers import NGINX_CONTAINERS # noqa: E402 from .appcontainers import PCP_CONTAINERS # noqa: E402 +from .appcontainers import PODMAN_CONTAINERS # noqa: E402 from .appcontainers import PROMETHEUS_CONTAINERS # noqa: E402 from .appcontainers import REGISTRY_CONTAINERS # noqa: E402 from .appcontainers import THREE_EIGHT_NINE_DS_CONTAINERS # noqa: E402 @@ -1623,6 +1624,7 @@ def generate_disk_size_constraints(size_gb: int) -> str: *FIPS_BASE_CONTAINERS, *MARIADB_CONTAINERS, *MARIADB_CLIENT_CONTAINERS, + *PODMAN_CONTAINERS, *POSTFIX_CONTAINERS, *POSTGRES_CONTAINERS, *PROMETHEUS_CONTAINERS, diff --git a/src/bci_build/package/appcontainers.py b/src/bci_build/package/appcontainers.py index b9d7cb22b..1104a4fb1 100644 --- a/src/bci_build/package/appcontainers.py +++ b/src/bci_build/package/appcontainers.py @@ -486,3 +486,95 @@ def _get_nginx_kwargs(os_version: OsVersion): ) for os_version in (OsVersion.TUMBLEWEED,) ] + + +_PODMAN_FILES = {"podman-containers.conf": "", "containers.conf": "", "LICENSE": ""} + +for fname in _PODMAN_FILES: + _PODMAN_FILES[fname] = (Path(__file__).parent / "podman" / fname).read_text() + +# upstreams confainers.conf pre-configures podman to use crun, but we ship runc +# in SLES, so we have to override that +_TW_CTR_CONF = _PODMAN_FILES["containers.conf"] +_PODMAN_SLES_FILES = {**_PODMAN_FILES} +_PODMAN_SLES_FILES["containers.conf"] = _TW_CTR_CONF.replace("crun", "runc") + +_PODMAN_VERS_REGEX = "%%podman_version%%" + +PODMAN_CONTAINERS = [ + ApplicationStackContainer( + name="podman", + pretty_name="Podman", + license="Apache-2.0", + version_in_uid=False, + version=_PODMAN_VERS_REGEX, + replacements_via_service=[ + Replacement( + regex_in_build_description=_PODMAN_VERS_REGEX, package_name="podman" + ) + ], + os_version=os_version, + extra_files=( + _PODMAN_FILES if os_version == OsVersion.TUMBLEWEED else _PODMAN_SLES_FILES + ), + is_latest=os_version in CAN_BE_LATEST_OS_VERSION, + logo_url="https://raw.githubusercontent.com/containers/common/main/logos/podman-logo-full-vert.png", + package_list=( + ["podman", "fuse-overlayfs"] + + ( + # explicitly require libcontainers-common dependencies to make OBS build + [ + "libcontainers-common", + "libcontainers-default-policy", + "libcontainers-sles-mounts", + ] + if os_version != OsVersion.TUMBLEWEED + else [] + ) + ), + custom_end=r"""RUN useradd -U podman && \ + echo -e "podman:1:999\npodman:1001:64535" > /etc/subuid && \ + echo -e "podman:1:999\npodman:1001:64535" > /etc/subgid + +COPY containers.conf /etc/containers/containers.conf +COPY podman-containers.conf /home/podman/.config/containers/containers.conf + +RUN mkdir -p /home/podman/.local/share/containers && \ + chown podman:podman -R /home/podman && \ + chmod 0644 /etc/containers/containers.conf + +""" + + ( + "RUN cp /usr/share/containers/storage.conf /etc/containers/storage.conf" + if os_version == OsVersion.TUMBLEWEED + else "" + ) + + r""" +# Copy & modify the defaults to provide reference if runtime changes needed. +# Changes here are required for running with fuse-overlay storage inside container. +RUN sed -i -e 's|^#mount_program|mount_program|g' \ + -e '/additionalimage.*/a "/var/lib/shared",' \ + -e 's|^mountopt[[:space:]]*=.*$|mountopt = "nodev,fsync=0"|g' \ + /etc/containers/storage.conf + +VOLUME /var/lib/containers +VOLUME /home/podman/.local/share/containers + +RUN mkdir -p /var/lib/shared/overlay-images \ + /var/lib/shared/overlay-layers \ + /var/lib/shared/vfs-images \ + /var/lib/shared/vfs-layers && \ + touch /var/lib/shared/overlay-images/images.lock && \ + touch /var/lib/shared/overlay-layers/layers.lock && \ + touch /var/lib/shared/vfs-images/images.lock && \ + touch /var/lib/shared/vfs-layers/layers.lock + +# fix capabilities of newuidmap & newgidmap +RUN permctl --system + +ENV _CONTAINERS_USERNS_CONFIGURED="" \ + BUILDAH_ISOLATION=chroot +""", + ) + for os_version in ALL_NONBASE_OS_VERSIONS +] diff --git a/src/bci_build/package/podman/LICENSE b/src/bci_build/package/podman/LICENSE new file mode 100644 index 000000000..9b259bdfc --- /dev/null +++ b/src/bci_build/package/podman/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. diff --git a/src/bci_build/package/podman/README.md.j2 b/src/bci_build/package/podman/README.md.j2 new file mode 100644 index 000000000..8f1be35b3 --- /dev/null +++ b/src/bci_build/package/podman/README.md.j2 @@ -0,0 +1,48 @@ +# The Podman Container Image + +{% include 'badges.j2' %} + +## Description + +Podman (the POD MANager) is a tool for managing containers and images, volumes +mounted into those containers, and pods made from groups of containers. Podman +runs containers on Linux, but can also be used on Mac and Windows systems using +a Podman-managed virtual machine. Podman is based on libpod, a library for +container lifecycle management that. + +This Container Image ships Podman pre-configured to allow running it inside a +container. + + +## Usage + +This Container Image is intended for interactive usage only and it must be +launched in privileged mode: + +```ShellSession +$ podman run --rm -it --privileged \ + {{ image.pretty_reference }} +# podman run --rm -it leap grep ^ID= /etc/os-release +ID="opensuse-leap" +``` + +The container ships the unprivileged user `podman`, which can launch rootless +containers inside a container: +```ShellSession +$ podman run --rm -it --privileged \ + {{ image.pretty_reference }} +# su podman +podman:/> podman run --rm -it leap grep ^ID= /etc/os-release +ID="opensuse-leap" +``` + + +## Limitations + +- The container must be run in privileged mode. +- Podman inside the container has to use the slow `fuse-overlayfs` storage + driver. This driver is significantly slower than the default `overlay` driver, + which is unavailable in a container. + + +{% include 'licensing_and_eula.j2' %} diff --git a/src/bci_build/package/podman/containers.conf b/src/bci_build/package/podman/containers.conf new file mode 100644 index 000000000..220c1f850 --- /dev/null +++ b/src/bci_build/package/podman/containers.conf @@ -0,0 +1,12 @@ +[containers] +netns="host" +userns="host" +ipcns="host" +utsns="host" +cgroupns="host" +cgroups="disabled" +log_driver = "k8s-file" +[engine] +cgroup_manager = "cgroupfs" +events_logger="file" +runtime="crun" diff --git a/src/bci_build/package/podman/podman-containers.conf b/src/bci_build/package/podman/podman-containers.conf new file mode 100644 index 000000000..2bdd95a3b --- /dev/null +++ b/src/bci_build/package/podman/podman-containers.conf @@ -0,0 +1,5 @@ +[containers] +volumes = [ + "/proc:/proc", +] +default_sysctls = [] diff --git a/update-files.sh b/update-files.sh index 6b0849977..8f6032c48 100755 --- a/update-files.sh +++ b/update-files.sh @@ -4,7 +4,7 @@ # # Note: when fetching external files, make sure to include their license declarations! -mkdir -p src/bci_build/package/{postgres,nginx,grafana,mariadb,postfix/entrypoint/ldap} +mkdir -p src/bci_build/package/{postgres,nginx,grafana,mariadb,postfix/entrypoint/ldap,podman} ### postgres: PostgreSQL license curl -sf -o src/bci_build/package/postgres/LICENSE https://raw.githubusercontent.com/docker-library/postgres/master/LICENSE @@ -43,3 +43,8 @@ curl -sf -o src/bci_build/package/postfix/entrypoint/ldap/virtual_mailbox_maps h curl -sf -o src/bci_build/package/postfix/entrypoint/ldap/virtual_uid_maps https://raw.githubusercontent.com/thkukuk/containers-mailserver/master/postfix/ldap/virtual_uid_maps patch src/bci_build/package/postfix/entrypoint/entrypoint.sh src/bci_build/package/postfix/entrypoint/sles-entrypoint.patch -o src/bci_build/package/postfix/entrypoint/entrypoint.sles.sh + +### podman: Apache-2 +curl -sf -o src/bci_build/package/podman/containers.conf https://raw.githubusercontent.com/containers/image_build/main/podman/containers.conf +curl -sf -o src/bci_build/package/podman/podman-containers.conf https://raw.githubusercontent.com/containers/image_build/main/podman/podman-containers.conf +curl -sf -o src/bci_build/package/podman/LICENSE https://raw.githubusercontent.com/containers/image_build/main/LICENSE