Changes between Version 16 and Version 17 of PlasticSlices/MonitoringRecommendations/FoamConfiguration


Ignore:
Timestamp:
10/04/12 08:38:04 (7 years ago)
Author:
chaos@bbn.com
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • PlasticSlices/MonitoringRecommendations/FoamConfiguration

    v16 v17  
    77This page explains how to configure an !OpenFlow FOAM server for [wiki:PlasticSlices/MonitoringRecommendations central GENI operational monitoring].  This page was written for
    88{{{
    9 tango-monitor-foam_0.3-1
     9tango-monitor-foam_0.4-1
    1010}}}
    1111and may not work well with earlier versions.  We have tested the FOAM utilities 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.
     
    1313== Upgrading from previous versions ==
    1414
    15 Version 0.3 of tango-monitor-foam introduces a new dependency and a config file.  If you are currently running a previous version of `tango-monitor-foam`, you need to do the following steps of this update:
    16  * [#II.Installsoftwaredependencies II. Install software dependencies]
    17  * [#III.Installthemonitoringsoftware III. Upgrade the monitoring software itself]
    18  * [#IV.Createrequireddirectoriesandfiles IV. Create required directories and files: Step 1 (add a config file for monitoring)]
     15Version 0.4 of tango-monitor-foam introduces a script for reporting metadata about your site to the GMOC database.  In addition, version 0.3 introduced a config file.  If you are currently running a previous version of `tango-monitor-foam`, you need to do the following steps of this update:
     16 * [#II.Installthemonitoringsoftware II. Upgrade the monitoring software itself]
     17 * [#III.Createrequireddirectoriesandfiles III. Create required directories and files: Step 1 (add a config file for monitoring)]
     18 * [#IV.Reportsitemetadata IV. Report site metadata]
    1919 * [#V.Testthescript V. Test the new script and make sure it still works]
    2020
    21 If you are installing `tango-monitor-foam` for the first time or upgrading from an earlier version, read all sections to see which steps you need to take.
     21new dependency and a config file.  If you are currently running a previous version of `tango-monitor-foam`, you need to do the following steps of this update:
     22
     23If you are installing `tango-monitor-foam` for the first time or upgrading from a version earlier than 0.2, read all sections to see which steps you need to take.
    2224
    2325== Variables ==
    2426
    2527 * `<cronuser>`: The user as which to run the FOAM monitoring.  The scripts can run as root, or as a non-root user of your choice.  (At GPO, we use the `ganglia` user.)
    26  * `<site>`: a one-word phrase describing your site, probably the name of your university or lab (e.g. `stanford`, `gpolab`).  Use the same value for all hosts your site is monitoring.
     28 * You need several pieces of identifying information for your site:
     29   * `<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`)
     30   * `<organization>`: a one-word name for the organization which runs your FOAM (e.g. `ExoGENI`)
     31   * `<pop>`: a one-word name for the physical location where your FOAM sits (e.g. `gpolab`)
     32 When you setup your config file in step III, you will also need a few pieces of metadata about your organization and POP.
    2733
    2834== Steps to configure FOAM monitoring ==
     
    3238You need to do these steps if you are installing monitoring for the first time.
    3339
    34  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 site resources 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.'''
     40 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.'''
    3541
    3642 2. Store your site password in a file which FOAM monitoring can use:
     
    4147sudo vi /usr/local/etc/monitoring_passwd
    4248}}}
    43  Add exactly one line to this file, containing your site monitoring password.
     49 Add exactly one line to this file, containing the monitoring password you want to use for the user `<submission_user>`.
    4450
    4551 3. Register site credentials: IF you have not yet registered your site to submit data to GMOC, follow the instructions at [wiki:GENIMetaOps/SiteCredentials].
    4652
    47 === II. Install software dependencies ===
    48 
    49 Install `GMOC::ExchangeAPI-0.0.2` by hand (packaged versions of this module are coming soon).
    50 
    51  1. Download the tarball onto the node (e.g. into your home directory):
    52 {{{
    53 wget http://gmoc-db.grnoc.iu.edu/sources/perl-libs/GMOC-ExchangeAPI-0.0.2.tar.gz
    54 }}}
    55  2. Unpack the module into `/usr/local/lib`:
    56 {{{
    57 cd /usr/local/lib
    58 sudo /bin/tar xvzf ~/GMOC-ExchangeAPI-0.0.2.tar.gz GMOC-ExchangeAPI-0.0.2/lib/GMOC --strip-components=2
    59 }}}
    60  3. Verify that this created and populated `/usr/local/lib/GMOC` with the `ExchangeAPI` module files:
    61 {{{
    62 $ ls /usr/local/lib/GMOC/
    63 ExchangeAPI/  ExchangeAPI.pm  ExchangeAPI.pod
    64 }}}
    65 
    66 === III. Install the monitoring software ===
     53=== II. Install the monitoring software ===
    6754
    6855Do these steps every time you install or upgrade the monitoring software.
     
    7057==== If you are installing on Ubuntu ====
    7158
    72  1. Download the `tango-monitor-foam_0.3-1_all.deb` package file from [http://software.geni.net/local-sw/], and copy it onto your FOAM host, e.g. into `~/tango-monitor-foam_0.3-1_all.deb`.
     59 1. Download the `tango-monitor-foam_0.4-1_all.deb` package file from [http://software.geni.net/local-sw/], and copy it onto your FOAM host, e.g. into `~/tango-monitor-foam_0.4-1_all.deb`.
    7360
    7461 2. 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:
    7562{{{
    76 sudo dpkg -i ~/tango-monitor-foam_0.3-1_all.deb
     63sudo dpkg -i ~/tango-monitor-foam_0.4-1_all.deb
    7764sudo apt-get -f install
    7865}}}
     
    8067==== If you are installing on CentOS ====
    8168
    82  1. Download the `tango-monitor-foam-0.3-1.noarch.rpm` package file from [http://software.geni.net/local-sw/], and copy it onto your FOAM host, e.g. into `~/tango-monitor-foam-0.3-1.noarch.rpm`.
     69 1. Download the `tango-monitor-foam-0.4-1.noarch.rpm` package file from [http://software.geni.net/local-sw/], and copy it onto your FOAM host, e.g. into `~/tango-monitor-foam-0.4-1.noarch.rpm`.
    8370
    8471 2. Use yum localinstall to install the local package.  This will install the provided file, using your standard yum repositories to find any dependencies:
    8572{{{
    86 sudo yum --nogpgcheck localinstall ~/tango-monitor-foam-0.3-1.noarch.rpm
     73sudo yum --nogpgcheck localinstall ~/tango-monitor-foam-0.4-1.noarch.rpm
    8774}}}
    8875
    89 === IV. Create required directories and files ===
     76=== III. Create required directories and files ===
     77
     78   * `<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`)
     79   * `<organization>`: a one-word name for the organization which runs your FOAM (e.g. `ExoGENI`)
     80   * `<pop>`: a one-word name for the physical location where your FOAM sits (e.g. `gpolab`)
    9081
    9182Step 1 needs to be done the first time you upgrade from `tango-monitor-foam-0.2` or earlier.  All three steps need to be done the first time you install tango-monitor-foam.
     
    9687/usr/local/etc/gmoc_monitoring.conf
    9788}}}
    98    * Edit the file and make sure it contains the variables `SITENAME`, `ORGNAME`, and `POPNAME`.  ''(N.B. If you are upgrading from a previous version, all three of these variables should contain the `<site>` value you used in the past)'':
     89   * Edit the file and make sure to populate all variables (N.B. use single quotes to surround any value containing whitespace):
    9990{{{
    10091$ cat /usr/local/etc/gmoc_monitoring.conf
    10192
    10293# GMOC short name which is your username for authenticated monitoring data submission
    103 SITENAME=<site>
     94SITENAME=<submission_user>
    10495
    105 # GMOC short name of organization which manages your aggregate (may be the same as SITENAME)
    106 ORGNAME=<site>
     96# GMOC short name of organization which manages your aggregate (may be the same as SITENAME if appropriate)
     97ORGNAME=<organization>
    10798
    108 # GMOC short name of "POP"/lab where your aggregate is located (may be the same as SITENAME)
    109 POPNAME=<site>
     99# GMOC short name of "POP"/lab where your aggregate is located (may be the same as SITENAME if appropriate)
     100POPNAME=<pop>
     101
     102# Primary contact for the organization
     103ORG_PRIMARY_CONTACT_EMAIL=<primary e-mail address for your site, may be an individual address or a group address>
     104ORG_PRIMARY_CONTACT_FIRSTNAME=<a first name associated with that e-mail address>
     105ORG_PRIMARY_CONTACT_LASTNAME=<a last name associated with that e-mail address>
     106
     107# The street address of your POP
     108POPORG_ADDR_STREET='<street address of your POP>'
     109POPORG_ADDR_CITY=<city where your POP is located>
     110POPORG_ADDR_STATE=<state abbreviation of your POP>
     111POPORG_ADDR_POSTCODE=<postal code of your POP>
     112
     113# Some arbitrary name for the street address of your POP
     114POPORG_LOCATION_NAME=<short name of address, should not contain whitespace, e.g. 10_Moulton_St>
    110115}}}
    111116 
     
    124129}}}
    125130 This file should contain the admin password for FOAM.  (This is the password you use with `foamctl` to run FOAM commands.)
     131
     132=== IV. Report site metadata ===
     133
     134Use a reporting script to add your site metadata to GMOC's database:
     135{{{
     136sudo -u <cronuser> /usr/bin/report_site_metadata
     137}}}
     138This should exit successfully with no output.  If any output is reported, contact GMOC or GPO for debugging.
    126139
    127140=== V. Test the script ===