Skip to content

Commit

Permalink
Reference variables and hyperlink them with any.
Browse files Browse the repository at this point in the history
Related to debops/docs#140.
  • Loading branch information
ypid committed May 28, 2016
1 parent 7504739 commit 0cd0b70
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
12 changes: 6 additions & 6 deletions defaults/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ ferm__enabled: '{{ True
# .. envvar:: ferm__flush
#
# Should ferm-rules be flushed when :program:`ferm` is disabled? The default is true,
# but you may need set both ``ferm__enabled`` and this to ``False`` if you are
# but you may need set both :any:`ferm__enabled` and this to ``False`` if you are
# running in some container and are not allowed to change :command:`iptables`.
ferm__flush: '{{ ferm__enabled | bool }}'

Expand Down Expand Up @@ -280,31 +280,31 @@ ferm__dependent_rules: []

# .. envvar:: ferm_input_list
#
# List of iptables INPUT rules to manage. See :ref:`ferm_input_list` for more
# List of iptables INPUT rules to manage. See :ref:`ferm__ref_input_list` for more
# details. This is a legacy variable and shouldn't be used.
ferm_input_list: []


# .. envvar:: ferm_input_group_list
#
# List of iptables INPUT rules to manage for a host group. See
# :ref:`ferm_input_list` for more details. This is a legacy variable and
# :ref:`ferm__ref_input_list` for more details. This is a legacy variable and
# shouldn't be used.
ferm_input_group_list: []


# .. envvar:: ferm_input_host_list
#
# List of iptables INPUT rules to manage for an individual host. See
# :ref:`ferm_input_list` for more details. This is a legacy variable and
# :ref:`ferm__ref_input_list` for more details. This is a legacy variable and
# shouldn't be used.
ferm_input_host_list: []


# .. envvar:: ferm_input_dependent_list
#
# List of iptables INPUT rules to manage in dependency to other rules. See
# :ref:`ferm_input_list` for more details. This is a legacy variable and
# :ref:`ferm__ref_input_list` for more details. This is a legacy variable and
# shouldn't be used.
ferm_input_dependent_list: []

Expand Down Expand Up @@ -575,7 +575,7 @@ ferm__rules_filter_reject_all:

# .. envvar:: ferm__rules_fail2ban
#
# fail2ban support rules for ferm.
# ``fail2ban`` support rules for ferm.
ferm__rules_fail2ban:

- type: 'fail2ban'
Expand Down
8 changes: 4 additions & 4 deletions docs/defaults-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ them.
:local:
:depth: 1

.. _ferm_input_list:
.. _ferm__ref_input_list:

ferm_input_list
---------------
Expand All @@ -20,8 +20,8 @@ instead in new configuration, the legacy variables will be removed at some
point.

List of ferm INPUT rules that should be present or absent in the firewall rule
set. The same format is also used for ``ferm_input_group_list``,
``ferm_input_host_list`` and ``ferm_input_dependent_list``. Each rule is
set. The same format is also used for :any:`ferm_input_group_list`,
:any:`ferm_input_host_list` and :any:`ferm_input_dependent_list`. Each rule is
defined as a YAML dict with the following keys:

``type``
Expand All @@ -43,5 +43,5 @@ defined as a YAML dict with the following keys:
Optional. Delete specified rule file. Possible values: ``False`` or ``True``

Depending on the chosen type, many additional variables are supported. Please
check the template files located in the ``templates/etc/ferm/filter-input.d/``
check the template files located in the :file:`templates/etc/ferm/filter-input.d/`
directory.

0 comments on commit 0cd0b70

Please sign in to comment.