codekaizen-github / cloudflare-ansible-collection

GNU General Public License v3.0
0 stars 0 forks source link

Code_kaizen Cloudflare Collection

This repository contains the code_kaizen.cloudflare Ansible Collection.

Ansible version compatibility

This collection has been tested against following Ansible versions: >=2.14.0.

For collections that support Ansible 2.9, please ensure you update your network_os to use the fully qualified collection name (for example, cisco.ios.ios). Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.

External requirements

Some modules and plugins require external libraries. Please check the requirements for each plugin or module you use in the documentation to find out which requirements are needed.

Included content

Please check the included content on the Ansible Galaxy page for this collection.

Hello_world filter plugins

filter plugin.

Name Description
code_kaizen.cloudflare.hello_world Returns Hello message.

Modules

Name Description
code_kaizen.cloudflare.cfd_tunnel Manage Cloudflare Tunnel

Using this collection

    ansible-galaxy collection install code_kaizen.cloudflare

You can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml using the format:

collections:
  - name: code_kaizen.cloudflare

To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install code_kaizen.cloudflare --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax where X.Y.Z can be any available version:

ansible-galaxy collection install code_kaizen.cloudflare:==X.Y.Z

See Ansible Using collections for more details.

Contributing

Running Tests

Run all tox integration tests:

python -m tox --ansible --conf tox-ansible.ini

Run tox integration tests for a specific environment:

python -m tox --conf tox-ansible.ini --ansible -e sanity-py3.12-devel

Run tox integration tests for a specific scenario:

# Unit
python -m tox --conf tox-ansible.ini --ansible --matrix-scope unit
# Integration
python -m tox --conf tox-ansible.ini --ansible --matrix-scope integration

Run tox integration tests for a specific environment and a specific scenario:

# Unit
python -m tox --conf tox-ansible.ini --ansible -e sanity-py3.12-devel --matrix-scope unit
# Integratino
python -m tox --conf tox-ansible.ini --ansible -e sanity-py3.12-devel --matrix-scope integration

Release notes

See the changelog.

Roadmap

More information

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.