mirror of
https://github.com/containers/ansible-podman-collections.git
synced 2026-02-04 07:11:49 +00:00
Update README and tests
This commit is contained in:
Sagi Shnaidman
Sergey
parent
c98febf26a
commit
2bafc01e3c
5 changed files with 114 additions and 29 deletions
|
|
@ -89,7 +89,8 @@ jobs:
|
|||
~/.local/bin/ansible-galaxy collection install .cache/collection-tarballs/*.tar.gz
|
||||
- name: Run collection sanity tests
|
||||
run: >-
|
||||
~/.local/bin/ansible-test sanity --color --requirements --docker --python "${{ matrix.python-version }}" -vvv
|
||||
~/.local/bin/ansible-test sanity --color --requirements --python "${{ matrix.python-version }}" -vvv
|
||||
plugins/ tests/
|
||||
working-directory: >-
|
||||
/home/runner/.ansible/collections/ansible_collections/containers/podman
|
||||
|
||||
|
|
|
|||
112
README.md
112
README.md
|
|
@ -1,27 +1,105 @@
|
|||
[](https://github.com/containers/ansible-podman-collections/actions?query=workflow%3A%22Collection%20build%20and%20tests)
|
||||
|
||||
Ansible Collection: containers.podman
|
||||
=================================================
|
||||
Basic Ansible modules for podman containers.
|
||||
# Ansible Collection: containers.podman
|
||||
|
||||
This repo hosts the `containers.podman` Ansible Collection.
|
||||
|
||||
The collection includes the Podman container plugins to help the build and management of Podman containers.
|
||||
|
||||
## Installation and Usage
|
||||
|
||||
### Installing the Collection from Ansible Galaxy
|
||||
|
||||
Before using the Podman collection, you need to install the collection with the `ansible-galaxy` CLI:
|
||||
|
||||
`ansible-galaxy collection install containers.podman`
|
||||
|
||||
You can also include it in a `requirements.yml` file and install it via
|
||||
`ansible-galaxy collection install -r requirements.yml` using the format:
|
||||
|
||||
```yaml
|
||||
- name: Run container
|
||||
podman_container:
|
||||
- name: web
|
||||
state: present
|
||||
image: ubuntu:14.04
|
||||
command: "sleep 1d"
|
||||
```
|
||||
|
||||
Install collection from galaxy:
|
||||
|
||||
```bash
|
||||
ansible-galaxy collection install containers.podman
|
||||
collections:
|
||||
- name: containers.podman
|
||||
```
|
||||
|
||||
or clone by your own:
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.ansible/collections/ansible_collections/containers/podman/
|
||||
git clone https://github.com/containers/ansible-podman-collections.git ~/.ansible/collections/ansible_collections/containers/podman/
|
||||
mkdir -p ~/.ansible/collections/ansible_collections/containers
|
||||
git clone https://github.com/containers/ansible-podman-collections.git ~/.ansible/collections/ansible_collections/containers/podman
|
||||
```
|
||||
|
||||
### Playbooks
|
||||
|
||||
To use a module from Podman collection, please reference the full namespace, collection name,
|
||||
and modules name that you want to use:
|
||||
|
||||
```yaml
|
||||
---
|
||||
- name: Using Podman collection
|
||||
hosts: localhost
|
||||
tasks:
|
||||
- name: Run redis container
|
||||
containers.podman.podman_container:
|
||||
name: myredis
|
||||
image: redis
|
||||
command: redis-server --appendonly yes
|
||||
state: present
|
||||
recreate: yes
|
||||
expose:
|
||||
- 6379
|
||||
volumes_from:
|
||||
- mydata
|
||||
```
|
||||
|
||||
Or you can add full namepsace and collecton name in the `collections` element:
|
||||
|
||||
```yaml
|
||||
---
|
||||
- name: Using Podman collection
|
||||
hosts: localhost
|
||||
collections:
|
||||
- containers.podman
|
||||
tasks:
|
||||
- name: Build and push an image using existing credentials
|
||||
podman_image:
|
||||
name: nginx
|
||||
path: /path/to/build/dir
|
||||
push: yes
|
||||
push_args:
|
||||
dest: quay.io/acme
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
We are accepting Github pull requests and issues.
|
||||
There are many ways in which you can participate in the project, for example:
|
||||
|
||||
- Submit bugs and feature requests, and help us verify them
|
||||
- Submit and review source code changes in Github pull requests
|
||||
- Add new modules for Podman containers and images
|
||||
|
||||
## Testing and Development
|
||||
|
||||
If you want to develop new content for this collection or improve what is already
|
||||
here, the easiest way to work on the collection is to clone it into one of the configured
|
||||
[`COLLECTIONS_PATHS`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths),
|
||||
and work on it there.
|
||||
|
||||
### Testing with `ansible-test`
|
||||
|
||||
We use `ansible-test` for sanity.
|
||||
|
||||
## More Information
|
||||
|
||||
TBD
|
||||
|
||||
## Communication
|
||||
|
||||
Please submit Github issues for communication any issues.
|
||||
You can ask Podman related questions on `#podman` channel of Ansible Podman questions
|
||||
on `#ansible-podman` channel on Freenode IRC.
|
||||
|
||||
## License
|
||||
|
||||
Apache-2.0
|
||||
|
|
|
|||
|
|
@ -15,11 +15,12 @@ documentation: https://github.com/containers/ansible-podman-collections
|
|||
homepage: https://github.com/containers/ansible-podman-collections
|
||||
issues: https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
|
||||
build_ignore:
|
||||
- ci
|
||||
- tests/output
|
||||
- build_artifact
|
||||
- "*.tar.gz"
|
||||
- zuul.yaml
|
||||
- .gitignore
|
||||
- tests/output
|
||||
- ".gitignore"
|
||||
- ".history"
|
||||
- ".vscode"
|
||||
- ".idea"
|
||||
- ".github"
|
||||
|
|
|
|||
|
|
@ -8,10 +8,13 @@ plugins/modules/podman_image_info.py validate-modules:parameter-type-not-in-doc
|
|||
plugins/modules/podman_container.py validate-modules:invalid-ansiblemodule-schema
|
||||
plugins/modules/podman_container.py validate-modules:missing-gplv3-license
|
||||
plugins/modules/podman_container.py validate-modules:parameter-list-no-elements
|
||||
plugins/modules/podman_container.py import-3.7!skip
|
||||
plugins/modules/podman_container.py import-2.6!skip
|
||||
plugins/modules/podman_container.py compile-2.6!skip
|
||||
plugins/modules/podman_container.py import-2.7!skip
|
||||
ci/run_connection_test.sh shebang!skip
|
||||
ci/run_containers_tests.sh shellcheck!skip
|
||||
ci/run_containers_tests.sh shebang!skip
|
||||
plugins/modules/podman_container.py import-3.5!skip
|
||||
plugins/modules/podman_container.py import-3.6!skip
|
||||
plugins/modules/podman_container.py import-3.7!skip
|
||||
plugins/modules/podman_container.py import-3.8!skip
|
||||
plugins/modules/podman_container.py import-3.9!skip
|
||||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
|
|
|
|||
|
|
@ -3,10 +3,12 @@ plugins/modules/podman_image.py validate-modules:parameter-type-not-in-doc
|
|||
plugins/modules/podman_image.py validate-modules:undocumented-parameter
|
||||
plugins/modules/podman_image_info.py validate-modules:parameter-type-not-in-doc
|
||||
plugins/modules/podman_container.py validate-modules!skip
|
||||
plugins/modules/podman_container.py import-3.7!skip
|
||||
plugins/modules/podman_container.py import-2.6!skip
|
||||
plugins/modules/podman_container.py compile-2.6!skip
|
||||
plugins/modules/podman_container.py import-2.7!skip
|
||||
ci/run_connection_test.sh shebang!skip
|
||||
ci/run_containers_tests.sh shellcheck!skip
|
||||
ci/run_containers_tests.sh shebang!skip
|
||||
plugins/modules/podman_container.py import-3.5!skip
|
||||
plugins/modules/podman_container.py import-3.6!skip
|
||||
plugins/modules/podman_container.py import-3.7!skip
|
||||
plugins/modules/podman_container.py import-3.8!skip
|
||||
tests/integration/targets/connection_buildah/runme.sh shellcheck:SC2086
|
||||
tests/integration/targets/connection_podman/runme.sh shellcheck:SC2086
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue