Skip to content
This repository has been archived by the owner on Mar 5, 2020. It is now read-only.

Fixes #15478: missing documentation about api settings #68

Merged
merged 1 commit into from
Aug 14, 2019
Merged

Fixes #15478: missing documentation about api settings #68

merged 1 commit into from
Aug 14, 2019

Conversation

ncharles
Copy link
Member

amousset
amousset reviewed Aug 14, 2019
View reviewed changes
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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

groups

amousset
amousset reviewed Aug 14, 2019
View reviewed changes
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)
Copy link
Member

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

amousset
amousset reviewed Aug 14, 2019
View reviewed changes
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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

amousset
amousset reviewed Aug 14, 2019
View reviewed changes
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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reports

amousset
amousset reviewed Aug 14, 2019
View reviewed changes
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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/://

amousset
amousset reviewed Aug 14, 2019
View reviewed changes
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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gorups/groups

amousset
amousset reviewed Aug 14, 2019
View reviewed changes
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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing space before parenthesis

amousset
amousset reviewed Aug 14, 2019
View reviewed changes
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)
Copy link
Member

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?)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

indeed on error

amousset
amousset reviewed Aug 14, 2019
View reviewed changes
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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/in//

amousset
amousset reviewed Aug 14, 2019
View reviewed changes
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

synchronize policies yourself

amousset
amousset reviewed Aug 14, 2019
View reviewed changes
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

@ncharles ncharles force-pushed the bug_15478/missing_documentation_about_api_settings branch from 9c80b00 to fb494e3 Compare August 14, 2019 14:08
@ncharles
Copy link
Member Author

Commit modified

@Normation-Quality-Assistant
Copy link

OK, merging this PR

@Normation-Quality-Assistant Normation-Quality-Assistant merged commit fb494e3 into Normation:master Aug 14, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@amousset amousset amousset approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
3 participants
@ncharles @Normation-Quality-Assistant @amousset