├── bindep.txt ├── .gitignore ├── .github ├── CODEOWNERS ├── workflows │ ├── ci.yml │ └── cd.yml └── actions │ ├── merge-release │ └── action.yml │ └── build-test │ └── action.yml ├── final ├── requirements.txt └── Containerfile ├── requirements.yml ├── tests ├── test.sh ├── site.yml └── ansible-navigator.yml ├── site.yml ├── ansible-navigator.yml ├── .pre-commit-config.yaml ├── execution-environment.yml ├── .devcontainer ├── devcontainer.json ├── docker │ └── devcontainer.json └── podman │ └── devcontainer.json ├── README.md └── LICENSE /bindep.txt: -------------------------------------------------------------------------------- 1 | python3-devel 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode 2 | .logs 3 | context 4 | venv -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @ansible/devtools @NilashishC -------------------------------------------------------------------------------- /final/requirements.txt: -------------------------------------------------------------------------------- 1 | ansible-dev-tools[server] 2 | molecule-plugins[podman]==23.5.3 3 | -------------------------------------------------------------------------------- /requirements.yml: -------------------------------------------------------------------------------- 1 | --- 2 | collections: 3 | - name: ansible.netcommon 4 | - name: ansible.posix 5 | - name: ansible.scm 6 | - name: ansible.utils 7 | -------------------------------------------------------------------------------- /tests/test.sh: -------------------------------------------------------------------------------- 1 | echo "::group::Starting tests" 2 | 3 | set -ex 4 | 5 | cd /home/podman/tests 6 | 7 | adt --version 8 | 9 | podman run hello 10 | 11 | ansible-navigator run site.yml --mode stdout 12 | 13 | echo "::endgroup::" 14 | -------------------------------------------------------------------------------- /site.yml: -------------------------------------------------------------------------------- 1 | - name: Demo playbook 2 | hosts: localhost 3 | gather_facts: true 4 | tasks: 5 | - name: Print the facts 6 | ansible.builtin.debug: 7 | var: ansible_facts 8 | 9 | - name: Print the hostname 10 | ansible.builtin.debug: 11 | var: ansible_facts.hostname 12 | -------------------------------------------------------------------------------- /tests/site.yml: -------------------------------------------------------------------------------- 1 | - name: Demo playbook 2 | hosts: localhost 3 | gather_facts: true 4 | tasks: 5 | - name: Print the facts 6 | ansible.builtin.debug: 7 | var: ansible_facts 8 | 9 | - name: Print the hostname 10 | ansible.builtin.debug: 11 | var: ansible_facts.hostname 12 | -------------------------------------------------------------------------------- /ansible-navigator.yml: -------------------------------------------------------------------------------- 1 | --- 2 | ansible-navigator: 3 | logging: 4 | level: debug 5 | append: False 6 | file: $PWD/.logs/ansible-navigator.log 7 | 8 | execution-environment: 9 | enabled: true 10 | image: ghcr.io/ansible/community-ansible-dev-tools:latest 11 | pull: 12 | policy: always 13 | 14 | playbook-artifact: 15 | enable: True 16 | save-as: "$PWD/.logs/{playbook_name}-artifact-{time_stamp}.json" 17 | -------------------------------------------------------------------------------- /tests/ansible-navigator.yml: -------------------------------------------------------------------------------- 1 | --- 2 | ansible-navigator: 3 | logging: 4 | level: debug 5 | append: False 6 | file: /tmp/logs/ansible-navigator.log 7 | 8 | execution-environment: 9 | enabled: true 10 | image: ghcr.io/ansible/community-ansible-dev-tools:latest 11 | pull: 12 | policy: always 13 | 14 | playbook-artifact: 15 | enable: True 16 | save-as: "/tmp/logs/{playbook_name}-artifact-{time_stamp}.json" 17 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | repos: 3 | - repo: https://github.com/pre-commit/pre-commit-hooks 4 | rev: v4.5.0 5 | hooks: 6 | - id: check-merge-conflict 7 | - id: check-symlinks 8 | - id: debug-statements 9 | - id: end-of-file-fixer 10 | - id: no-commit-to-branch 11 | args: [--branch, main] 12 | - id: trailing-whitespace 13 | - id: detect-private-key 14 | - id: check-added-large-files 15 | -------------------------------------------------------------------------------- /execution-environment.yml: -------------------------------------------------------------------------------- 1 | --- 2 | version: 3 3 | 4 | images: 5 | base_image: 6 | name: quay.io/fedora/fedora-minimal:39 7 | 8 | dependencies: 9 | ansible_runner: 10 | package_pip: ansible-runner 11 | 12 | ansible_core: 13 | package_pip: ansible-core 14 | 15 | galaxy: requirements.yml 16 | 17 | options: 18 | package_manager_path: /usr/bin/microdnf 19 | 20 | additional_build_steps: 21 | prepend_base: 22 | - RUN $PKGMGR -y install python3-devel 23 | -------------------------------------------------------------------------------- /.devcontainer/devcontainer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ansible-dev-container-codespaces", 3 | "image": "ghcr.io/ansible/community-ansible-dev-tools:latest", 4 | "containerUser": "podman", 5 | "runArgs": [ 6 | "--security-opt", 7 | "seccomp=unconfined", 8 | "--security-opt", 9 | "label=disable", 10 | "--cap-add=SYS_ADMIN", 11 | "--cap-add=SYS_RESOURCE", 12 | "--device", 13 | "/dev/fuse", 14 | "--security-opt", 15 | "apparmor=unconfined", 16 | "--hostname=ansible-dev-container" 17 | ], 18 | "updateRemoteUserUID": true, 19 | "customizations": { 20 | "vscode": { 21 | "extensions": [ 22 | "redhat.ansible" 23 | ] 24 | } 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /.devcontainer/docker/devcontainer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ansible-dev-container-docker", 3 | "image": "ghcr.io/ansible/community-ansible-dev-tools:latest", 4 | "containerUser": "podman", 5 | "runArgs": [ 6 | "--security-opt", 7 | "seccomp=unconfined", 8 | "--security-opt", 9 | "label=disable", 10 | "--cap-add=SYS_ADMIN", 11 | "--cap-add=SYS_RESOURCE", 12 | "--device", 13 | "/dev/fuse", 14 | "--security-opt", 15 | "apparmor=unconfined", 16 | "--hostname=ansible-dev-container" 17 | ], 18 | "updateRemoteUserUID": true, 19 | "customizations": { 20 | "vscode": { 21 | "extensions": [ 22 | "redhat.ansible" 23 | ] 24 | } 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /.devcontainer/podman/devcontainer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ansible-dev-container-podman", 3 | "image": "ghcr.io/ansible/community-ansible-dev-tools:latest", 4 | "containerUser": "root", 5 | "runArgs": [ 6 | "--cap-add=SYS_ADMIN", 7 | "--cap-add=SYS_RESOURCE", 8 | "--device", 9 | "/dev/fuse", 10 | "--security-opt", 11 | "seccomp=unconfined", 12 | "--security-opt", 13 | "label=disable", 14 | "--security-opt", 15 | "apparmor=unconfined", 16 | "--userns=host", 17 | "--hostname=ansible-dev-container", 18 | "--volume", 19 | "ansible-dev-tools-container-storage:/var/lib/containers" 20 | ], 21 | "customizations": { 22 | "vscode": { 23 | "extensions": [ 24 | "redhat.ansible" 25 | ] 26 | } 27 | } 28 | } -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: ci 3 | 4 | concurrency: 5 | group: ${{ github.head_ref || github.run_id }} 6 | cancel-in-progress: true 7 | 8 | on: 9 | pull_request: 10 | branches: [main] 11 | schedule: 12 | - cron: '0 0 * * *' 13 | workflow_dispatch: 14 | 15 | jobs: 16 | build-test: 17 | runs-on: ${{ matrix.builder }} 18 | services: 19 | registry: 20 | image: registry:2 21 | ports: 22 | - 5000:5000 23 | 24 | strategy: 25 | fail-fast: false 26 | matrix: 27 | include: 28 | - builder: devtools-multiarch-builder 29 | platform: linux/amd64 30 | - builder: devtools-arm64-runner 31 | platform: linux/arm64 32 | 33 | steps: 34 | - name: Login to GitHub Container Registry 35 | uses: docker/login-action@v3 36 | with: 37 | registry: ghcr.io 38 | username: ${{ github.actor }} 39 | password: ${{ secrets.GITHUB_TOKEN }} 40 | 41 | - name: Build the container image for ${{ matrix.platform }} and test it 42 | uses: ansible/community-ansible-dev-tools-container/.github/actions/build-test@main 43 | -------------------------------------------------------------------------------- /.github/workflows/cd.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: publish 3 | 4 | concurrency: 5 | group: ${{ github.head_ref || github.run_id }} 6 | cancel-in-progress: true 7 | 8 | on: 9 | release: 10 | types: [published] 11 | workflow_dispatch: 12 | 13 | jobs: 14 | build-test: 15 | runs-on: ${{ matrix.builder }} 16 | services: 17 | registry: 18 | image: registry:2 19 | ports: 20 | - 5000:5000 21 | 22 | strategy: 23 | fail-fast: false 24 | matrix: 25 | include: 26 | - builder: devtools-multiarch-builder 27 | platform: linux/amd64 28 | - builder: devtools-arm64-runner 29 | platform: linux/arm64 30 | 31 | steps: 32 | - name: Login to GitHub Container Registry 33 | uses: docker/login-action@v3 34 | with: 35 | registry: ghcr.io 36 | username: ${{ github.actor }} 37 | password: ${{ secrets.GITHUB_TOKEN }} 38 | 39 | - name: Build the container image for ${{ matrix.platform }} and test it 40 | uses: ansible/community-ansible-dev-tools-container/.github/actions/build-test@main 41 | with: 42 | registry: ghcr.io 43 | 44 | publish: 45 | runs-on: ubuntu-latest 46 | needs: build-test 47 | if: success('build-test') 48 | steps: 49 | - name: Login to GitHub Container Registry 50 | uses: docker/login-action@v3 51 | with: 52 | registry: ghcr.io 53 | username: ${{ github.actor }} 54 | password: ${{ secrets.GITHUB_TOKEN }} 55 | 56 | - name: Push final manifest to ghcr.io 57 | uses: ansible/community-ansible-dev-tools-container/.github/actions/merge-release@main 58 | with: 59 | registry: ghcr.io 60 | -------------------------------------------------------------------------------- /.github/actions/merge-release/action.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Merge & Release 3 | description: Create a final manifest from the multi-arch images and push it. 4 | 5 | inputs: 6 | registry: 7 | description: Target registry to push the final image. 8 | default: "localhost:5000" 9 | namespace: 10 | description: Namespace of the container image. 11 | default: ansible 12 | final_image: 13 | description: Name of the final image. 14 | default: community-ansible-dev-tools 15 | 16 | runs: 17 | using: composite 18 | steps: 19 | - name: Checkout 20 | uses: actions/checkout@v4 21 | 22 | - name: Download digests 23 | uses: actions/download-artifact@v4 24 | with: 25 | path: /tmp/digests 26 | pattern: digests-* 27 | merge-multiple: true 28 | 29 | - name: Set up Docker Buildx 30 | uses: docker/setup-buildx-action@v3 31 | 32 | - name: Docker meta 33 | id: meta 34 | uses: docker/metadata-action@v5 35 | with: 36 | images: | 37 | name=${{ inputs.registry }}/${{ inputs.namespace }}/${{ inputs.final_image }} 38 | tags: | 39 | latest 40 | type=schedule,pattern=latest 41 | type=ref,event=tag 42 | 43 | - name: Create manifest list and push 44 | shell: bash 45 | working-directory: /tmp/digests 46 | run: | 47 | docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \ 48 | --annotation "manifest:org.opencontainers.image.description=A multi-arch community container image for Ansible Devtools." \ 49 | $(printf '${{ inputs.registry }}/${{ inputs.namespace }}/${{ inputs.final_image }}@sha256:%s ' *) \ 50 | 51 | - name: Inspect image 52 | shell: bash 53 | run: | 54 | docker buildx imagetools inspect ${{ inputs.registry }}/${{ inputs.namespace }}/${{ inputs.final_image }}:latest 55 | -------------------------------------------------------------------------------- /.github/actions/build-test/action.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Build & Test 3 | description: Build the final container image and run tests on it 4 | 5 | inputs: 6 | registry: 7 | description: Target registry to push the final image. 8 | default: "localhost:5000" 9 | namespace: 10 | description: Namespace of the container image. 11 | default: ansible 12 | final_image: 13 | description: Name of the final image. 14 | default: community-ansible-dev-tools 15 | 16 | runs: 17 | using: composite 18 | steps: 19 | - name: Checkout 20 | uses: actions/checkout@v4 21 | 22 | - name: Prepare 23 | shell: bash 24 | run: | 25 | platform=${{ matrix.platform }} 26 | echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV 27 | 28 | - name: Set up Docker Buildx 29 | uses: docker/setup-buildx-action@v3 30 | with: 31 | # network=host driver-opt needed to push to local registry 32 | driver-opts: network=host 33 | 34 | - name: Install ansible-builder 35 | shell: bash 36 | id: ansible-builder-install 37 | run: | 38 | python3 -m pip install ansible-builder 39 | 40 | - name: Verify ansible-builder installed 41 | shell: bash 42 | id: ansible-builder-verify 43 | run: | 44 | ansible-builder --version 45 | 46 | - name: Create a build context and Containerfile for base EE 47 | shell: bash 48 | run: | 49 | ansible-builder create -f ${{ github.workspace }}/execution-environment.yml --output-filename Containerfile -v3 50 | 51 | - name: Build base image for ${{ matrix.platform }} 52 | uses: docker/build-push-action@v5 53 | id: build-base 54 | with: 55 | context: context 56 | provenance: false 57 | file: context/Containerfile 58 | platforms: ${{ matrix.platform }} 59 | push: true 60 | tags: localhost:5000/${{ inputs.final_image }}-base:latest 61 | cache-from: type=gha,scope=build-${{ env.PLATFORM_PAIR }} 62 | cache-to: type=gha,scope=build-${{ env.PLATFORM_PAIR }} 63 | 64 | - name: Show available images & base image manifest 65 | shell: bash 66 | run: | 67 | curl -X GET http://localhost:5000/v2/${{ inputs.final_image }}-base/tags/list 68 | docker manifest inspect localhost:5000/${{ inputs.final_image }}-base --insecure -v 69 | 70 | - name: Build final image for ${{ matrix.platform }} 71 | id: build-final 72 | uses: docker/build-push-action@v5 73 | with: 74 | context: ${{ github.workspace }}/final 75 | provenance: false 76 | file: ${{ github.workspace }}/final/Containerfile 77 | load: true 78 | tags: | 79 | ${{ inputs.namespace }}/${{ inputs.final_image }}:test 80 | build-contexts: | 81 | ${{ inputs.final_image }}-base=docker-image://localhost:5000/${{ inputs.final_image }}-base:latest 82 | platforms: ${{ matrix.platform }} 83 | cache-from: type=gha,scope=build-${{ env.PLATFORM_PAIR }} 84 | cache-to: type=gha,scope=build-${{ env.PLATFORM_PAIR }} 85 | 86 | - name: Validate if the final image is a valid EE 87 | shell: bash 88 | run: | 89 | python3 -m pip install --upgrade ansible-navigator 90 | ansible-navigator --version 91 | ansible-navigator run ${{ github.workspace }}/site.yml --ce docker --mode stdout --eei ${{ inputs.namespace }}/${{ inputs.final_image }}:test 92 | 93 | - name: Run tests on the image before pushing with docker 94 | shell: bash 95 | id: run-tests-docker 96 | run: | 97 | docker run --rm -v ${{ github.workspace }}/tests:/home/podman/tests \ 98 | --security-opt seccomp=unconfined --security-opt label=disable --security-opt apparmor=unconfined \ 99 | --cap-add=SYS_ADMIN --cap-add=SYS_RESOURCE \ 100 | --device /dev/fuse ${{ inputs.namespace }}/${{ inputs.final_image }}:test \ 101 | -c "/home/podman/tests/test.sh" 102 | 103 | - name: Push the built image to ${{ inputs.registry }} by digest for ${{ matrix.platform }} 104 | id: push-final 105 | uses: docker/build-push-action@v5 106 | with: 107 | context: ${{ github.workspace }}/final 108 | provenance: false 109 | file: ${{ github.workspace }}/final/Containerfile 110 | build-contexts: | 111 | ${{ inputs.final_image }}-base=docker-image://localhost:5000/${{ inputs.final_image }}-base:latest 112 | platforms: ${{ matrix.platform }} 113 | outputs: type=image,name=${{ inputs.registry }}/${{ inputs.namespace }}/${{ inputs.final_image }},push-by-digest=true,name-canonical=true,push=true 114 | 115 | - name: Export digest 116 | shell: bash 117 | run: | 118 | rm -rf /tmp/digests 119 | mkdir -p /tmp/digests 120 | digest="${{ steps.push-final.outputs.digest }}" 121 | touch "/tmp/digests/${digest#sha256:}" 122 | 123 | - name: Upload digest 124 | uses: actions/upload-artifact@v4 125 | with: 126 | name: digests-${{ env.PLATFORM_PAIR }} 127 | path: /tmp/digests/* 128 | if-no-files-found: error 129 | retention-days: 1 130 | 131 | # this step is ONLY needed for maintainence of self hosted runners 132 | - name: Cleanup docker 133 | shell: bash 134 | if: always() 135 | run: | 136 | docker system prune -af --volumes 137 | -------------------------------------------------------------------------------- /final/Containerfile: -------------------------------------------------------------------------------- 1 | # Builds community-ansible-dev-tools-container-base image which provides 2 | # container-in-container support and all installs all binary dependencies 3 | FROM community-ansible-dev-tools-base:latest 4 | 5 | USER root 6 | 7 | # When building for multiple-architectures in parallel using emulation 8 | # it's really easy for one/more dnf processes to timeout or mis-count 9 | # the minimum download rates. Bump both to be extremely forgiving of 10 | # an overworked host. 11 | RUN echo -e "\n\n# Added during image build" >> /etc/dnf/dnf.conf && \ 12 | echo -e "minrate=100\ntimeout=60\n" >> /etc/dnf/dnf.conf 13 | 14 | LABEL org.opencontainers.image.source https://github.com/ansible-community/community-ansible-dev-tools-container 15 | LABEL org.opencontainers.image.authors "Ansible DevTools" 16 | LABEL org.opencontainers.image.vendor "Red Hat" 17 | LABEL org.opencontainers.image.licenses "GPL-3.0" 18 | LABEL org.opencontainers.image.description "An execution environment targeted for Ansible content creators." 19 | 20 | 21 | RUN microdnf -y makecache && microdnf -y update 22 | RUN microdnf -y install shadow-utils 23 | RUN rpm --setcaps shadow-utils 2>/dev/null 24 | RUN \ 25 | microdnf install -y \ 26 | tar \ 27 | echo \ 28 | podman \ 29 | fuse-overlayfs \ 30 | openssh-clients \ 31 | zsh \ 32 | util-linux-user \ 33 | which \ 34 | git \ 35 | dumb-init \ 36 | # ansible-pylibssh needs: 37 | gcc \ 38 | git-core \ 39 | libssh-devel \ 40 | python3-markupsafe \ 41 | # ansible-navigator needs: 42 | ncurses \ 43 | oniguruma-devel \ 44 | python3-bcrypt \ 45 | python3-cffi \ 46 | python3-pip \ 47 | python3-pyyaml \ 48 | python3-ruamel-yaml \ 49 | python3-wheel \ 50 | --exclude container-selinux \ 51 | && microdnf clean all 52 | 53 | RUN useradd podman; \ 54 | echo -e "podman:1:999\npodman:1001:64535" > /etc/subuid; \ 55 | echo -e "podman:1:999\npodman:1001:64535" > /etc/subgid; 56 | 57 | ARG _REPO_URL="https://raw.githubusercontent.com/containers/image_build/main/podman" 58 | ADD $_REPO_URL/containers.conf /etc/containers/containers.conf 59 | ADD $_REPO_URL/podman-containers.conf /home/podman/.config/containers/containers.conf 60 | 61 | RUN mkdir -p /home/podman/.local/share/containers && \ 62 | chown podman:podman -R /home/podman && \ 63 | chmod 644 /etc/containers/containers.conf 64 | 65 | # this is done by ansible-builder when changing user and workdir 66 | RUN chgrp 0 /home/podman && chmod -R ug+rwx /home/podman 67 | 68 | # Copy & modify the defaults to provide reference if runtime changes needed. 69 | # Changes here are required for running with fuse-overlay storage inside container. 70 | RUN sed -e 's|^#mount_program|mount_program|g' \ 71 | -e '/additionalimage.*/a "/var/lib/shared",' \ 72 | -e 's|^mountopt[[:space:]]*=.*$|mountopt = "nodev,fsync=0"|g' \ 73 | /usr/share/containers/storage.conf \ 74 | > /etc/containers/storage.conf 75 | 76 | # Note VOLUME options must always happen after the chown call above 77 | # RUN commands can not modify existing volumes 78 | VOLUME /var/lib/containers 79 | VOLUME /home/podman/.local/share/containers 80 | 81 | RUN mkdir -p /var/lib/shared/overlay-images \ 82 | /var/lib/shared/overlay-layers \ 83 | /var/lib/shared/vfs-images \ 84 | /var/lib/shared/vfs-layers && \ 85 | touch /var/lib/shared/overlay-images/images.lock && \ 86 | touch /var/lib/shared/overlay-layers/layers.lock && \ 87 | touch /var/lib/shared/vfs-images/images.lock && \ 88 | touch /var/lib/shared/vfs-layers/layers.lock 89 | 90 | ENV _CONTAINERS_USERNS_CONFIGURED="" 91 | ENV ANSIBLE_DEV_TOOLS_CONTAINER=1 92 | 93 | 94 | # In OpenShift, container will run as a random uid number and gid 0. Make sure things 95 | # are writeable by the root group. 96 | RUN for dir in \ 97 | /home/runner \ 98 | /home/runner/.ansible \ 99 | /home/runner/.ansible/tmp \ 100 | /runner \ 101 | /home/runner \ 102 | /runner/env \ 103 | /runner/inventory \ 104 | /runner/project \ 105 | /runner/artifacts ; \ 106 | do mkdir -m 0775 -p $dir ; chmod -R g+rwx $dir ; chgrp -R root $dir ; done && \ 107 | for file in \ 108 | /home/runner/.ansible/galaxy_token \ 109 | /etc/passwd \ 110 | /etc/group ; \ 111 | do touch $file ; chmod g+rw $file ; chgrp root $file ; done 112 | 113 | # base ansible-dev-tools setup 114 | 115 | COPY ./requirements.txt requirements.txt 116 | RUN python3 -m pip install --no-cache-dir -r requirements.txt 117 | 118 | RUN \ 119 | mkdir -p ~/.ansible/roles /usr/share/ansible/roles /etc/ansible/roles && \ 120 | git config --system --add safe.directory / 121 | 122 | # The dev container for docker runs as podman 123 | RUN chsh -s $(which zsh) podman 124 | # The dev container for docker runs as root 125 | RUN chsh -s $(which zsh) root 126 | 127 | 128 | # Install oh-my-zsh for both users 129 | USER podman 130 | RUN sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" 131 | 132 | USER root 133 | RUN sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" 134 | 135 | # add some helpful CLI commands to check we do not remove them inadvertently and output some helpful version information at build time. 136 | RUN set -ex \ 137 | && ansible --version \ 138 | && ansible-lint --version \ 139 | && ansible-runner --version \ 140 | && molecule --version \ 141 | && molecule drivers \ 142 | && podman --version \ 143 | && python3 --version \ 144 | && git --version \ 145 | && ansible-galaxy role list \ 146 | && ansible-galaxy collection list \ 147 | && rpm -qa \ 148 | && uname -a 149 | 150 | # Make a workdir usable by either the podman or root user 151 | RUN mkdir -p /workdir && chown podman:podman /workdir 152 | 153 | # Set the default user to podman, this will be overriden in the podman dev container 154 | USER podman 155 | WORKDIR /workdir 156 | ENTRYPOINT ["/opt/builder/bin/entrypoint", "dumb-init"] 157 | CMD ["zsh"] 158 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![ci](https://github.com/ansible/community-ansible-dev-tools-container/actions/workflows/ci.yml/badge.svg?branch=main&event=schedule)](https://github.com/ansible/community-ansible-dev-tools-container/actions/workflows/ci.yml) 2 | [![publish](https://github.com/ansible/community-ansible-dev-tools-container/actions/workflows/cd.yml/badge.svg?branch=main)](https://github.com/ansible/community-ansible-dev-tools-container/actions/workflows/cd.yml) 3 | 4 | # Notice 5 | The container defintion and build have moved into the repository for the ansible-dev-tools project: 6 | 7 | [Docs](https://ansible.readthedocs.io/projects/dev-tools/container/) 8 | 9 | [Repo](https://github.com/ansible/ansible-dev-tools) 10 | 11 | 12 | # community-ansible-dev-tools 13 | 14 | A container image for Ansible Development Tools (ADT). 15 | 16 | The ADT python package provides an easy way to install and discover the best tools available to create and test ansible content. 17 | More details on ADT can be found in . 18 | 19 | This image is built on top of [Fedora 39 minimal](quay.io/fedora/fedora-minimal:39) and has container-in-container support with [`podman`](https://podman.io/docs). 20 | 21 | ## Installation 22 | 23 | ```bash 24 | podman pull ghcr.io/ansible/community-ansible-dev-tools:latest 25 | ``` 26 | 27 | ## Usage 28 | 29 | ### Using this as a VS code Dev Container 30 | 31 | Dev Containers provide you with a containerized development environment in VS code. Details on what they are and how to use them can be found in [Developing inside a Container](https://code.visualstudio.com/docs/devcontainers/containers). 32 | 33 | This image can be used as an image for a Dev Container where you build and consume Ansible content. 34 | 35 | This repository comes with a sample [`.devcontainer directory`](https://github.com/ansible/community-ansible-dev-tools-container/tree/main/.devcontainer) with 2 subdirectories - `podman` and `docker` each having it's own 36 | `devcontainer.json` file. 37 | 38 | You can simply copy over the `.devcontainer` directory to your Ansible project and start using it! 39 | 40 | ### Using this with Github Codespaces 41 | 42 | To use this image with [Github Codespaces](https://docs.github.com/en/codespaces/overview), copy the [`devcontainer.json`](https://github.com/ansible/community-ansible-dev-tools-container/blob/main/.devcontainer/devcontainer.json) in this repo to your project and push to Github. 43 | 44 | **Note:** If you are planning to start writing a new Ansible playbook project or collection, use [Ansible Creator](https://ansible.readthedocs.io/projects/creator) to scaffold it for you and your project/collection will already have all the `.devcontainer` files ready. 45 | 46 | ### Using this image as an EE 47 | 48 | This image can also be used as an Ansible Execution Environment (EE). If you're not familiar with what an EE is, checkout the documentation in [Getting started with EE](https://ansible.readthedocs.io/en/latest/getting_started_ee/index.html). It is shipped with the following Ansible collections: 49 | 50 | - ansible.netcommon 51 | - ansible.posix 52 | - ansible.scm 53 | - ansible.utils 54 | 55 | You can also create a new EE based on this with more Ansible collections (or Python/System packages) of your choice by using Ansible Builder. Read this [documentation](https://ansible.readthedocs.io/projects/builder/en/latest/) to know about ansible-builder. 56 | 57 | The below example shows how to make a custom EE that adds the `amazon.aws` and `cisco.nxos` collections as well as the `ansible-pylibssh` python package to this image. 58 | 59 | 1. Create an `execution-environment.yml` file with the following content. 60 | 61 | ```yaml 62 | --- 63 | version: 3 64 | 65 | images: 66 | base_image: ghcr.io/ansible/community-ansible-dev-tools-container:latest 67 | 68 | dependencies: 69 | galaxy: requirements.yml 70 | python: requirements.txt 71 | ``` 72 | 73 | 2. Populate `requirements.txt` and `requirements.yml` with the respective contents. 74 | 75 | requirements.txt 76 | 77 | ```bash 78 | ansible-pylibssh==1.1.0 79 | ``` 80 | 81 | requirements.yml 82 | 83 | ```yaml 84 | --- 85 | collections: 86 | - name: amazon.aws 87 | - name: cisco.nxos 88 | ``` 89 | 90 | 3. Use `ansible-builder` to create the new EE. 91 | 92 | ```bash 93 | ansible-builder build -t custom-ee:latest --prune-images -v3 94 | ``` 95 | 96 | Once this image is built, you can use [`ansible-navigator`](https://ansible.readthedocs.io/projects/navigator/) to reference this image and run your playbooks! 97 | 98 | ### Using with podman from the command-line 99 | 100 | 101 | If you want to use this image with `podman` the following command to run the container. 102 | 103 | ```bash 104 | podman run -it --rm \ 105 | --cap-add=SYS_ADMIN \ 106 | --cap-add=SYS_RESOURCE \ 107 | --device "/dev/fuse" \ 108 | --hostname=ansible-dev-container \ 109 | --name=ansible-dev-container \ 110 | --security-opt "apparmor=unconfined" \ 111 | --security-opt "label=disable" \ 112 | --security-opt "seccomp=unconfined" \ 113 | --user=root \ 114 | --userns=host \ 115 | -e SSH_AUTH_SOCK=$SSH_AUTH_SOCK \ 116 | -v ansible-dev-tools-container-storage:/var/lib/containers \ 117 | -v $HOME/.gitconfig:/root/.gitconfig \ 118 | -v $PWD:/workdir \ 119 | -v $SSH_AUTH_SOCK:$SSH_AUTH_SOCK \ 120 | ghcr.io/ansible/community-ansible-dev-tools:latest 121 | ``` 122 | 123 | Note: 124 | - The `security-opt` and `cap-add` options are used to allow `podman` to run in the container. 125 | - The `device` option is used to allow the container to access the `/dev/fuse` device. 126 | - `userns=host` maps the default user account to root user in container. 127 | - This command will mount the current directory to `/workdir` in the container 128 | - The SSH agent socket is also mounted to the container to allow for SSH key forwarding. 129 | - The user's `.gitconfig` is mounted to the container to allow for git operations. 130 | - The `ansible-dev-tools-container-storage` volume is mounted to the container to store the nested container images on the host. 131 | 132 | ### Signing git commits (SSH) 133 | 134 | If the `user.signingkey` in the `gitconfig` points directly public key on the file system that key may not be available in the container. 135 | 136 | If only one key is preset, the `ssh-add` command can be used for key retrieval in the user's `gitconfig`: 137 | 138 | ```toml 139 | [gpg "ssh"] 140 | defaultKeyCommand = ssh-add -L 141 | ``` 142 | 143 | Alternatively, the public key can added in-line in the `gitconfig` 144 | 145 | ```toml 146 | [user] 147 | email = user@compnay.com 148 | name = User's fullname 149 | signingkey = key:: ssh-rsa AAAAB3N 150 | ``` 151 | 152 | ### Layering ADT and container-in-container support on a custom image 153 | 154 | In order to add the Ansible Devtools package and the container-in-container support with podman using a custom EE or another container image, you can use to the [final 155 | Containerfile](https://github.com/ansible/community-ansible-dev-tools-container/blob/main/final/Containerfile) from this repository. Update the `FROM` instruction to point to 156 | your preferred image and build it using `podman` or `docker`. 157 | 158 | **Note:** The container-in-container support is added with the help of the [podman image](https://github.com/containers/image_build/tree/main/podman) definition. For more information, read [How to use Podman inside of a container](https://www.redhat.com/sysadmin/podman-inside-container). 159 | 160 | ## Related Links 161 | 162 | - [adt](https://github.com/ansible/ansible-dev-tools) 163 | - [ansible-builder](https://github.com/ansible/ansible-builder) 164 | - [ansible-creator](https://github.com/ansible/ansible-creator) 165 | - [podman](https://github.com/containers/podman/) 166 | 167 | ## Code of Conduct 168 | 169 | 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). 170 | 171 | ## License 172 | 173 | GNU General Public License v3.0 or later. 174 | 175 | See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text. 176 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------