firewalld-formula
A SaltStack Formula to set up and configure Firewalld, a dynamically managed firewall with support for network/firewall zones to define the trust level of network connections or interfaces.
1. General notes
See the full SaltStack Formulas installation and usage instructions.
If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.
If you want to use this formula, please pay attention to the FORMULA
file and/or git tag, which contains the currently released version.
This formula is versioned according to Semantic
Versioning.
See Formula Versioning Section for more details.
If you need (non-default) configuration, please pay attention to the
pillar.example file and/or Special notes section.
2. Contributing to this repo
Commit message formatting is significant!!
Please see How to contribute for more details.
4. TODO
-
configure local pre-commit hooks (code syntax check based on file extension, check for ugly utf-8 mac os white space)
5. Instructions
-
Add this repository as a GitFS backend in your Salt master config.
-
Configure your Pillar top file (
/srv/pillar/top.sls), see pillar.example -
Include this Formula within another Formula or simply define your needed states within the Salt top file (
/srv/salt/top.sls).
8. Contributions
Contributions are always welcome. All development guidelines you have to know are
-
write clean code (proper YAML+Jinja syntax, no trailing whitespaces, no empty lines with whitespaces, LF only)
-
set sane default settings
-
test your code
-
update README.rst doc
12. Testing
Linux testing is done with kitchen-salt.
12.1. Requirements
-
Ruby
-
Docker
$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]Where [platform] is the platform name defined in kitchen.yml, e.g.
debian-9-2019-2-py3.
12.2. bin/kitchen converge
Creates the docker instance and runs the firewalld main state, ready
for testing.