Firewalld formula
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Imran Iqbal abbfe162a1
chore(pre-commit): use `info` report level for `rstcheck` [skip ci]
3 weeks ago
.github/workflows ci(workflows/commitlint): add to repo [skip ci] 1 year ago
bin ci(pre-commit): add to formula [skip ci] 8 months ago
docs chore(release): 1.2.1 [skip ci] 2 months ago
firewalld fix(zone.xml): fix jinja error in rule.reject 2 months ago
test/integration test(_mapdata): add verification file for `fedora-34` [skip ci] 2 months ago
.gitignore chore: standardise structure (`.gitignore` & `_mapdata.rb`) [skip ci] 4 months ago
.gitlab-ci.yml ci: add `arch-master` to matrix and update `.travis.yml` [skip ci] 1 month ago
.pre-commit-config.yaml chore(pre-commit): use `info` report level for `rstcheck` [skip ci] 3 weeks ago
.rstcheck.cfg chore(pre-commit): use `info` report level for `rstcheck` [skip ci] 3 weeks ago
.rubocop.yml test: standardise use of `share` suite & `_mapdata` state [skip ci] 3 months ago
.salt-lint feat(semantic-release): implement for this formula 2 years ago
.travis.yml ci: add `arch-master` to matrix and update `.travis.yml` [skip ci] 1 month ago
.yamllint chore: update `CODEOWNERS` & `.yamllint` re: `kitchen-vagrant` [skip ci] 2 months ago
AUTHORS.md chore(release): 1.2.1 [skip ci] 2 months ago
CHANGELOG.md chore(release): 1.2.1 [skip ci] 2 months ago
CODEOWNERS chore: update `CODEOWNERS` & `.yamllint` re: `kitchen-vagrant` [skip ci] 2 months ago
FORMULA chore(release): 1.2.1 [skip ci] 2 months ago
Gemfile test: standardise use of `share` suite & `_mapdata` state [skip ci] 3 months ago
Gemfile.lock ci(gemfile+lock): use `ssf` customised `kitchen-docker` repo [skip ci] 4 months ago
LICENSE feat: standardize license and hand over to saltstack formulas 1 year ago
VERSION Update pillar.example 3 years ago
commitlint.config.js chore(commitlint): add `{body,footer,header}-max(-line)-length` [skip ci] 8 months ago
kitchen.yml ci: add `arch-master` to matrix and update `.travis.yml` [skip ci] 1 month ago
pillar.example feat(pillar.example,test/): add example and test for richrule ratelimit 5 months ago
pre-commit_semantic-release.sh ci(gitlab-ci): use GitLab CI as Travis CI replacement 6 months ago
release-rules.js feat(semantic-release): implement for this formula 2 years ago
release.config.js ci(gitlab-ci): use GitLab CI as Travis CI replacement 6 months ago

docs/README.rst

.. _readme:

firewalld-formula
=================

|img_travis| |img_sr|

.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/firewalld-formula.svg?branch=master
:alt: Travis CI Build Status
:scale: 100%
:target: https://travis-ci.com/saltstack-formulas/firewalld-formula
.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
:alt: Semantic Release
:scale: 100%
:target: https://github.com/semantic-release/semantic-release

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.

.. contents:: **Table of Contents**

General notes
-------------

See the full `SaltStack Formulas installation and usage instructions
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.

If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas>`_.

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 <http://semver.org/>`_.

See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>`_ for more details.

If you need (non-default) configuration, please pay attention to the ``pillar.example`` file and/or `Special notes`_ section.

Contributing to this repo
-------------------------

**Commit message formatting is significant!!**

Please see `How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>`_ for more details.

Special notes
-------------

None

TODO
----

* configure local pre-commit hooks (code syntax check based on file extension, check for ugly *utf-8 mac os white space*)

Instructions
------------

1. Add this repository as a `GitFS <http://docs.saltstack.com/topics/tutorials/gitfs.html>`_ backend in your Salt master config.

2. Configure your Pillar top file (``/srv/pillar/top.sls``), see pillar.example

3. Include this Formula within another Formula or simply define your needed states within the Salt top file (``/srv/salt/top.sls``).

Additional resources
--------------------

None

Formula Dependencies
--------------------

None

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

Salt Compatibility
------------------

Tested with:

* 2018.3.x (will probably work too with 2017.x.x)

OS Compatibility
----------------

Tested with:

* CentOS 7
* Debian 9
* Ubuntu 18.04

Available states
----------------

.. contents::
:local:

``firewalld``
^^^^^^^^^^^^^

Manage firewalld

Testing
-------

Linux testing is done with ``kitchen-salt``.

Requirements
^^^^^^^^^^^^

* Ruby
* Docker

.. code-block:: bash

$ 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``.

``bin/kitchen converge``
^^^^^^^^^^^^^^^^^^^^^^^^

Creates the docker instance and runs the ``firewalld`` main state, ready for testing.

``bin/kitchen verify``
^^^^^^^^^^^^^^^^^^^^^^

Runs the ``inspec`` tests on the actual instance.

``bin/kitchen destroy``
^^^^^^^^^^^^^^^^^^^^^^^

Removes the docker instance.

``bin/kitchen test``
^^^^^^^^^^^^^^^^^^^^

Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.

``bin/kitchen login``
^^^^^^^^^^^^^^^^^^^^^

Gives you SSH access to the instance for manual testing.