This page last changed on Nov 14, 2013 by tarragon.


This page provides all information about the YAIM variable required to configure SAM-Nagios and SAM-Gridmon.

Examples

A SAM-Nagios nodetype can be configured in two different ways:

  • NGI SAM-Nagios
  • VO SAM-Nagios

Production Variables

Common
Component Name Description Default Mandatory Example
all DAEMON_GROUP Daemon group Yes Yes nagios
all DAEMON_USER Daemon user Yes Yes nagios
all DB_NAME Database name Yes Yes mrs
all DB_PASS Database password (main account) No Yes my_password
all DB_PASS_R Database password (reader) No Yes my_reader_password
all DB_PASS_W Database password (writer)  Note: DB_PASS_W and DB_PASS_R must be equal (SAM-3334) No Yes my_writer_password
all DB_TYPE Type of database Yes Yes mysql
all DB_USER Database user (main account) Yes Yes mrs
all DB_USER_R Database user (reader) Yes Yes mrs
all DB_USER_W Database user (writer) Yes Yes mrs
all GOCDB_ROOT_URL GOCDB url Yes Yes https://goc.egi.eu/gocdbpi
all MSG_BROKER_CACHE_HOST Instruct SAM to use one specific broker instead of the broker network Yes No gridmsg106.cern.ch
all MSG_BROKER_CACHE_NETWORK Set the Broker service to look for in the information system Yes No PROD
all NAGIOS_HTTPD_ENABLE_CONFIG Set true to update apache configuration for X509 auth. Will overwrite =/etc/httpd/conf.d/nagios.conf= and =ssl.conf=. If you don't do this you will have to configure apache by hand for X509 certificate authentication Yes Yes false
all TIME_ZONE Time zone for web interfaces Yes Yes `cat /etc/sysconfig/clock|grep 'ZONE='|cut -d '"' -f2`
all VOS List of VOs who can view the nagios information No Yes "ops dteam alice atlas cmd lhcb"
all VO_<VONAME>_VOMS_SERVERS URI for the VOMS service No Yes "'vomss://voms.cern.ch:8443/voms/ops?/alice/'"
ATP ATP_VO_FEEDS Lists of VOs providing VO feed No Yes/No "alice atlas cms lhcb"
ATP ATP_VO_FEED_<VO> URL of the VO feed (one for each VO listed in ATP_VO_FEEDS) No Yes/No http://myVOfeed.com
ATP ATP_WEB_DEBUG Debug flag for ATP web front-end Yes Yes false
ATP ATP_WEB_EMAIL_HOST Email host for ATP web front-end Yes Yes localhost
ATP ATP_WEB_INTERNAL_IPS Internal IP setting for ATP web front-end Yes Yes 127.0.0.1
ATP ATP_WEB_PREFIX Server prefix for ATP web front-end Yes Yes /atp
ATP ATP_WEB_SERVER_EMAIL Server email for ATP web Yes Yes root
ATP ATP_WEB_TEMPLATE_DEBUG Template debug flag for ATP web front-end Yes Yes false
ATP ATP_WEB_VIEW_TEST Functional-test flag for ATP web front-end Yes Yes false
ATP USER_CERT_FILE Path of user certificate file Yes Yes /etc/nagios/globus/hostcert.pem
ATP USER_KEY_FILE Path of user key file Yes Yes /etc/nagios/globus/hostkey.pem
MRS MRS_BOOTSTRAPPER_TIMEOUT Timeout (in seconds) for MRS bootstrapper Yes Yes 1800
MRS MRS_LOG_LEVEL Level of debug for MRS log (possible values: DEBUG WARNING or ERROR) Yes Yes ERROR
MRS N2MS_ROLES_URL URL of Nagios roles file Yes Yes http://gridops.cern.ch/config/nagios-roles.conf
MRS N2MS_HOSTS_URL URL of Nagios hosts file Yes Yes http://gridops.cern.ch/config/hep-hosts.conf
MyWLCG ENABLE_MYWLCG_ALIAS Enable MyWLCG alias Yes Yes 1
MyWLCG MYEGI_ACE Turn on ACE support in MyWLCG portal (can be set only on central instance, do not set it on your Nagios instance) Yes Yes False
MyWLCG MYEGI_ADMIN_EMAIL System administrator email No No admin.name@mail.com
MyWLCG MYEGI_ADMIN_NAME System administrator name No No FirstName LastName
MyWLCG MYEGI_DEBUG Turn on/off debug mode for MyEGI Yes Yes False
MyWLCG MYEGI_DEFAULT_PROFILE Profile by default in MyEGI Yes Yes ROC_CRITICAL
MyWLCG MYWLCG_ACCESS_CONTROL_ALLOW_ORIGIN Set Access-Control-Allow-Origin header Yes Yes *
MyWLCG MYWLCG_ACCESS_PERIOD Limit number of accesses (defined by MYWLCG_NUMBER_OF_ACCESSES) per IP address in a given time(seconds) Yes Yes 5
MyWLCG MYWLCG_DATA_TRANSFER Enables Data Transfer Module in MyWLCG Yes Yes False
MyWLCG MYWLCG_DB_LIMIT Limit number of rows that can be fetched at a time to avoid DB dump Yes Yes 50000
MyWLCG MYWLCG_DT_DSTSITE_OTHERS_LIMIT Place Destination Sites in category 'Others' when total aggregated data tranfer or avg. throughput less than MYWLCG_DT_DSTSITE_OTHERS_LIMIT Yes Yes 5
MyWLCG MYWLCG_DT_SRCSITE_OTHERS_LIMIT Place Source Sites in category 'Others' when total aggregated data tranfer or avg. throughput less than MYWLCG_DT_SRCSITE_OTHERS_LIMIT Yes Yes 2
MyWLCG MYWLCG_DT_VO_OTHERS_LIMIT Place VOs in category 'Others' when total aggregated data tranfer or avg. throughput less than MYWLCG_DT_VO_OTHERS_LIMIT Yes Yes 2
MyWLCG MYWLCG_EGI_EMAILS List of emails to which EGI Reports will be send Yes Yes egi-league-results@hellasgrid.gr
MyWLCG MYWLCG_NUMBER_OF_ACCESSES Limit number of accesses per IP address in a given time (defined by MYWLCG_ACCESS_PERIOD) Yes Yes 200
MyWLCG MYWLCG_REPORT_AUTHENTIC_DNS List of authentic DNs that can generate official reports (Seperated by commas with no space) No No  
MyWLCG MYWLCG_REPORTS To enable/disable Reports Yes Yes False
MyWLCG MYWLCG_REPORT_EGI_PROFILES List of allowed profiles for EGI Reports Yes Yes ROC_CRITICAL
MyWLCG MYWLCG_REPORT_WLCG_TIER1_HISTORY_PROFILES List of allowed profiles for WLCG Tier1 History Reports Yes Yes WLCG_CREAM_LCGCE_CRITICAL
MywLCG MYWLCG_REPORT_WLCG_TIER1_SUMMARY_PROFILES List of allowed profiles for WLCG Tier1 Summary Reports Yes Yes WLCG_CREAM_LCGCE_CRITICAL
MyWLCG MYWLCG_REPORT_WLCG_TIER1_VO_PROFILES List of allowed profiles for WLCG Tier1 VO Reports Yes Yes WLCG_CREAM_LCGCE_CRITICAL ALICE_CRITICAL ATLAS_CRITICAL CMS_CRITICAL LHCb_CRITICAL
MyWLCG MYWLCG_REPORT_WLCG_TIER2_PROFILES List of allowed profiles for WLCG Tier2 Reports Yes Yes WLCG_CREAM_LCGCE_CRITICAL
MyWLCG MYWLCG_TOPOLOGY To turn on/off Topology module in MyWLCG Yes Yes False
MyWLCG MYWLCG_WLCG_TIER1_EMAILS List of emails to which WLCG Tier1 Reports will be send Yes Yes worldwide-lcg-management-board@cern.ch
MyWLCG MYWLCG_WLCG_TIER2_EMAILS List of emails to which WLCG Tier2 Reports will be send Yes Yes project-wlcg-cb@cern.ch
MyWLCG MYWLCG_THROTTLE Limit the number of accesses per IP address in a given time (see MYWLCG_ACCESS_PERIOD, MYWLCG_NUMBER_OF_ACCESSES) Yes Yes False
POEM POEM_ADMIN_EMAIL POEM web instance admin e-mail No No admin.name@mail.com
POEM POEM_ADMIN_NAME POEM web instance admin name No No Admin Name
POEM POEM_ATP_ROOT_URL POEM web instance ATP URL Yes Yes http://localhost
POEM POEM_DEBUG Enable POEM web instance debug Yes Yes False
POEM POEM_IMPORT_FROM_MDDB If True bootstrap profiles from MDDB otherwise use a fixture file Yes Yes False
POEM POEM_NAGIOS_PROFILES Profiles to be tagged to Nagios Yes No "MY_PROFILE"
POEM POEM_NAMESPACE POEM web instance namespace Yes Yes ch.cern.sam
POEM POEM_SYNC_NS_RESTRICT Restrict synchronization of profiles for given namespace No No ch.cern.sam!ROC
POEM POEM_SYNC_URLS URLs to synchronize from (pointing to poem web instances) Yes Yes http://localhost/poem/api/0.1/json/
POEM POEM_USE_ATP_SERVICEMAP To be enabled if running VO-Nagios without VO feed Yes No False
POEM POEM_WEB_ENABLE Enable poem web instance Yes Yes True
voms2htpasswd OPS_MONITOR_DN opsmonitor DN which will be added to voms2htpasswd static configuration Yes Yes /DC=ch/DC=cern/OU=computers/CN=ops-monitor.cern.ch
voms2htpasswd SITE_NAME (if NAGIOS_ROLE is site) Name of the site No No MY_SITE


SAM-Gridmon
Component Name Description Default Mandatory Example
DAX DAX_MSG_HOST Substitutes the name of the Broker host in the consumer configuration of DAX component Yes Yes dashb-mb
msg-consume2db MSG_CONSUME2DB_TYPE Client type Yes Yes virtual
msg-consume2db MSG_DEST_NGI Message destination for NGI metric results Yes No /topic/grid.probe.metricOutput.EGEE.ngi.*
msg-consume2db MSG_DEST_OSG Message destination for OSG metric results Yes No /topic/grid.probe.metricOutput
msg-consume2db MSG_DEST_OSG_CATCHUP Message destination for OSG catchup metric results Yes No /topic/grid.probe.catchup.metricOutput
msg-consume2db MSG_DEST_PROJECT Message destination for PROJECT metric results Yes No /topic/grid.probe.metricOutput.EGEE.project.*
msg-consume2db MSG_DEST_ROC Message destination for ROC metric results Yes No /topic/grid.probe.metricOutput.EGEE.roc.*
msg-consume2db MSG_DEST_VO Message destination for VO metric results Yes No /topic/grid.probe.metricOutput.EGEE.vo.*
msg-consume2db MS_CONSUMER_NAME Consumer name No Yes my_consumer_cern_ch
RGF OPENREPORTS_ADMIN Admin user for OpenReports No Yes admin
RGF OPENREPORTS_ADMIN_PASS Admin password for OpenReports No Yes adminPASSWD


