ansibleguy / collection_opnsense

Ansible Collection to manage OPNSense firewalls using their API
https://opnsense.ansibleguy.net
GNU General Public License v3.0
267 stars 36 forks source link

Feature: Add support for Nginx plugin #64

Open atammy-narmi opened 8 months ago

atammy-narmi commented 8 months ago

Link to API

https://docs.opnsense.org/development/api/plugins/nginx.html

Description

Only squid proxy seems to have a plugin, I'd like to have nginx support as well. I'm happy to help with the development as well, will start by making some PRs 😸

Modules

ansibleguy commented 8 months ago

Greetings!

I have planned to prioritize other APIs - so I don't think I'll find time in the next few months/this year..

But I am open to helping you implement it yourself! The developer docs should give you a basic overview of how to do that. But these infos are far from perfect/complete. Feel free to contact me if you have troubles understanding any relations.

We'll need to create multiple modules - one for each functionality the service/API provides. Of course - you can stick to the ones you practically need.. (I haven't used it yet as I keep my services strictly separated from the firewall itself)

So these may be the modules:

atammy-narmi commented 8 months ago

Thanks, I was able to get the upstream_server working, I've also added some tests FWIW. Will also start working on other modules.

What is the documentation procedure?

ansibleguy commented 6 months ago

What is the documentation procedure?

Greetings!

I've pushed the basic docs template. Please (at least) add the existing module arguments with a little description.