wiki:TangoGeniMonitoring/GmocConfiguration

Version 2 (modified by chaos@bbn.com, 7 years ago) (diff)

--

How to configure tango-monitor-gmoc for GMOC reporting

Introduction

This page explains how to install and configure the tango-monitor-gmoc package for central GENI operational monitoring, on any supported operating system. The tango-monitor-gmoc package is the base package for reporting data to GMOC, and should be a dependency for any aggregate-specific software which reports data to GMOC.

This page was written for:

tango-monitor-gmoc-1.2.12-1

and may not work well with earlier versions. We have tested these instructions on Ubuntu 10.04 only, but expect they will also work on CentOS. If you are running a different OS and it is not obvious how to translate the instructions, please contact GPO infra.

Compatibility note: gmoc.py, the GMOC monitoring client, requires python2.6 or later. If the default python on your system is earlier than 2.6, you'll need to install a secondary python. GPO infra has done this for CentOS 5, and can provide suggestions.

Upgrading from previous versions

This is the first packaged version of tango-monitor-gmoc, so there are no upgrades from previous versions.

Variables

  • <cronuser>: The user as which to run GMOC monitoring. The scripts can run as root, or as a non-root user of your choice. (At GPO, we use the ganglia user.)
  • You need several pieces of identifying information for your site:
    • <submission_user>: a one-word phrase describing your site, which is your username for data submission to GMOC (see step I) (e.g. ExoGENI-BBN)
    • <organization>: a one-word name for the organization which runs the aggregates which are reporting (e.g. ExoGENI)
    • <pop>: a one-word name for the physical location where your aggregates sit (e.g. gpolab)

When you setup your config file in step III, you will also need a few pieces of metadata about your organization and POP.

Steps to configure monitoring submission

I. Prepare to submit authenticated monitoring data to GMOC

You need to do these steps if you are installing monitoring for the first time.

  1. IF you have not yet registered your site to submit data to GMOC, generate a password for automated monitoring data submission to use. All resources managed by a given set of people use the same credential; you only need to do this step once for your entire site. Note: the password you use for your site registration is a new password generated for the purpose of submitting monitoring data. Do not reuse any existing passwords from your site.
  1. Store your site password in a file which monitoring can use. (The password file location is configurable, but use the default unless you have a reason to do something different):
    sudo touch /usr/local/etc/monitoring_passwd
    sudo chown <cronuser> /usr/local/etc/monitoring_passwd
    sudo chmod 600 /usr/local/etc/monitoring_passwd
    sudo vi /usr/local/etc/monitoring_passwd
    
    Add exactly one line to this file, containing the monitoring password you want to use for the user <submission_user>.
  1. Register site credentials: IF you have not yet registered your site to submit data to GMOC, follow the instructions at GENIMetaOps/SiteCredentials.

II. Install the monitoring software

Do these steps every time you install or upgrade tango-monitor-gmoc.

If you are installing on Ubuntu

  1. Download the tango-monitor-gmoc_1.2.12-1_all.deb package file from http://software.geni.net/local-sw/, and copy it onto your reporting host, e.g. into ~/tango-monitor-gmoc_1.2.12-1_all.deb.
  1. Use dpkg to install the local package. This may fail due to dependencies and say it is leaving the package "unconfigured". Therefore, invoke apt-get to fix any missing dependencies:
    sudo dpkg -i ~/tango-monitor-gmoc_1.2.12-1_all.deb
    sudo apt-get -f install
    

If you are installing on CentOS

  1. Download the tango-monitor-gmoc-1.2.12-1.noarch.rpm package file from http://software.geni.net/local-sw/, and copy it onto your FOAM host, e.g. into ~/tango-monitor-gmoc-1.2.12-1.noarch.rpm.
  1. Use yum localinstall to install the local package. This will install the provided file, using your standard yum repositories to find any dependencies:
    sudo yum --nogpgcheck localinstall ~/tango-monitor-gmoc-1.2.12-1.noarch.rpm
    

III. Create required directories and files

  • <submission_user>: a one-word phrase describing your site, which is your username for data submission to GMOC (see step I) (e.g. ExoGENI-BBN)
  • <organization>: a one-word name for the organization which runs your FOAM (e.g. ExoGENI)
  • <pop>: a one-word name for the physical location where your FOAM sits (e.g. gpolab)

This step needs to be done the first time you install tango-monitor-gmoc-1.2.12-1 or later.

  1. Populate the gmoc_monitoring configuration file:
    • Create the config file (the file does not contain sensitive information, and may safely be left world-readable):
      /usr/local/etc/gmoc_monitoring.conf
      
    • Edit the file and make sure to populate all variables (N.B. use single quotes to surround any value containing whitespace):
      $ cat /usr/local/etc/gmoc_monitoring.conf
      
      # GMOC short name which is your username for authenticated monitoring data submission
      SITENAME=<submission_user>
      
      # GMOC short name of organization which manages your aggregate (may be the same as SITENAME if appropriate)
      ORGNAME=<organization>
      
      # GMOC short name of "POP"/lab where your aggregate is located (may be the same as SITENAME if appropriate)
      POPNAME=<pop>
      
      # Primary contact for the organization
      ORG_PRIMARY_CONTACT_EMAIL=<primary e-mail address for your site, may be an individual address or a group address>
      ORG_PRIMARY_CONTACT_FIRSTNAME=<a first name associated with that e-mail address>
      ORG_PRIMARY_CONTACT_LASTNAME=<a last name associated with that e-mail address>
      
      # The street address of your POP
      POPORG_ADDR_STREET='<street address of your POP>'
      POPORG_ADDR_CITY=<city where your POP is located>
      POPORG_ADDR_STATE=<state abbreviation of your POP>
      POPORG_ADDR_POSTCODE=<postal code of your POP>
      
      # Some arbitrary name for the street address of your POP
      POPORG_LOCATION_NAME=<short name of address, should not contain whitespace, e.g. 10_Moulton_St>
      

IV. Report site metadata

Use a reporting script to add your site metadata to GMOC's database:

sudo -u <cronuser> /usr/bin/report_site_metadata

This should exit successfully with no output. If any output is reported, contact GMOC or GPO for debugging.

Note: if you change any of the variables in your configuration file later, you will need to run report_site_metadata again, to get the changes into GMOC's database.

Outcome

At this point, your host is configured for submission of monitoring data to GMOC. To submit data for one or more specific GENI aggregates, resources, or slice authorities, install another tango-monitor package for your specific aggregate, or your own custom software which uses gmoc.py.