Table Of Contents

Previous topic

Welcome to AGIS documentation!

Next topic

Overview

Installation

Release:1.2.9
Date:October 11, 2013

This page covers the necessary steps to install AGIS client or use preinstalled snapshots available on AFS location.

Local installation

AGIS provides RPMs packages to install client libraries locally on the system. To deploy AGIS client following packages should be installed:

  • agis-common
  • agis-api

RPMs can be found at http://atlas-agis-api.cern.ch/agis-client_rpms/

AGIS client API depends on pycurl library, so pycurl packages should be also installed on client machine.

AFS Setup

It’s also possible to use preinstalled AGIS client packages available on AFS location. To enable AGIS environment following setup scripts could be used:

  • python2.6, lxplus machines:

    $ ssh lxplus
    $ source /afs/cern.ch/user/a/agis/public/AGISClient/latest/setup.py26.sh
  • machines with python2.5 installed:

    $ source /afs/cern.ch/user/a/agis/public/AGISClient/latest/setup.py25.sh

To set up the environment of specific AGIS release available on AFS:

$ source /afs/cern.ch/user/a/agis/public/AGISClient/agis-X.Y.Z/setup.py2{5,6}.sh

where X.Y.Z is a release number like 1.2.9.

Note

setup.py2{5,6}.sh script is intended to be used under Bash compatible shells. If your current interpreter is not Bash compatible, do run sh first:

$ ssh lxplus
$ sh
$ source /afs/cern.ch/user/a/agis/public/AGISClient/latest/setup.py26.sh

AGIS config file

The agis.conf configuration file is used to configure, to specify and to overwrite default values for configuration parameters required by AGIS.

Following parameters can be set in the configuration file:

agis.conf
Parameters:
  • host – the host name of server endpoint to use
  • port – port number of server endpoint to use
  • cache_expire_time – the life time value (in seconds) for cached content
  • cache_file_sync_time – time value (in seonds) specified how often to sync memory cache content with file one

Note

Zero value for cache_file_sync_time parameter means not to use file cache at all.

Default config values

TiersOfATLAS Module:

cache_expire_time = 10800 # 3 hours
cache_file_sync_time = 60 # 1 minute

AGIS Module:

cache_expire_time = 10800 # 3 hours
cache_file_sync_time = 60 # 1 minute

Following funcitons have specific cache_expire_time value definitions (in seconds):

AGIS.list_downtimes = 300, AGIS.get_site_status = 300, AGIS.list_sites_status = 300

Functions matched following patterns are totally excluded from the list of ones being cached:

{‘startswith’: [‘set’, ‘add’, ‘remove’]}

Config file locations

The configuation file can be located in different places.

AGIS finds agis.conf file in following locations (in order of preference):
  • current directory
  • $HOME/.agis/ directory
  • /opt/agis/ dicrectory

Example of agis.conf file

[agis.api]

host = atlas-agis-api.cern.ch
port = 80

# default is 10800 secs, 3hours
#cache_expire_time = 10800

# how often to sync memory cache content with disk based one, default is 60 secs,
# zero value means not to use file cache at all
#cache_file_sync_time = 60

#logging.file.name =
logging.file.name = /tmp/agis.log
#logging.file.level = ERROR
logging.file.level = INFO
#logging.file.formatter = [%%(asctime)s] [%%(name)s] [%%(levelname)s] %%(message)s
#logging.file.maxGb = 0.5
#logging.file.backupCount = 3


[agis.info.TiersOfATLASCacheable]

#logging.file.name =
logging.file.name = /tmp/agis.info.log
#logging.file.level = ERROR
logging.file.level = INFO
#logging.file.formatter = [%%(asctime)s] [%%(levelname)s] %%(message)s
#logging.file.maxGb = 0.5
#logging.file.backupCount = 3

# dump queries: logging.file.level verbosity level should at least DEBUG or above

#logging.dump.file.name =
#logging.dump.file.name = /tmp/agis.info.queries.log
#logging.file.formatter = [%%(asctime)s] [%%(levelname)s] %%(message)s
#logging.dump.file.formatter = kwargs, args=%%(kwargs_)s, %%(args_)s
#                              print TiersOfATLAS.%%(fname)s(*args, **kwargs) # %%(asctime)s in_cache=%%(in_cache)s
#logging.dump.file.maxGb = 0.5
#logging.dump.file.backupCount = 3

[agis.api.AGISCacheable]

# same configuration description as for TiersOfATLASCacheable