SAM-Nagios
Component Name Description Default Mandatory Example
all BDII_HOST Top level BDII to be used No Yes "sam-bdii.cern.ch"
all MYSQL_ADMIN Root password for MySQL No Yes "myRootPassword"
all NAGIOS_HOST Nagios hostname No Yes "myNagios.cern.ch"
all NAGIOS_ROLE Level monitoring role (accepted values are: security, ngi, central-web, opsmonitor, site, project and vo) Yes Yes site
all NCG_GOCDB_ROC_NAME Use the list of sites (provided by GOCDB) in this region No Yes ALL
grid-monitoring-probes-ch.cern.sam MRS_DBID_critical critical parameter of MrsCheckDBInsertsDetailed probe Yes Yes 0
grid-monitoring-probes-ch.cern.sam MRS_DBID_hours hours parameter of MrsCheckDBInsertsDetailed probe Yes Yes 2
grid-monitoring-probes-ch.cern.sam MRS_DBID_ngi ngi parameter of MrsCheckDBInsertsDetailed probe Yes Yes all
grid-monitoring-probes-ch.cern.sam MRS_DBID_path web_service_path parameter of MrsCheckDBInsertsDetailed probe Yes Yes myegi/sam-pi/metricstore_current_load_per_hour_detailed?profile_name=
grid-monitoring-probes-ch.cern.sam MRS_DBID_profile profile parameter of MrsCheckDBInsertsDetailed probe Yes Yes WLCG_CREAM_LCGCE_CRITICAL
grid-monitoring-probes-ch.cern.sam MRS_DBID_service_flavour service_flavour parameter of MrsCheckDBInsertsDetailed probe Yes Yes all
grid-monitoring-probes-ch.cern.sam MRS_DBID_warning warning parameter of MrsCheckDBInsertsDetailed probe Yes Yes 0
grid-monitoring-probes-ch.cern.sam MRS_DBI_hourly_critical hourly_critical parameter of MrsCheckDBInserts probe Yes Yes 5000
grid-monitoring-probes-ch.cern.sam MRS_DBI_hourly_warning hourly_warning parameter of MrsCheckDBInserts probe Yes Yes 20000
grid-monitoring-probes-ch.cern.sam MRS_DBI_path web_service_path parameter of MrsCheckDBInserts probe Yes Yes myegi/sam-pi/metricstore_current_load_per_hour?
grid-monitoring-probes-ch.cern.sam MRS_S_crit_recalc critical_recalc parameter of MrsCheckSpool probe Yes Yes 50000
grid-monitoring-probes-ch.cern.sam MRS_S_crit_spool critical_spool parameter of MrsCheckSpool probe Yes Yes 10000
grid-monitoring-probes-ch.cern.sam MRS_S_path_recalc web_service_path_recalc parameter of MrsCheckSpool probe Yes Yes myegi/sam-pi/num_records_metricdataforrecalculation
grid-monitoring-probes-ch.cern.sam MRS_S_path_spool web_service_path_spool parameter of MrsCheckSpool probe Yes Yes myegi/sam-pi/num_records_metricdata_spool
grid-monitoring-probes-ch.cern.sam MRS_S_warn_recalc warn_recalc parameter of MrsCheckSpool probe Yes Yes 25000
grid-monitoring-probes-ch.cern.sam MRS_S_warn_spool warn_spool parameter of MrsCheckSpool probe Yes Yes 5000
nagios NAGIOS_ADMIN_DNS List of local admin DNs (comma separated) that can perform actions via the nagios web interface No Yes "/DC=ch/OU=Users/CN=DN1,/DC=ch/OU=Users/CN=DN2"
nagios NAGIOS_CGI_ENABLE_CONFIG Switch on automatic configuration of /etc/nagios/cgi.cfg file Yes Yes false
nagios NAGIOS_ESCAPE_HTML If enabled, the metric output will not contain clickable hyperlinks Yes No 1
nagios NAGIOS_HTPASSWD_FILE Location of allowed users for nagios web portal Yes No /etc/nagios/htpasswd.users
nagios NAGIOS_MYPROXY_USER Change the myproxy username Yes Yes nagios
nagios NAGIOS_MYPROXY_NAME Change the myproxy name No Yes "NagiosRetrieve-myHost.cern.ch"
nagios NAGIOS_NAGIOS_ENABLE_CONFIG Switch on automatic configuration of /etc/nagios/nagios.cfg file (if true, nagios will be reload automatically) Yes Yes false
nagios NAGIOS_NSCA_PASS The shared secret used by NSCA (Nagios Service Check Acceptor) for sending results back to the nagios server No Yes "NSCApass"
nagios NAGIOS_SUDO_ENABLE_CONFIG If true, modifies /etc/sudoers to allow nagios to call certain probes as root Yes No false
nagios NAGIOS_TIMEOUT Enable this variable for service check timeout (in seconds) in nagios.cfg Yes Yes 900
NCG ATP_ROOT_URL URL of ATP PI used by NCG (needs to be https) Yes No https://grid-monitoring.cern.ch/atp
NCG ENABLE_ARC_PROBES Switch on ARC probes Yes No false
NCG ENABLE_UNICORE_PROBES Generate configuration and Java truststore used by UNICORE probes Yes No false
NCG GGUS_SERVER_FQDN GGUS endpoint (setting this variable also opens GGUS tickets for service notifications) No No  
NCG INSTALL_ROOT Location of grid middleware No No /opt
NCG NAGIOS_NCG_ENABLE_CONFIG Switch on automatic configuration of /etc/ncg/ncg.conf file (if true, ncg.pl will be executed automatically) Yes Yes false
NCG NCG_BACKUP_INSTANCE Install backup SAM/Nagios instance No No true
NCG NCG_CHECK_HOSTS Defines if Nagios will use ping to check server availability, if the host is unavailable service alarms won't be sent No No 0
NCG NCG_CONTACTS_USE_ATP Use ATP to generate contact lists (requires NCG_TOPOLOGY_USE_ATP to be set) Yes No true
NCG NCG_CONTACTS_USE_GOCDB Use GOCDB to generate contact lists (requires NCG_TOPOLOGY_USE_GOCDB to be set) Yes No true
NCG NCG_ENABLE_NOTIFICATIONS If 1, nagios will be configured to send notifications Yes No 0
NCG NCG_GOCDB_COUNTRY_NAME Use the lists of sites (provided by GOCDB) in this country No No CH
NCG NCG_INCLUDE_EMPTY_HOSTS Show hosts without services associated Yes No 1
NCG NCG_INCLUDE_PROXY_CHECKS Switch on/off internal tests for generating proxy credential Yes No 1
NCG HOST_KEYSTORE_PASS Password used for encrypting host certificate keystore Yes Yes password
NCG NCG_LDAP_ADD_HOSTS Control ADD_HOSTS variable of module NCG::SiteInfo::LDAP (this variable controls if hosts found in BDII are added to configuration) Yes No 0
NCG NCG_LDAP_FILTER If set, NAGIOS will not monitor the SITE_NAME specified above but will instead query the top bdii for !GlueSite objects that match this No No =GlueSiteOtherInfo=EGEE_ROC=ITALY=
NCG NCG_MAIN_DB_DIR Location of local configurations for NCG Yes Yes /etc/ncg/ncg.localdb.d
NCG NCG_MAIN_DB_FILE Local Rules file to modify NCG configuration Yes Yes /etc/ncg/ncg.localdb
NCG NCG_NAGIOS_ADMIN Email address which will receive notifications for Nagios internal checks Yes No root@localhost
NCG NCG_NOTIFICATION_HEADER Change of notification header No No "CERN Nagios"
NCG NCG_NRPE_OUTPUT_DIR Path where NRPE configuration files will be generated Yes Yes /etc/nagios/nrpe/
NCG NCG_NRPE_UI UI hostname for running NRPE (should only be set to use a remote UI) No No ui.example.org
NCG NCG_OUTPUT_DIR Path where the nagios configuration files for the server will be generated Yes No /etc/nagios/wlcg.d
NCG NCG_POEM_ROOT_URL URL of POEM sync that NCG will use Yes Yes "http://localhost/poem_sync"
NCG NCG_PROBES_TYPE Defines which type of probes should be configured Yes Yes remote,local
NCG NCG_REMOTE_NAGIOS_HOSTS List of hosts from where results will be imported (used only on site instance if NCG_REMOTE_USE_NAGIOS is True) No No  
NCG NCG_REMOTE_USE_NAGIOS If true, shows project or ROC remote results in Nagios Yes Yes false
NCG NCG_SEND_TO_DASHBOARD Enables interaction with Dashboard on VO instances Yes No false
NCG NCG_TEMPLATES_DIR Location of NCG configuration templates Yes No /usr/share/grid-monitoring/config-gen/nagios
NCG NCG_TIMEOUT Timeout period (in seconds) after which ncg.pl will exit No No 9600
NCG NCG_TOPOLOGY_USE_ATP Use ATP as topology provider, switches on both NCG::SiteSet and NCG::SiteInfo, also required for NCG::SiteContacts Yes No true
NCG NCG_TOPOLOGY_USE_GOCDB Use GOCDB as topology provider, switches on both NCG::SiteSet and NCG::SiteInfo, also required for NCG::SiteContacts Yes No false
NCG NCG_TOPOLOGY_USE_LDAP Use BDII as topology provider, switches on both NCG::SiteInfo and NCG::LocalMetricsAttrs Yes No false
NCG NCG_USE_ROBOT_CERT If true, enables configuration of robot certificates No No true
NCG NCG_VO Space separated list of VOs the tests should run as (you must have a member of each VO willing to store a proxy for your retrieval) Yes Yes dteam
NCG PX_HOST MyProxy Server to retrieve a certificate to run local tests under No Yes "myproxy.cern.ch"
NCG SITE_BDII_HOST Site BDII for the monitored site, SITE_NAME No Yes "prod-bdii.cern.ch"
NCG UNCERTIFIED_BDII BDII which support uncertified sites No No (Yes if UNCERTIFIED_SITES is set) bdii.uncert.org
NCG UNCERTIFIED_SITES List of space separated names of uncertified sites No No "SiteA SiteB SiteC"
NCG UNCERTIFIED_WMS WMS which support uncertified sites No No (Yes if UNCERTIFIED_SITES is set) wms.uncert.org
NCG UNICORE_KEYSTORE_ALIAS Alias of user credential Yes No mon-agent
NCG UNICORE_KEYSTORE_PASS Password used to protect user credential keystore No No (Yes if ENABLE_UNICORE_PROBES=true ) mon-agent-pass
NCG VO_<VO>_ROBOT_CERT Location of robot certificates (per VO) No No /etc/nagios/globus/robot-cert.pem
NCG VO_<VO>_ROBOT_KEY Location of robot keys (per VO) No No /etc/nagios/globus/robot-key.pem



Obsolete Variables

Common
Component Name
all DB_PASS
all DB_USER
ATP ATP_SYNC_TIMEOUT


SAM-Gridmon


SAM-Nagios
Component Name
MDDB MDDB_SYNC_TIMEOUT
NCG NAGIOS_NCG_ENABLE_CRON
NCG NCG_MDDB_SUPPORTED_PROFILES
NCG NCG_HASH_CONFIG_PROFILES
NCG NCG_PROFILE_FQAN_*
NCG NCG_REMOTE_USE_ENOC
NCG NCG_TOPOLOGY_USE_ENOC
NCG NCG_TOPOLOGY_USE_SAM




NGI_site-info.def (application/octet-stream)
VO_site-info.def (application/octet-stream)
Document generated by Confluence on Feb 27, 2014 10:19