Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-30 04:01:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

add dev notes about config rules

Browse Source
This commit is contained in:
Lucy Cifferello
2021-03-09 15:21:11 -07:00
parent 431ab7c7f8
commit 7acc51a354
2 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
source/contributing/services/config.rst
View File

@@ -508,7 +508,7 @@ Example:
Config Rules
============
This file defines the configuration rules, or the rule-set that defines dependencies between config variables.
This file defines the configuration rules, or the rule-set that defines dependencies between config variables. In practice, config rules are for auto-configuring self dependencies. Self dependencies are internal dependencies of a service, such as if the setting of one config variable informs the option of another setting. These "dependencies" are configured as rules.
A rule is a boolean expression that we demand to be true. It is not true if the expression fails the rule parser.
@@ -526,6 +526,9 @@ Variables can be booleans, numbers, or strings, and have a different syntax depe
- ``'`` - Cast the value into a string. Applies to any value except for an object or a list.
- ``!`` - Equals not.
.. note::
Config rules are processed in order.
If application does not satisfy a rule, a set of suggestions should be provided. These suggestions are in the form of the operation to preform:
- ``Set`` - set the value