Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nleiva/capirca_acl
This collection includes a module (translate) to use Capirca from your Ansible playbooks.
https://github.com/nleiva/capirca_acl
acl ansible ansible-galaxy ansible-modules arista cisco iptables juniper nftables paloalto security
Last synced: 8 days ago
JSON representation
This collection includes a module (translate) to use Capirca from your Ansible playbooks.
- Host: GitHub
- URL: https://github.com/nleiva/capirca_acl
- Owner: nleiva
- License: gpl-3.0
- Created: 2020-06-10T20:51:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-10T20:17:32.000Z (over 1 year ago)
- Last Synced: 2023-07-10T21:27:12.819Z (over 1 year ago)
- Topics: acl, ansible, ansible-galaxy, ansible-modules, arista, cisco, iptables, juniper, nftables, paloalto, security
- Language: Python
- Homepage:
- Size: 95.7 KB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Capirca ACL Collection for Ansible
This repo hosts an unofficial [Capirca](https://github.com/google/capirca) Ansible Collection.
This collection includes a module ([translate](docs/translate.md)) to use
[Capirca](https://github.com/google/capirca) from your Ansible playbooks as well as a lookup
plugins for resolving symbols into networks and services.
## Included content
Click on the name of a plugin or module to view that content's documentation:
- **Modules**:
- [translate](docs/translate.md)
- **Plugins**:
- `network`: Lookup network definition.
- `service`: Lookup service definition.
## Installation and Usage
### Installing the Collection from Ansible Galaxy
Before using this collection, you need to install it with the Ansible [Galaxy](https://galaxy.ansible.com/nleiva/capirca_acl) CLI:
ansible-galaxy collection install nleiva.capirca_acl
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
---
collections:
- name: nleiva.capirca_acl
version: 0.3.1
```
### Using modules from the Capirca ACL Collection in your playbooks
You can either call modules by their Fully Qualified Collection Namespace (FQCN), like `nleiva.capirca_acl.translate`, or you can call modules by their short name if you list the `nleiva.capirca_acl` collection in the playbook's `collections`, like so:
```yaml
---
- hosts: localhost
gather_facts: no
connection: local
collections:
- nleiva.capirca_acl
tasks:
- name: Run this module to generate an ACL
translate:
platform: 'ciscoxr'
filter_options:
- ipv6-test-filter
- inet6
def_folder: "files/def"
pol_file: "files/policies/terms.pol"
register: testout
- name: Dump the resulting ACL
debug:
msg: '{{ testout.message }}'
```
See [translate](docs/translate.md) for more details.
### Using plugins from the Capirca ACL Collection in your playbooks
```yaml
- name: Lookup services
ansible.builtin.debug:
msg:
- "{{ lookup('nleiva.capirca_acl.service', 'HTTP', 'HTTPS', def_folder='tests/integration/targets/translate/files/def') }}"
# '80/tcp,443/tcp'
- name: Lookup network
ansible.builtin.debug:
msg:
- "{{ lookup('nleiva.capirca_acl.network', 'WEB_SERVERS', def_folder='tests/integration/targets/translate/files/def') }}"
# [IPv4('200.1.1.1/32'), IPv4('200.1.1.2/32')]
```
### Run an example
The example documented in [translate](docs/translate.md) can be run with:
```bash
make example
```
## Testing and Development
### Testing with `ansible-test`
The `tests` directory contains configuration for running sanity and integration tests using [`ansible-test`](https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html).
You can run the collection's test suites with the command:
```bash
make test-remote
```
### Testing locally with Ansible
You can run the collection's test suites without [`ansible-test`](https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html) with the command:
```bash
make test-local
```
## Publishing New Versions
We first need to make sure the test cases run successfully:
```bash
make test-local
```
Then we need to TAG the version with a version number greater than the latest one:
And finally, build:
```
make build
```
It will end up on [Capirca Collection](https://galaxy.ansible.com/nleiva/capirca_acl) Galaxy page](https://galaxy.ansible.com/nleiva/capirca_acl) if you have access to the namespace.
## More Information
For more information about [Capirca](https://github.com/google/capirca), join the `#capirca` channel on [NetworkToCode Slack](https://networktocode.slack.com/), and browse the resources in the [Capirca Wiki](https://github.com/google/capirca/wiki) page.
- [Multi-Platform ACL Generation and Testing](https://rvasec.com/slides/2013/Watson-Capirca.pdf)
- [Capirca Wiki](https://github.com/google/capirca/wiki)
## License
GNU General Public License v3.0 or later
See [LICENCE](LICENSE) to see the full text.