-
Notifications
You must be signed in to change notification settings - Fork 12
Fixes #15478: missing documentation about api settings #68
Fixes #15478: missing documentation about api settings #68
Conversation
src/api_v2/settings.md
Outdated
@apiParam {Boolean} [unexpected_unbound_var_values] Allows multiple reports for configuration based on a multivalued variable: (default true) | ||
|
||
@apiParam {Boolean} [rudder_compute_changes] Compute list of changes (repaired reports) per rules (default true) | ||
@apiParam {Boolean} [rudder_generation_compute_dyngroups] Recompute all dynamic gorups at the start of policy generation (default true) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
groups
src/api_v2/settings.md
Outdated
|
||
@apiParam {Boolean} [rudder_compute_changes] Compute list of changes (repaired reports) per rules (default true) | ||
@apiParam {Boolean} [rudder_generation_compute_dyngroups] Recompute all dynamic gorups at the start of policy generation (default true) | ||
@apiParam {Boolean} [rudder_save_db_compliance_levels] Store in database all compliance levels (default true) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Store all compliance levels in database
src/api_v2/settings.md
Outdated
@apiParam {Boolean} [rudder_compute_changes] Compute list of changes (repaired reports) per rules (default true) | ||
@apiParam {Boolean} [rudder_generation_compute_dyngroups] Recompute all dynamic gorups at the start of policy generation (default true) | ||
@apiParam {Boolean} [rudder_save_db_compliance_levels] Store in database all compliance levels (default true) | ||
@apiParam {Boolean} [rudder_save_db_compliance_details] Store in database all compliance details (default false) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same
src/api_v2/settings.md
Outdated
@apiParam {String} [node_onaccept_default_state] Set default state for node when they are accepted within Rudder, can be "enabled", "ignored", "empty-policies", "initializing", "preparing-eol" | ||
@apiParam {String} [node_onaccept_default_policyMode] Default policy mode for accepted node, can be "default", "enforce" or "audit" | ||
|
||
@apiParam {Boolean} [unexpected_allows_duplicate] Ignore duplicated compliance report (default true) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
reports
src/api_v2/settings.md
Outdated
@apiParam {String} [node_onaccept_default_policyMode] Default policy mode for accepted node, can be "default", "enforce" or "audit" | ||
|
||
@apiParam {Boolean} [unexpected_allows_duplicate] Ignore duplicated compliance report (default true) | ||
@apiParam {Boolean} [unexpected_unbound_var_values] Allows multiple reports for configuration based on a multivalued variable: (default true) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/://
src/api_v2/settings.md
Outdated
@apiParam {Boolean} [unexpected_unbound_var_values] Allows multiple reports for configuration based on a multivalued variable: (default true) | ||
|
||
@apiParam {Boolean} [rudder_compute_changes] Compute list of changes (repaired reports) per rules (default true) | ||
@apiParam {Boolean} [rudder_generation_compute_dyngroups] Recompute all dynamic gorups at the start of policy generation (default true) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
gorups/groups
src/api_v2/settings.md
Outdated
@apiParam {Boolean} [rudder_save_db_compliance_details] Store in database all compliance details (default false) | ||
|
||
@apiParam {String} [rudder_generation_max_parallelism] Set the policy generation parrallelism, either in as an number of thread (i.e. 4), or a multiplicative of the number of core (x0.5) (default 0.5) | ||
@apiParam {Int} [rudder_generation_js_timeout] Policy generation JS evaluation of directive parameter timeout in seconds(default 30) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing space before parenthesis
src/api_v2/settings.md
Outdated
|
||
@apiParam {String} [rudder_generation_max_parallelism] Set the policy generation parrallelism, either in as an number of thread (i.e. 4), or a multiplicative of the number of core (x0.5) (default 0.5) | ||
@apiParam {Int} [rudder_generation_js_timeout] Policy generation JS evaluation of directive parameter timeout in seconds(default 30) | ||
@apiParam {Boolean} [rudder_generation_continue_on_error] Policy generation continues on NodeConfiguration evaluation (default false) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"continues on error"? (or am I missing something?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
indeed on error
src/api_v2/settings.md
Outdated
@apiParam {Boolean} [rudder_save_db_compliance_levels] Store in database all compliance levels (default true) | ||
@apiParam {Boolean} [rudder_save_db_compliance_details] Store in database all compliance details (default false) | ||
|
||
@apiParam {String} [rudder_generation_max_parallelism] Set the policy generation parrallelism, either in as an number of thread (i.e. 4), or a multiplicative of the number of core (x0.5) (default 0.5) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/in//
src/api_v2/settings.md
Outdated
@@ -128,9 +147,14 @@ https://github.com/Normation/rudder/blob/branches/rudder/4.1/rudder-web/src/main | |||
|
|||
@apiParam {Boolean} [require_time_synchronization] Require time synchronization between nodes and policy server | |||
|
|||
@apiParam {String} [relay_server_synchronization_method] Method used to synchronize data between Rudder Server and Relays, either "classic" (agent protocol, default), "rsync" (use rsync to synchronize, that you'll need to be manually set up), or "disabled" (use third party system to transmit data) | |||
@apiParam {Boolean} [relay_server_synchronize_policies] If "rsync" is set as a synchronization method, use rsync to synchronize policies between Rudder Server and Relays. If false, you'll have to synchronize yourself policies. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
synchronize policies yourself
src/api_v2/settings.md
Outdated
@@ -128,9 +147,14 @@ https://github.com/Normation/rudder/blob/branches/rudder/4.1/rudder-web/src/main | |||
|
|||
@apiParam {Boolean} [require_time_synchronization] Require time synchronization between nodes and policy server | |||
|
|||
@apiParam {String} [relay_server_synchronization_method] Method used to synchronize data between Rudder Server and Relays, either "classic" (agent protocol, default), "rsync" (use rsync to synchronize, that you'll need to be manually set up), or "disabled" (use third party system to transmit data) | |||
@apiParam {Boolean} [relay_server_synchronize_policies] If "rsync" is set as a synchronization method, use rsync to synchronize policies between Rudder Server and Relays. If false, you'll have to synchronize yourself policies. | |||
@apiParam {Boolean} [relay_server_synchronize_shared_files] If "rsync" is set as a synchronization method, use rsync to synchronize shared files between Rudder Server and Relays. If false, you'll have to synchronize yourself policies. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same
9c80b00
to
fb494e3
Compare
Commit modified |
OK, merging this PR |
https://issues.rudder.io/issues/15478