From 74ced79e130d69ed9bbd10cdea6bf23ebd7caaa6 Mon Sep 17 00:00:00 2001 From: Fabien COMBERNOUS Date: Tue, 20 Dec 2016 10:56:47 +0100 Subject: [PATCH 1/2] 04-1_alignak_configuration/arbiter.rst was not speaking about arbiter but about core of alignak --- .../{arbiter.rst => core_configuration.rst} | 247 ++++++++++++++---- ...n_file.rst => core_configuration_tips.rst} | 132 +++++----- source/04-1_alignak_configuration/daemons.rst | 186 ------------- source/04-1_alignak_configuration/index.rst | 19 +- ...{modules.rst => modules_configuration.rst} | 3 + .../objects_configuration.rst | 2 +- source/20_annexes/host.rst | 2 +- source/20_annexes/macros_list.rst | 4 +- 8 files changed, 283 insertions(+), 312 deletions(-) rename source/04-1_alignak_configuration/{arbiter.rst => core_configuration.rst} (59%) rename source/04-1_alignak_configuration/{main_configuration_file.rst => core_configuration_tips.rst} (90%) delete mode 100644 source/04-1_alignak_configuration/daemons.rst rename source/04-1_alignak_configuration/{modules.rst => modules_configuration.rst} (91%) diff --git a/source/04-1_alignak_configuration/arbiter.rst b/source/04-1_alignak_configuration/core_configuration.rst similarity index 59% rename from source/04-1_alignak_configuration/arbiter.rst rename to source/04-1_alignak_configuration/core_configuration.rst index e62c816..367f819 100644 --- a/source/04-1_alignak_configuration/arbiter.rst +++ b/source/04-1_alignak_configuration/core_configuration.rst @@ -1,64 +1,41 @@ -.. _configuration/arbiter: +.. _configuration/core: -======= -Arbiter -======= +================== +Core configuration +================== + +The core configuration part describes the Alignak framework infrastructure (which daemons are used and how they are). + +For historical reasons, the configuration is splited in two kinds of files : + + * *.cfg* files for storing settings more binded to the role of the daemon concerned. + * *.ini* files for storing settings considered as parameters +In a feature paradise, one .cfg file per daemon should be enougth to configure all settings of the concerned daemon. + +Cfg files +========= + +Arbiter, main role +------------------ The arbiter is the main Alignak daemon. As of it, its configuration part is the most important one. This part of the configuration is stored by default in the folder */usr/local/etc/alignak/arbiter/* and it contains: - * the configuration of the daemons and their (external) modules + * the configuration of the daemons and their modules * the configuration of the monitored objects * the configuration of monitoring resources Each sub-part is stored by default in its own sub-directory: - * *arbiter/daemons/* for the daemons - * *arbiter/modules/* for the modules + * *arbiter/daemons/* for the daemons cfg files. Each daemon has its own cfg file. + * *arbiter/modules/* for the modules configuration * *arbiter/templates/* for the objects templates * *arbiter/packs/* for the checks packs - * *arbiter/objects/* for the objects + * *arbiter/objects/* for the objects. Described in :ref:`the monitored objects dedicated chapter `. * *arbiter/resource.d/* for the resources and global macros - -Resources configuration -======================= - -The resources part of the configuration is used mainly to define common macros that are used in the whole configuration. The default installed configuration defines the following ones: - -* checks plugins directories - -The default installed configuration also includes a directory that will be used when some Alignak -checks packs will be installed on the system. - - -External modules configuration -============================== - -Each external module installed on Alignak stores its configuration file in this part of the configuration. - - -Monitoring objects configuration -================================ - -This part of the configuration stores all the monitoring objects configuration: - - * hosts - * services - * contacts - * commands - * ... - -This part of the configuration, probably the most important for Alignak's users, is described in :ref:`the monitored objects dedicated chapter `. - -Daemons configuration -===================== - -Each daemon has its own configuration file. - - Arbiter configuration --------------------- @@ -557,3 +534,183 @@ Variable Descriptions == TODO UPDATE THIS PART == +Ini files +========= + +To run a daemon, it must start with a ini file. +This ini file defines options like IP address, port, SSL... + +The format is the same for all the daemons and is defined in this style:: + + [daemon] + variable=value + variable=value + +When Alignak is installed, some variables in those configuration files are modified to match at +best with your system. The changed variables are: + + - workdir + - logdir + - pidfile + - user + - group + - ca_cert + - server_cert + - server_key + +Their values are set according to the current plaform (Linux, BSD, ...) and configuration defined +in the default alignak configuration. + +Arbiter +------- + +==================================== ======= ============================== ============================================================ +Variable name Type default Short description +==================================== ======= ============================== ============================================================ +workdir string /var/run/alignak daemon will chdir into this directory when launched +logdir string /var/log/alignak daemon will write logs into this directory +etcdir string /etc/alignak daemon will get configuration into this directory +pidfile string /var/run/schedulerd.pid PID file of the daemon +port integer 7768 port used by the daemon +host string 0.0.0.0 Set IP daemon listen +user string alignak username to run daemon +group string alignak group to run daemon +idontcareaboutsecurity boolean 0 set 1 to disable security in daemon (not recommended) +modulesdir string modules define modules directory installation +daemon_enabled boolean 1 set to 0 if want this daemon not run +use_ssl boolean 0 set 1 to use ssl for communications +ca_cert string /etc/alignak/certs/ca.pem full path for certificate +server_cert string /etc/alignak/certs/server.cert full path for certificate +server_key string /etc/alignak/certs/server.key full path for certificate key +hard_ssl_name_check boolean 0 set 1 if require a valid certificate +use_local_log boolean 1 set to 1 to ease troubleshooting +local_log string /var/log/schedulerd.log file to write logs +log_level string WARNING log level in DEBUG,INFO,WARNING,ERROR,CRITICAL +==================================== ======= ============================== ============================================================ + +Scheduler +--------- + +==================================== ======= ============================== ============================================================ +Variable name Type default Short description +==================================== ======= ============================== ============================================================ +workdir string /var/run/alignak daemon will chdir into this directory when launched +logdir string /var/log/alignak daemon will write logs into this directory +pidfile string /var/run/schedulerd.pid PID file of the daemon +port integer 7768 port used by the daemon +host string 0.0.0.0 Set IP daemon listen +user string alignak username to run daemon +group string alignak group to run daemon +idontcareaboutsecurity boolean 0 set 1 to disable security in daemon (not recommended) +modulesdir string modules define modules directory installation +daemon_enabled boolean 1 set to 0 if want this daemon not run +use_ssl boolean 0 set 1 to use ssl for communications +ca_cert string /etc/alignak/certs/ca.pem full path for certificate +server_cert string /etc/alignak/certs/server.cert full path for certificate +server_key string /etc/alignak/certs/server.key full path for certificate key +hard_ssl_name_check boolean 0 set 1 if require a valid certificate +use_local_log boolean 1 set to 1 to ease troubleshooting +local_log string /var/log/schedulerd.log file to write logs +log_level string WARNING log level in DEBUG,INFO,WARNING,ERROR,CRITICAL +==================================== ======= ============================== ============================================================ + +Poller +------ + +==================================== ======= ============================== ============================================================ +Variable name Type default Short description +==================================== ======= ============================== ============================================================ +user string alignak username to run daemon +group string alignak group to run daemon +daemon_enabled boolean 1 set to 0 if want this daemon not run +workdir string /var/run/alignak daemon will chdir into this directory when launched +logdir string /var/log/alignak daemon will write logs into this directory +pidfile string /var/run/pollerd.pid PID file of the daemon +host string 0.0.0.0 Set IP daemon listen +port integer 7771 port used by the daemon +idontcareaboutsecurity boolean 0 set 1 to disable security in daemon (not recommended) +use_ssl boolean 0 set 1 to use ssl for communications +ca_cert string /etc/alignak/certs/ca.pem full path for certificate +server_cert string /etc/alignak/certs/server.cert full path for certificate +server_key string /etc/alignak/certs/server.key full path for certificate key +hard_ssl_name_check boolean 0 set 1 if require a valid certificate +use_local_log boolean 1 set to 1 to ease troubleshooting +local_log string /var/log/pollerd.log file to write logs +log_level string WARNING log level in DEBUG,INFO,WARNING,ERROR,CRITICAL +==================================== ======= ============================== ============================================================ + +Receiver +-------- + +==================================== ======= ============================== ============================================================ +Variable name Type default Short description +==================================== ======= ============================== ============================================================ +workdir string /var/run/alignak daemon will chdir into this directory when launched +logdir string /var/log/alignak daemon will write logs into this directory +pidfile string /var/run/receiverd.pid PID file of the daemon +port integer 7773 port used by the daemon +host string 0.0.0.0 Set IP daemon listen +user string alignak username to run daemon +group string alignak group to run daemon +idontcareaboutsecurity boolean 0 set 1 to disable security in daemon (not recommended) +daemon_enabled boolean 1 set to 0 if want this daemon not run +use_ssl boolean 0 set 1 to use ssl for communications +ca_cert string /etc/alignak/certs/ca.pem full path for certificate +server_cert string /etc/alignak/certs/server.cert full path for certificate +server_key string /etc/alignak/certs/server.key full path for certificate key +hard_ssl_name_check boolean 0 set 1 if require a valid certificate +use_local_log boolean 1 set to 1 to ease troubleshooting +local_log string /var/log/receiverd.log file to write logs +log_level string WARNING log level in DEBUG,INFO,WARNING,ERROR,CRITICAL +==================================== ======= ============================== ============================================================ + +Broker +------ + +==================================== ======= ============================== ============================================================ +Variable name Type default Short description +==================================== ======= ============================== ============================================================ +workdir string /var/run/alignak daemon will chdir into this directory when launched +logdir string /var/log/alignak daemon will write logs into this directory +pidfile string /var/run/brokerd.pid PID file of the daemon +user string alignak username to run daemon +group string alignak group to run daemon +host string 0.0.0.0 Set IP daemon listen +port integer 7772 port used by the daemon +idontcareaboutsecurity boolean 0 set 1 to disable security in daemon (not recommended) +daemon_enabled boolean 1 set to 0 if want this daemon not run +use_ssl boolean 0 set 1 to use ssl for communications +ca_cert string /etc/alignak/certs/ca.pem full path for certificate +server_cert string /etc/alignak/certs/server.cert full path for certificate +server_key string /etc/alignak/certs/server.key full path for certificate key +hard_ssl_name_check boolean 0 set 1 if require a valid certificate +use_local_log boolean 1 set to 1 to ease troubleshooting +local_log string /var/log/brokerd.log file to write logs +log_level string WARNING log level in DEBUG,INFO,WARNING,ERROR,CRITICAL +max_queue_size integer 100000 restart an external module if queue to high. 0 to disable +==================================== ======= ============================== ============================================================ + +Reactionner +----------- + +==================================== ======= ============================== ============================================================ +Variable name Type default Short description +==================================== ======= ============================== ============================================================ +workdir string /var/run/alignak daemon will chdir into this directory when launched +logdir string /var/log/alignak daemon will write logs into this directory +pidfile string /var/run/reactionnerd.pid PID file of the daemon +port integer 7769 port used by the daemon +host string 0.0.0.0 Set IP daemon listen +user string alignak username to run daemon +group string alignak group to run daemon +idontcareaboutsecurity boolean 0 set 1 to disable security in daemon (not recommended) +daemon_enabled boolean 1 set to 0 if want this daemon not run +use_ssl boolean 0 set 1 to use ssl for communications +ca_cert string /etc/alignak/certs/ca.pem full path for certificate +server_cert string /etc/alignak/certs/server.cert full path for certificate +server_key string /etc/alignak/certs/server.key full path for certificate key +hard_ssl_name_check boolean 0 set 1 if require a valid certificate +use_local_log boolean 1 set to 1 to ease troubleshooting +local_log string /var/log/reactionnerd.log file to write logs +log_level string WARNING log level in DEBUG,INFO,WARNING,ERROR,CRITICAL +==================================== ======= ============================== ============================================================ diff --git a/source/04-1_alignak_configuration/main_configuration_file.rst b/source/04-1_alignak_configuration/core_configuration_tips.rst similarity index 90% rename from source/04-1_alignak_configuration/main_configuration_file.rst rename to source/04-1_alignak_configuration/core_configuration_tips.rst index 30a4b6e..9f945ff 100644 --- a/source/04-1_alignak_configuration/main_configuration_file.rst +++ b/source/04-1_alignak_configuration/core_configuration_tips.rst @@ -1,4 +1,4 @@ -.. _configuration/main: +.. _configuration/core_tips: ============================================= Main configuration file (alignak.cfg) options @@ -20,8 +20,8 @@ The main configuration file is named ``alignak.cfg``. Default used options ==================== -.. _configuration/main#cfg_dir: -.. _configuration/main#cfg_file: +.. _configuration/core#cfg_dir: +.. _configuration/core#cfg_file: Cfg dir and Cfg files --------------------- @@ -40,7 +40,7 @@ Thus, the arbiter handles the main configuration files differently than any othe -.. _configuration/main#retention_update_interval: +.. _configuration/core#retention_update_interval: Automatic state retention update interval ----------------------------------------- @@ -62,7 +62,7 @@ If you set this value to 0, it will not save retention data at regular intervals If you have disabled state retention (with the :ref:`State Retention Option ` option), this option has no effect. -.. _configuration/main#max_service_check_spread: +.. _configuration/core#max_service_check_spread: Maximum Host/Service check spread --------------------------------- @@ -84,8 +84,8 @@ Default: This option determines the maximum number of minutes from when Alignak starts that all hosts/services (that are scheduled to be regularly checked) are checked. This option will ensure that the initial checks of all hosts/services occur within the timeframe you specify. Default value is 30 (minutes). -.. _configuration/main#host_check_timeout: -.. _configuration/main#service_check_timeout: +.. _configuration/core#host_check_timeout: +.. _configuration/core#service_check_timeout: Service/Host check timeout -------------------------- @@ -108,7 +108,7 @@ This is the maximum number of seconds that Alignak will allow service/host check There is often widespread confusion as to what this option really does. It is meant to be used as a last ditch mechanism to kill off plugins which are misbehaving and not exiting in a timely manner. It should be set to something high (like 60 seconds or more), so that each check normally finishes executing within this time limit. If a check runs longer than this limit, Alignak will kill it off thinking it is a runaway processes. -.. _configuration/main#timeout_exit_status: +.. _configuration/core#timeout_exit_status: Timeout exit status ------------------- @@ -133,7 +133,7 @@ State set by Alignak in case of timeout. The value is a state identifier, thus: * 3: UNKNOWN -.. _configuration/main#flap_history: +.. _configuration/core#flap_history: Flap history ------------ @@ -155,7 +155,7 @@ This option is used to set the history size of states keep by the scheduler to m The size in memory is for the scheduler daemon : 4Bytes * flap_history * (nb hosts + nb services). For a big environment, it costs 4 * 20 * (1000+10000) - 900Ko. So you can raise it to higher value if you want. To have more information about flapping, you can read :ref:`this `. -.. _configuration/main#max_plugins_output_length: +.. _configuration/core#max_plugins_output_length: Maximum plugins output length ----------------------------- @@ -175,7 +175,7 @@ Default: This option is used to set the max size in bytes for the checks plugins output. So if you have some truncated output like for huge disk check when you have a lot of partitions, increase this value. -.. _configuration/main#enable_problem_impacts_states_change: +.. _configuration/core#enable_problem_impacts_states_change: Enable problem/impacts states change ------------------------------------ @@ -195,7 +195,7 @@ Default: This option is used to know if we apply or not the state change when a host or service is impacted by a root problem (like the service's host going down or a host's parent being down too). The state will be changed by UNKNONW for a service and UNREACHABLE for a host until their next schedule check. This state change do not count as a attempt, it's just for console so the users know that theses objects got problems and the previous states are not sure. -.. _configuration/main#disable_old_nagios_parameters_whining: +.. _configuration/core#disable_old_nagios_parameters_whining: Disable old nagios parameters whining ------------------------------------- @@ -215,7 +215,7 @@ Default: If 1, disable all notice and warning messages when the Arbiter is checking the configuration. -.. _configuration/main#use_timezone: +.. _configuration/core#use_timezone: Timezone option --------------- @@ -236,7 +236,7 @@ This option allows you to override the default timezone that this instance of Al -.. _configuration/main#enable_environment_macros: +.. _configuration/core#enable_environment_macros: Environment macros option ------------------------- @@ -259,7 +259,7 @@ This option determines whether or not the Alignak daemon will make all standard * 1 = Make macros available as environment variables -.. _configuration/main#log_initial_states: +.. _configuration/core#log_initial_states: Initial states logging option ----------------------------- @@ -282,7 +282,7 @@ This variable determines whether or not Alignak will force all initial host and * 1 = Log initial states -.. _configuration/main#log_notifications: +.. _configuration/core#log_notifications: Notification logging option --------------------------- @@ -305,8 +305,8 @@ This variable determines whether or not notification messages are logged. If you * 1 = Log notifications -.. _configuration/main#log_service_retries: -.. _configuration/main#log_host_retries: +.. _configuration/core#log_service_retries: +.. _configuration/core#log_host_retries: Service/Host check retry logging option --------------------------------------- @@ -331,7 +331,7 @@ This variable determines whether or not service/host check retries are logged. S * 1 = Log service/host check retries -.. _configuration/main#log_event_handlers: +.. _configuration/core#log_event_handlers: Event handlers logging option ----------------------------- @@ -356,7 +356,7 @@ This variable determines whether or not service and host :ref:`event handlers ` that may be returned from the check. The command argument is the short name of a command definition that you define in your object configuration file. This command is only executed if the :ref:`Performance Data Processing Option ` option is enabled globally and if the ``process_perf_data`` directive in the host definition is enabled. +This option allows you to specify a command to be run after every host/service check to process host/service :ref:`performance data ` that may be returned from the check. The command argument is the short name of a command definition that you define in your object configuration file. This command is only executed if the :ref:`Performance Data Processing Option ` option is enabled globally and if the ``process_perf_data`` directive in the host definition is enabled. Advanced scheduling parameters ============================== -.. _configuration/main#passive_host_checks_are_soft: +.. _configuration/core#passive_host_checks_are_soft: Passive host checks are SOFT option ----------------------------------- @@ -595,8 +595,8 @@ This option determines whether or not Alignak will treat :ref:`passive host chec .. warning:: This option is not yet implemented. -.. _configuration/main#enable_predictive_host_dependency_checks: -.. _configuration/main#enable_predictive_service_dependency_checks: +.. _configuration/core#enable_predictive_host_dependency_checks: +.. _configuration/core#enable_predictive_service_dependency_checks: Predictive Host/Service dependency checks option ------------------------------------------------ @@ -622,8 +622,8 @@ This option determines whether or not Alignak will execute predictive checks of .. warning:: This option is not yet implemented. -.. _configuration/main#check_for_orphaned_services: -.. _configuration/main#check_for_orphaned_hosts: +.. _configuration/core#check_for_orphaned_services: +.. _configuration/core#check_for_orphaned_hosts: Orphaned Host/Service check option ---------------------------------- @@ -655,7 +655,7 @@ If this option is enabled and Alignak finds that results for a particular check -.. _configuration/main#soft_state_dependencies: +.. _configuration/core#soft_state_dependencies: Soft state dependencies option ------------------------------ @@ -675,8 +675,8 @@ This option determines whether or not Alignak will use soft state information wh Performance tuning =================== -.. _configuration/main#cached_host_check_horizon: -.. _configuration/main#cached_service_check_horizon: +.. _configuration/core#cached_host_check_horizon: +.. _configuration/core#cached_service_check_horizon: Cached Host/Service check horizon --------------------------------- @@ -702,7 +702,7 @@ This option determines the maximum amount of time (in seconds) that the state of .. warning:: This option is not yet implemented. -.. _configuration/main#use_large_installation_tweaks: +.. _configuration/core#use_large_installation_tweaks: Large installation tweaks option -------------------------------- @@ -729,7 +729,7 @@ This option determines whether or not the Alignak daemon will take shortcuts to Flapping parameters =================== -.. _configuration/main#enable_flap_detection: +.. _configuration/core#enable_flap_detection: Flap detection option --------------------- @@ -754,8 +754,8 @@ More information on how flap detection and handling works can be found :ref:`her * 1 = Enable flap detection -.. _configuration/main#low_host_flap_threshold: -.. _configuration/main#low_service_flap_threshold: +.. _configuration/core#low_host_flap_threshold: +.. _configuration/core#low_service_flap_threshold: Low Service/Host flap threshold ------------------------------- @@ -777,8 +777,8 @@ Example: This option is used to set the low threshold for detection of host/service flapping. For more information on how flap detection and handling works (and how this option affects things) read :ref:`this `. -.. _configuration/main#high_host_flap_threshold: -.. _configuration/main#high_service_flap_threshold: +.. _configuration/core#high_host_flap_threshold: +.. _configuration/core#high_service_flap_threshold: High Service/Host flap threshold -------------------------------- @@ -802,8 +802,8 @@ This option is used to set the high threshold for detection of host/service flap -.. _configuration/main#event_handler_timeout: -.. _configuration/main#notification_timeout: +.. _configuration/core#event_handler_timeout: +.. _configuration/core#notification_timeout: Various commands timeouts ------------------------- @@ -832,8 +832,8 @@ There is often widespread confusion as to what this option really does. It is me Freshness check =============== -.. _configuration/main#check_service_freshness: -.. _configuration/main#check_host_freshness: +.. _configuration/core#check_service_freshness: +.. _configuration/core#check_host_freshness: Host/Service freshness checking option -------------------------------------- @@ -858,8 +858,8 @@ This option determines whether or not Alignak will periodically check the “fre * 1 = Check host/service freshness (default) -.. _configuration/main#service_freshness_check_interval: -.. _configuration/main#host_freshness_check_interval: +.. _configuration/core#service_freshness_check_interval: +.. _configuration/core#host_freshness_check_interval: Host/Service freshness check interval ------------------------------------- @@ -881,7 +881,7 @@ Example: This setting determines how often (in seconds) Alignak will periodically check the “freshness" of host/service check results. If you have disabled host/service freshness checking (with the ``check_service_freshness`` option), this option has no effect. More information on freshness checking can be found :ref:`here `. -.. _configuration/main#additional_freshness_latency: +.. _configuration/core#additional_freshness_latency: Additional freshness threshold latency option --------------------------------------------- @@ -902,7 +902,7 @@ This option determines the number of seconds Alignak will add to any host or ser -.. _configuration/main#triggers_dir: +.. _configuration/core#triggers_dir: Triggers directory ------------------ @@ -923,7 +923,7 @@ Used to specify the :ref:`trigger ` directory. It wil -.. _configuration/main#enable_notifications: +.. _configuration/core#enable_notifications: Notifications option -------------------- @@ -947,7 +947,7 @@ Values are as follows: * 1 = Enable notifications (default) -.. _configuration/main#check_external_commands: +.. _configuration/core#check_external_commands: External command check option ----------------------------- @@ -973,7 +973,7 @@ This option determines whether or not Alignak will execute the external commands Scheduling parameters ===================== -.. _configuration/main#execute_service_checks: +.. _configuration/core#execute_service_checks: Service/Host check execution option ----------------------------------- @@ -998,7 +998,7 @@ This option determines whether or not Alignak will execute :ref:`active host/ser * 1 = Execute service checks (default) -.. _configuration/main#accept_passive_service_checks: +.. _configuration/core#accept_passive_service_checks: Passive Host/Service check acceptance option -------------------------------------------- @@ -1023,7 +1023,7 @@ This option determines whether or not Alignak will accept :ref:`passive host/ser * 1 = Accept passive service/host checks (default) -.. _configuration/main#enable_event_handlers: +.. _configuration/core#enable_event_handlers: Event handlers option --------------------- @@ -1048,8 +1048,8 @@ This option determines whether or not Alignak will run :ref:`event handlers ` option. More information on event handlers can be found :ref:`here `. +This option allows you to specify a host event handler command that is to be run for every host state change. The global event handler is executed immediately prior to the event handler that you have optionally specified in each host definition. The command argument is the short name of a command that you define in your commands definition. The maximum amount of time that this command can run is controlled by the :ref:`Event Handler Timeout ` option. More information on event handlers can be found :ref:`here `. Such commands should not be so useful with the new Alignak distributed architecture. If you use it, look if you can avoid it because such commands will kill your performance! -.. _configuration/main#interval_length: +.. _configuration/core#interval_length: Timing interval length ---------------------- @@ -1102,7 +1102,7 @@ The default value for this is set to 60, which means that a "unit value" of 1 in Naming and macros parameters ============================ -.. _configuration/main#illegal_object_name_chars: +.. _configuration/core#illegal_object_name_chars: Illegal object name characters ------------------------------ @@ -1122,7 +1122,7 @@ Example: This option allows you to specify illegal characters that cannot be used in host names, service descriptions, or names of other object types. Alignak will allow you to use most characters in object definitions, but we recommend not using the characters shown in the example above because it may give you problems in the web interface, notification commands, etc. -.. _configuration/main#illegal_macro_output_chars: +.. _configuration/core#illegal_macro_output_chars: Illegal macro output characters ------------------------------- @@ -1151,7 +1151,7 @@ This option allows you to specify illegal characters that should be stripped fro * "$SERVICEACKCOMMENT$" -.. _configuration/main#admin_email: +.. _configuration/core#admin_email: Administrator email address --------------------------- @@ -1171,7 +1171,7 @@ Example: This is the email address for the administrator of the local machine (i.e. the one that Alignak is running on). This value can be used in notification commands by using the "$ADMINEMAIL$" :ref:`macro `. -.. _configuration/main#admin_pager: +.. _configuration/core#admin_pager: Administrator pager (unused) ---------------------------- @@ -1194,7 +1194,7 @@ This is the pager number (or pager email gateway) for the administrator of the l Statistics parameters ===================== -.. _configuration/main#statsd: +.. _configuration/core#statsd: Statsd enabled -------------- diff --git a/source/04-1_alignak_configuration/daemons.rst b/source/04-1_alignak_configuration/daemons.rst deleted file mode 100644 index ed9f10c..0000000 --- a/source/04-1_alignak_configuration/daemons.rst +++ /dev/null @@ -1,186 +0,0 @@ -.. _configuration/daemons: - -======= -Daemons -======= - -Ini files -========= - -To run a daemon, it must start with a configuration file (ini file). -This configuration file defines options like IP address, port, SSL... - -The format is the same for all the daemons and is defined in this style:: - - [daemon] - variable=value - variable=value - -When Alignak is installed, some variables in those configuration files are modified to match at -best with your system. The changed variables are: - - - workdir - - logdir - - pidfile - - user - - group - - ca_cert - - server_cert - - server_key - -Their values are set according to the current plaform (Linux, BSD, ...) and configuration defined -in the default alignak configuration. - -Arbiter -------- - -==================================== ======= ============================== ============================================================ -Variable name Type default Short description -==================================== ======= ============================== ============================================================ -workdir string /var/run/alignak daemon will chdir into this directory when launched -logdir string /var/log/alignak daemon will write logs into this directory -etcdir string /etc/alignak daemon will get configuration into this directory -pidfile string /var/run/schedulerd.pid PID file of the daemon -port integer 7768 port used by the daemon -host string 0.0.0.0 Set IP daemon listen -user string alignak username to run daemon -group string alignak group to run daemon -idontcareaboutsecurity boolean 0 set 1 to disable security in daemon (not recommended) -modulesdir string modules define modules directory installation -daemon_enabled boolean 1 set to 0 if want this daemon not run -use_ssl boolean 0 set 1 to use ssl for communications -ca_cert string /etc/alignak/certs/ca.pem full path for certificate -server_cert string /etc/alignak/certs/server.cert full path for certificate -server_key string /etc/alignak/certs/server.key full path for certificate key -hard_ssl_name_check boolean 0 set 1 if require a valid certificate -use_local_log boolean 1 set to 1 to ease troubleshooting -local_log string /var/log/schedulerd.log file to write logs -log_level string WARNING log level in DEBUG,INFO,WARNING,ERROR,CRITICAL -==================================== ======= ============================== ============================================================ - -Scheduler ---------- - -==================================== ======= ============================== ============================================================ -Variable name Type default Short description -==================================== ======= ============================== ============================================================ -workdir string /var/run/alignak daemon will chdir into this directory when launched -logdir string /var/log/alignak daemon will write logs into this directory -pidfile string /var/run/schedulerd.pid PID file of the daemon -port integer 7768 port used by the daemon -host string 0.0.0.0 Set IP daemon listen -user string alignak username to run daemon -group string alignak group to run daemon -idontcareaboutsecurity boolean 0 set 1 to disable security in daemon (not recommended) -modulesdir string modules define modules directory installation -daemon_enabled boolean 1 set to 0 if want this daemon not run -use_ssl boolean 0 set 1 to use ssl for communications -ca_cert string /etc/alignak/certs/ca.pem full path for certificate -server_cert string /etc/alignak/certs/server.cert full path for certificate -server_key string /etc/alignak/certs/server.key full path for certificate key -hard_ssl_name_check boolean 0 set 1 if require a valid certificate -use_local_log boolean 1 set to 1 to ease troubleshooting -local_log string /var/log/schedulerd.log file to write logs -log_level string WARNING log level in DEBUG,INFO,WARNING,ERROR,CRITICAL -==================================== ======= ============================== ============================================================ - -Poller ------- - -==================================== ======= ============================== ============================================================ -Variable name Type default Short description -==================================== ======= ============================== ============================================================ -user string alignak username to run daemon -group string alignak group to run daemon -daemon_enabled boolean 1 set to 0 if want this daemon not run -workdir string /var/run/alignak daemon will chdir into this directory when launched -logdir string /var/log/alignak daemon will write logs into this directory -pidfile string /var/run/pollerd.pid PID file of the daemon -host string 0.0.0.0 Set IP daemon listen -port integer 7771 port used by the daemon -idontcareaboutsecurity boolean 0 set 1 to disable security in daemon (not recommended) -use_ssl boolean 0 set 1 to use ssl for communications -ca_cert string /etc/alignak/certs/ca.pem full path for certificate -server_cert string /etc/alignak/certs/server.cert full path for certificate -server_key string /etc/alignak/certs/server.key full path for certificate key -hard_ssl_name_check boolean 0 set 1 if require a valid certificate -use_local_log boolean 1 set to 1 to ease troubleshooting -local_log string /var/log/pollerd.log file to write logs -log_level string WARNING log level in DEBUG,INFO,WARNING,ERROR,CRITICAL -==================================== ======= ============================== ============================================================ - -Receiver --------- - -==================================== ======= ============================== ============================================================ -Variable name Type default Short description -==================================== ======= ============================== ============================================================ -workdir string /var/run/alignak daemon will chdir into this directory when launched -logdir string /var/log/alignak daemon will write logs into this directory -pidfile string /var/run/receiverd.pid PID file of the daemon -port integer 7773 port used by the daemon -host string 0.0.0.0 Set IP daemon listen -user string alignak username to run daemon -group string alignak group to run daemon -idontcareaboutsecurity boolean 0 set 1 to disable security in daemon (not recommended) -daemon_enabled boolean 1 set to 0 if want this daemon not run -use_ssl boolean 0 set 1 to use ssl for communications -ca_cert string /etc/alignak/certs/ca.pem full path for certificate -server_cert string /etc/alignak/certs/server.cert full path for certificate -server_key string /etc/alignak/certs/server.key full path for certificate key -hard_ssl_name_check boolean 0 set 1 if require a valid certificate -use_local_log boolean 1 set to 1 to ease troubleshooting -local_log string /var/log/receiverd.log file to write logs -log_level string WARNING log level in DEBUG,INFO,WARNING,ERROR,CRITICAL -==================================== ======= ============================== ============================================================ - -Broker ------- - -==================================== ======= ============================== ============================================================ -Variable name Type default Short description -==================================== ======= ============================== ============================================================ -workdir string /var/run/alignak daemon will chdir into this directory when launched -logdir string /var/log/alignak daemon will write logs into this directory -pidfile string /var/run/brokerd.pid PID file of the daemon -user string alignak username to run daemon -group string alignak group to run daemon -host string 0.0.0.0 Set IP daemon listen -port integer 7772 port used by the daemon -idontcareaboutsecurity boolean 0 set 1 to disable security in daemon (not recommended) -daemon_enabled boolean 1 set to 0 if want this daemon not run -use_ssl boolean 0 set 1 to use ssl for communications -ca_cert string /etc/alignak/certs/ca.pem full path for certificate -server_cert string /etc/alignak/certs/server.cert full path for certificate -server_key string /etc/alignak/certs/server.key full path for certificate key -hard_ssl_name_check boolean 0 set 1 if require a valid certificate -use_local_log boolean 1 set to 1 to ease troubleshooting -local_log string /var/log/brokerd.log file to write logs -log_level string WARNING log level in DEBUG,INFO,WARNING,ERROR,CRITICAL -max_queue_size integer 100000 restart an external module if queue to high. 0 to disable -==================================== ======= ============================== ============================================================ - -Reactionner ------------ - -==================================== ======= ============================== ============================================================ -Variable name Type default Short description -==================================== ======= ============================== ============================================================ -workdir string /var/run/alignak daemon will chdir into this directory when launched -logdir string /var/log/alignak daemon will write logs into this directory -pidfile string /var/run/reactionnerd.pid PID file of the daemon -port integer 7769 port used by the daemon -host string 0.0.0.0 Set IP daemon listen -user string alignak username to run daemon -group string alignak group to run daemon -idontcareaboutsecurity boolean 0 set 1 to disable security in daemon (not recommended) -daemon_enabled boolean 1 set to 0 if want this daemon not run -use_ssl boolean 0 set 1 to use ssl for communications -ca_cert string /etc/alignak/certs/ca.pem full path for certificate -server_cert string /etc/alignak/certs/server.cert full path for certificate -server_key string /etc/alignak/certs/server.key full path for certificate key -hard_ssl_name_check boolean 0 set 1 if require a valid certificate -use_local_log boolean 1 set to 1 to ease troubleshooting -local_log string /var/log/reactionnerd.log file to write logs -log_level string WARNING log level in DEBUG,INFO,WARNING,ERROR,CRITICAL -==================================== ======= ============================== ============================================================ diff --git a/source/04-1_alignak_configuration/index.rst b/source/04-1_alignak_configuration/index.rst index 5b857d4..c82a060 100644 --- a/source/04-1_alignak_configuration/index.rst +++ b/source/04-1_alignak_configuration/index.rst @@ -12,23 +12,20 @@ Alignak framework configuration \newpage -The Alignak framework configuration is splitted in three main parts: +The Alignak framework configuration is splitted in two main parts: - - arbiter configuration, - - daemons configuration, - - external modules configuration. + - the core configuration + - the modules configuration. -The arbiter configuration part describes the Alignak framework infrastructure (which daemons are used and how they are) and the monitoring objects (what is monitored and how it is). +All the configurations are stored in the folder */usr/local/etc/alignak/* (or */etc/alignak/*), even the monitoring objects (what is monitored and how it is). Monitoring objects configuration, probably the most important for Alignak's users, is described in :ref:`the monitored objects dedicated chapter `. -All the configuration is stored in the folder */usr/local/etc/alignak/* (or */etc/alignak/*). -Each main part of the configuration is described in the following chapters: +Each main part of the Alignak framework configuration is described in the following chapters : .. toctree:: :maxdepth: 1 - arbiter - daemons - modules + core_configuration + modules_configuration This chapter gives information about configuring the inter-deamon communication with SSL. @@ -43,4 +40,4 @@ The last chapters give more information about the default installed configuratio :maxdepth: 1 default_configuration - main_configuration_file + core_configuration_tips.rst diff --git a/source/04-1_alignak_configuration/modules.rst b/source/04-1_alignak_configuration/modules_configuration.rst similarity index 91% rename from source/04-1_alignak_configuration/modules.rst rename to source/04-1_alignak_configuration/modules_configuration.rst index fac10cd..38af183 100644 --- a/source/04-1_alignak_configuration/modules.rst +++ b/source/04-1_alignak_configuration/modules_configuration.rst @@ -17,6 +17,9 @@ The configuration file of the installed module will be installed in the folder:: etc/alignak/arbiter/modules +Each module installed on Alignak stores its configuration file in this part of the configuration. + + .. _Pypi: https://pypi.python.org/pypi diff --git a/source/04-2_monitoring_configuration/objects_configuration.rst b/source/04-2_monitoring_configuration/objects_configuration.rst index 0a82793..99f6bf0 100644 --- a/source/04-2_monitoring_configuration/objects_configuration.rst +++ b/source/04-2_monitoring_configuration/objects_configuration.rst @@ -16,7 +16,7 @@ Monitored objects are all the elements that are involved in the monitoring and n * Execution Dependencies * Modulations -The monitored objects can be defined in one or more configuration files and/or directories that are specified using the :ref:`main configuration file` and/or :ref:`cfg_dir ` properties in the :ref:`main configuration file`. +The monitored objects can be defined in one or more configuration files and/or directories that are specified using the :ref:`cfg_file ` and/or :ref:`cfg_dir ` properties in the :ref:`core configuration `. .. note: defining the monitored objects in some configuration flat files is the plain old Nagios/Shinken way of defining the configuration. Alignak introduces a brand new solution thanks to its backend. For more information, see :ref:̀̀`extending/alignak_backend`. diff --git a/source/20_annexes/host.rst b/source/20_annexes/host.rst index dd578e1..c97a970 100644 --- a/source/20_annexes/host.rst +++ b/source/20_annexes/host.rst @@ -150,7 +150,7 @@ hostgroups This directive is used to identify the *short name(s)* of the :ref:`hostgroup(s) ` that the host belongs to. Multiple hostgroups should be separated by commas. This directive may be used as an alternative to (or in addition to) using the *members* directive in :ref:`hostgroup ` definitions. check_command - This directive is used to specify the *short name* of the :ref:`command ` that should be used to check if the host is up or down. Typically, this command would try and ping the host to see if it is "alive". The command must return a status of OK (0) or Alignak will assume the host is down. If you leave this argument blank, the host will *not* be actively checked. Thus, Alignak will likely always assume the host is up (it may show up as being in a "PENDING" state in the web interface). This is useful if you are monitoring printers or other devices that are frequently turned off. The maximum amount of time that the notification command can run is controlled by the :ref:`host_check_timeout ` option. + This directive is used to specify the *short name* of the :ref:`command ` that should be used to check if the host is up or down. Typically, this command would try and ping the host to see if it is "alive". The command must return a status of OK (0) or Alignak will assume the host is down. If you leave this argument blank, the host will *not* be actively checked. Thus, Alignak will likely always assume the host is up (it may show up as being in a "PENDING" state in the web interface). This is useful if you are monitoring printers or other devices that are frequently turned off. The maximum amount of time that the notification command can run is controlled by the :ref:`host_check_timeout ` option. initial_state By default Alignak will assume that all hosts are in PENDING state when in starts. You can override the initial state for a host by using this directive. Valid options are: **o** = UP, **d** = DOWN, and **u** = UNREACHABLE. diff --git a/source/20_annexes/macros_list.rst b/source/20_annexes/macros_list.rst index 50e9ccd..57c79f0 100644 --- a/source/20_annexes/macros_list.rst +++ b/source/20_annexes/macros_list.rst @@ -471,7 +471,7 @@ Misc Macros ================================================================ ====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== _`$PROCESSSTARTTIME$` Time stamp in time_t format (seconds since the UNIX epoch) indicating when the Alignak process was last (re)started. You can determine the number of seconds that Alignak has been running (since it was last restarted) by subtracting $PROCESSSTARTTIME$ from :ref:`$TIMET$ <$TIMET$>`. _`$EVENTSTARTTIME$` Time stamp in time_t format (seconds since the UNIX epoch) indicating when the Alignak process starting process events (checks, etc.). You can determine the number of seconds that it took for Alignak to startup by subtracting $PROCESSSTARTTIME$ from $EVENTSTARTTIME$. -_`$ADMINEMAIL$` (unused) Global administrative email address. This value is taken from the :ref:`admin_email ` directive. +_`$ADMINEMAIL$` (unused) Global administrative email address. This value is taken from the :ref:`admin_email ` directive. _`$ADMINPAGER$` (unused) Global administrative pager number/address. This value is taken from the :ref:`admin_pager ` directive. _`$ARGn$` The nth argument passed to the command (notification, event handler, service check, etc.). Alignak supports up to 32 argument macros ($ARG1$ through $ARG32$). _`$USERn$` The nth user-definable macro. User macros can be defined in one or more :ref:`resource files `. Alignak supports up to 32 user macros ($USER1$ through $USER32$). @@ -519,5 +519,5 @@ Notes .. _annexes/macros_list#note10: - * **10** Summary macros are not available as environment variables if the :ref:`use_large_installation_tweaks ` option is enabled, as they are quite CPU-intensive to calculate. + * **10** Summary macros are not available as environment variables if the :ref:`use_large_installation_tweaks ` option is enabled, as they are quite CPU-intensive to calculate. From 3cca6ecce2952622226e746166b5bc76bf51e611 Mon Sep 17 00:00:00 2001 From: Fabien COMBERNOUS Date: Tue, 20 Dec 2016 20:04:30 +0100 Subject: [PATCH 2/2] some typo fix --- source/04-1_alignak_configuration/core_configuration.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/source/04-1_alignak_configuration/core_configuration.rst b/source/04-1_alignak_configuration/core_configuration.rst index 367f819..d0222d8 100644 --- a/source/04-1_alignak_configuration/core_configuration.rst +++ b/source/04-1_alignak_configuration/core_configuration.rst @@ -6,12 +6,9 @@ Core configuration The core configuration part describes the Alignak framework infrastructure (which daemons are used and how they are). -For historical reasons, the configuration is splited in two kinds of files : +For historical reasons, the configuration is splitted in two kinds of files. The ini file contains the parameters used by the daemon to communicate with the other daemons in the Alignak framework where as the .cfg file contains parameters dedicated to its role in the whole stuff - * *.cfg* files for storing settings more binded to the role of the daemon concerned. - * *.ini* files for storing settings considered as parameters - -In a feature paradise, one .cfg file per daemon should be enougth to configure all settings of the concerned daemon. +In a feature paradise, one .cfg file per daemon should be enough to configure all settings of the concerned daemon. Currently each daemon has a .cfg and a .ini file for its configuration. Cfg files =========