diff --git a/.config/dictionary.txt b/.config/dictionary.txt index 56f7bc6..8a29aad 100644 --- a/.config/dictionary.txt +++ b/.config/dictionary.txt @@ -1,3 +1,4 @@ +KUBEDOCK accesslog addinivalue addoption @@ -14,6 +15,7 @@ confest containerfile devcontainer devel +devfile endgroup gunicorn libera @@ -21,6 +23,7 @@ microdnf mknod modifyitems netcommon +opencontainers pkgmgr pylibssh seccomp diff --git a/.github/actions/build-release/action.yml b/.github/actions/build-release/action.yml new file mode 100644 index 0000000..4dc57a3 --- /dev/null +++ b/.github/actions/build-release/action.yml @@ -0,0 +1,72 @@ +--- +name: Build & Test +description: Build the final container image and run tests on it + +inputs: + registry: + description: Target registry to push the final image. + default: "localhost:5000" + namespace: + description: Namespace of the container image. + default: ansible + final_image: + description: Name of the final image. + default: ansible-workspace-env-reference + publish: + description: Publish the image to ghcr.io + default: "false" + +runs: + using: composite + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Prepare + shell: bash + run: | + platform=${{ matrix.platform }} + echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + with: + # network=host driver-opt needed to push to local registry + driver-opts: network=host + buildkitd-flags: --debug + + - name: Build final image + id: build-final + uses: docker/build-push-action@v5 + with: + context: ${{ github.workspace }}/devspaces/context + provenance: false + file: ${{ github.workspace }}/devspaces/Containerfile + load: true + tags: | + ${{ inputs.namespace }}/${{ inputs.final_image }}:test + # cache-from: type=gha,scope=build-${{ env.PLATFORM_PAIR }} + # cache-to: type=gha,scope=build-${{ env.PLATFORM_PAIR }} + + - name: Docker meta + id: meta + if: ${{ inputs.publish == 'true' }} + uses: docker/metadata-action@v5 + with: + images: ghcr.io/${{ inputs.namespace }}/${{ inputs.final_image }} + flavor: | + latest=false + tags: | + type=raw,value=latest + type=ref,event=tag + + - name: Push the built image to ghcr.io + id: push-final + if: ${{ inputs.publish == 'true' }} + uses: docker/build-push-action@v5 + with: + context: ${{ github.workspace }}/devspaces/context + provenance: false + file: ${{ github.workspace }}/devspaces/Containerfile + tags: ${{ steps.meta.outputs.tags }} + push: true diff --git a/.github/actions/build-test/action.yml b/.github/actions/build-test/action.yml index 926366d..dc2a724 100644 --- a/.github/actions/build-test/action.yml +++ b/.github/actions/build-test/action.yml @@ -33,6 +33,7 @@ runs: with: # network=host driver-opt needed to push to local registry driver-opts: network=host + buildkitd-flags: --debug - name: Install or upgrade tools needed for the build and test shell: bash diff --git a/.github/workflows/tox.yml b/.github/workflows/tox.yml index e48fc35..6663839 100644 --- a/.github/workflows/tox.yml +++ b/.github/workflows/tox.yml @@ -25,8 +25,9 @@ jobs: build-image: runs-on: ${{ matrix.builder }} name: ${{ matrix.name }} - # commented to speedup execution - # needs: tox + # uses same runner for image building, but devspace image builds faster + needs: + - devspaces services: registry: image: registry:2 @@ -88,9 +89,29 @@ jobs: with: registry: ghcr.io + devspaces: + runs-on: devtools-multiarch-builder + steps: + - name: Check out repository + uses: actions/checkout@v4 + + - name: Login to GitHub Container Registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Build the devspaces image + uses: ./.github/actions/build-release + with: + publish: "{{ github.event_name == 'release' && github.event.action == 'published' && 'true' || 'false' }}" + pypi: name: Publish to PyPI registry - needs: build-image + needs: + - build-image + - tox if: github.event_name == 'release' && github.event.action == 'published' environment: release # approval runs-on: ubuntu-22.04 diff --git a/devspaces/.gitignore b/devspaces/.gitignore new file mode 100644 index 0000000..c46836d --- /dev/null +++ b/devspaces/.gitignore @@ -0,0 +1,22 @@ +# Version created and populated by setuptools_scm +/src/ansible_creator/_version.py + +dist/ + +build/ + +*.egg-info + +*.ruff_cache/ + +*.mypy_cache/ + +*.pytest_cache/ + +*.tox/ + +__pycache__/ +.cache +_readthedocs +.coverage +coverage.xml diff --git a/devspaces/Containerfile b/devspaces/Containerfile new file mode 100644 index 0000000..dcab2ef --- /dev/null +++ b/devspaces/Containerfile @@ -0,0 +1,18 @@ +FROM quay.io/devfile/universal-developer-image:ubi8-latest + +ARG PYV=3.11 + +LABEL org.opencontainers.image.source=https://github.com/ansible/ansible-workspace-env-reference-image +LABEL org.opencontainers.image.authors="Ansible DevTools" +LABEL org.opencontainers.image.vendor="Red Hat" +LABEL org.opencontainers.image.licenses="GPL-3.0" +LABEL org.opencontainers.image.description="An OpenShift Dev Spaces container image for Ansible." + +USER 0 + +WORKDIR /context +# install ansible-dev-tools specific packages and dependencies while avoiding +# adding multiple layers to the image. +RUN --mount=type=bind,target=. --mount=type=cache,dst=/var/cache/dnf --mount=type=cache,dst=/root/.cache/pip ./setup.sh + +USER 10001 diff --git a/devspaces/LICENSE b/devspaces/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/devspaces/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://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 + + http://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/devspaces/README.md b/devspaces/README.md new file mode 100644 index 0000000..1e3e956 --- /dev/null +++ b/devspaces/README.md @@ -0,0 +1,24 @@ +# Ansible Workspace Environment Reference Image for Openshift DevSpaces + +An OpenShift Dev Spaces image specifically for Ansible development. + +This comes pre-built with the [Ansible Development Tools](https://github.com/ansible/ansible-dev-tools) package. +For documentation on how to use these tools, please refer to [ADT docs](https://ansible.readthedocs.io/projects/dev-tools/). + +This image is built and published on a nightly basis. Grab this image using: + +```bash +podman pull ghcr.io/ansible/ansible-workspace-env-reference:latest +``` + +## Base Image + +The [Universal Developer Image](https://quay.io/repository/devfile/universal-developer-image) is used as the base image. + +## Code of Conduct + +We ask all of our community members and contributors to adhere to the [Ansible code of conduct](http://docs.ansible.com/ansible/latest/community/code_of_conduct.html). + +## LICENSE + +See [LICENSE](https://github.com/ansible-collections/cisco.nxos/blob/main/LICENSE) to see the full text. diff --git a/devspaces/context/podman.py b/devspaces/context/podman.py new file mode 100755 index 0000000..1d13c5e --- /dev/null +++ b/devspaces/context/podman.py @@ -0,0 +1,43 @@ +#! /usr/bin/env python3 +"""A python wrapper to intercept podman calls and set CONTAINER_HOST to use kubedock.""" + +# cspell: ignore Unsetting +# ruff: noqa: T201 +from __future__ import annotations + +import os +import sys + + +ARGS = sys.argv +SUPPORTED = ( + "run", + "ps", + "exec", + "cp", + "logs", + "inspect", + "kill", + "rm", + "wait", + "stop", + "start", +) + +try: + ARGS.remove("--interactive") + ARGS.remove("--user=root") +except ValueError: + pass + +if ARGS[1] in SUPPORTED: + print("Setting CONTAINER_HOST to use kubedock") + os.environ["CONTAINER_HOST"] = "tcp://127.0.0.1:2475" +else: + print("Unsetting CONTAINER_HOST to use podman locally") + os.environ.pop("CONTAINER_HOST", None) + +ARGS[0] = "podman.orig" + +print(f"Executing: {' '.join(ARGS)}") +os.execvp(ARGS[0], ARGS) # noqa: S606 diff --git a/devspaces/context/requirements.txt b/devspaces/context/requirements.txt new file mode 100644 index 0000000..1987e6c --- /dev/null +++ b/devspaces/context/requirements.txt @@ -0,0 +1,3 @@ +ansible-dev-tools +kubernetes==29.0.0 +molecule-plugins[podman]==23.5.3 diff --git a/devspaces/context/requirements.yml b/devspaces/context/requirements.yml new file mode 100644 index 0000000..e3ef502 --- /dev/null +++ b/devspaces/context/requirements.yml @@ -0,0 +1,6 @@ +--- +collections: + - name: ansible.netcommon + - name: ansible.posix + - name: ansible.scm + - name: ansible.utils diff --git a/devspaces/context/setup.sh b/devspaces/context/setup.sh new file mode 100755 index 0000000..06e7278 --- /dev/null +++ b/devspaces/context/setup.sh @@ -0,0 +1,41 @@ +#!/bin/bash -e +# cspell: ignore makecache overlayfs libssh chgrp +set -eux pipefail + +set -e +dnf -y makecache +dnf -y update +dnf install -y \ + tar \ + podman \ + fuse-overlayfs \ + openssh-clients \ + zsh \ + util-linux-user \ + which \ + git \ + dumb-init \ + gcc \ + git-core \ + libssh-devel \ + python3-markupsafe \ + ncurses \ + python3-bcrypt \ + python3-cffi \ + python3-pip \ + python3-pyyaml \ + python3-ruamel-yaml \ + python3-wheel \ + --exclude container-selinux +dnf clean all + +/usr/bin/python${PYV} -m pip install --no-cache-dir -r requirements.txt + +ansible-galaxy collection install -r requirements.yml + +chgrp -R 0 /home && chmod -R g=u /etc/passwd /etc/group /home + +# Configure the podman wrapper +cp podman.py /usr/bin/podman.wrapper +chown 0:0 /usr/bin/podman.wrapper +chmod +x /usr/bin/podman.wrapper diff --git a/devspaces/devfile.yaml b/devspaces/devfile.yaml new file mode 100644 index 0000000..6937a7f --- /dev/null +++ b/devspaces/devfile.yaml @@ -0,0 +1,15 @@ +schemaVersion: 2.2.2 +metadata: + name: ansible-demo +components: + - name: tooling-container + container: + image: ghcr.io/ansible/ansible-workspace-env-reference:latest + memoryRequest: 256M + memoryLimit: 6Gi + cpuRequest: 250m + cpuLimit: 2000m + args: ["tail", "-f", "/dev/null"] + env: + - name: KUBEDOCK_ENABLED + value: "true" diff --git a/devspaces/playbooks/ansible-navigator.yml b/devspaces/playbooks/ansible-navigator.yml new file mode 100644 index 0000000..6bc7068 --- /dev/null +++ b/devspaces/playbooks/ansible-navigator.yml @@ -0,0 +1,16 @@ +--- +ansible-navigator: + logging: + level: debug + append: false + file: $PWD/.logs/ansible-navigator.log + + execution-environment: + enabled: true + image: ghcr.io/ansible/community-ansible-dev-tools:latest + pull: + policy: always + + playbook-artifact: + enable: true + save-as: "$PWD/.logs/{playbook_name}-artifact-{time_stamp}.json" diff --git a/devspaces/playbooks/site.yaml b/devspaces/playbooks/site.yaml new file mode 100644 index 0000000..0e668f5 --- /dev/null +++ b/devspaces/playbooks/site.yaml @@ -0,0 +1,8 @@ +--- +- name: Hello world! + gather_facts: false + hosts: localhost + tasks: + - name: Say hello + ansible.builtin.debug: + msg: "Hello world!"