Configuration File Help

Introduction

This page gives an overview of the options for each of the sections of the configuration file that configure-osg.py uses. A description of the syntax for the configuration file can be found here.

Included topic: Configuration File Site Information

Introduction to Site Information Section

This section gives information about the site information and resource settings.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
group	OSG , OSG-ITB	This should be set to either OSG or OSG-ITB depending on whether your resource is in the OSG or OSG-ITB group. Most sites should specify OSG
host_name	String	This should be set to be hostname of the CE that is being configured
site_name	String	This should be set to the OSG site name for the CE
sponsor	String	This should be set to the sponsor of the resource, if your resource has multiple sponsors, you can separate them using commas or specify the percentage using the following format 'osg, atlas, cms' or 'osg:10, atlas:45, cms:45'
site_policy	Url	This should be a url pointing to the resource's usage policy
contact	String	This should be the name of the resource's admin contact
email	Email address	This should be the email address of the admin contact for the resource
city	String	This should be the city that the resource is located in
country	String	This should be country that the resource is located in
longitude	Number	This should be the longitude of the resource. It should be a number between -180 and 180.
latitude	Number	This should be the latitude of the resource. It should be a number between -90 and 90.

Included topic: Configuration File PBS

Introduction to PBS Section

This section gives information about the pbs jobmanager.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
enabled	True, False	This indicates whether the PBS jobmanager is being used or not. It should be set to True or False.
home	String	This should be set to be directory where pbs is installed (location of binaries)
pbs_location	String	This should be set to be directory where pbs is installed (location of binaries)
job_contact	String	This should be the contact string for the pbs jobmanager (e.g. my.host.com/jobmanager-pbs)
util_contact	String	This should be the contact string for the default jobmanager (e.g. my.host.com/jobmanager)
wsgram	True, False	This should be set to True or False depending on whether you want wsgram to be configured. You will need to take additional steps to get wsgram running in addition to this.

Included topic: Configuration File FBS

Introduction to FBS Section

This section gives information about the fbs jobmanager.

WARNING!

FBS is deprecated as a supported jobmanager and will not be supported in OSG 1.2 at all.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
enabled	True, False	This indicates whether the FBS jobmanager is being used or not. It should be set to True or False.
home	String	This should be set to be directory where fbs is installed
fbs_location	String	This should be set to be directory where fbs is installed
job_contact	String	This should be the contact string for the fbs jobmanager (e.g. my.host.com/jobmanager-fbs)
util_contact	String	This should be the contact string for the default jobmanager (e.g. my.host.com/jobmanager)
wsgram	True, False	This should be set to True or False depending on whether you want wsgram to be configured. You will need to take additional steps to get wsgram running in addition to this.

Included topic: Configuration File LSF

Introduction to LSF Section

This section gives information about the lsf jobmanager.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
enabled	True, False	This indicates whether the LSF jobmanager is being used or not. It should be set to True or False.
home	String	This should be set to be directory where lsf is installed
lsf_location	String	This should be set to be directory where lsf is installed
job_contact	String	This should be the contact string for the lsf jobmanager (e.g. my.host.com/jobmanager-lsf)
util_contact	String	This should be the contact string for the default jobmanager (e.g. my.host.com/jobmanager)
wsgram	True, False	This should be set to True or False depending on whether you want wsgram to be configured. You will need to take additional steps to get wsgram running in addition to this.

Included topic: Configuration File SGE

Introduction to SGE Section

This section gives information about the sge jobmanager.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
enabled	True, False	This indicates whether the SGE jobmanager is being used or not. It should be set to True or False.
home	String	This should be set to be directory where sge is installed (e.g. same as $SGE_ROOT variable)
sge_location	String	This should be set to be directory where sge is installed (e.g. same as $SGE_ROOT variable)
sge_root	String	This should be set to be directory where sge is installed (e.g. same as $SGE_ROOT variable)
job_contact	String	This should be the contact string for the sge jobmanager (e.g. my.host.com/jobmanager-sge)
util_contact	String	This should be the contact string for the default jobmanager (e.g. my.host.com/jobmanager)
wsgram	True, False	This should be set to True or False depending on whether you want wsgram to be configured. You will need to take additional steps to get wsgram running in addition to this.

Included topic: Configuration File Condor

Introduction to Condor Section

This section gives information about the Condor jobmanager.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
enabled	True, False	This indicates whether the Condor jobmanager is being used or not. It should be set to True or False.
home	String	This should be set to be directory where condor is installed
condor_location	String	This should be set to be directory where condor is installed. If this is set to a blank variable or UNAVAILABLE, the configure-osg script will try to get this from the VDTSETUP_CONDOR_LOCATION environment variable.
condor_config	String	This should be set to be directory where the condor_config is located. If this is set to a blank variable or UNAVAILABLE, the configure-osg script will try to get this from the VDTSETUP_CONDOR_CONFIG environment variable.
job_contact	String	This should be the contact string for the condor jobmanager (e.g. my.host.com/jobmanager-condor)
util_contact	String	This should be the contact string for the default jobmanager (e.g. my.host.com/jobmanager)
wsgram	True, False	This should be set to True or False depending on whether you want wsgram to be configured. You will need to take additional steps to get wsgram running in addition to this.

Included topic: Configuration File Managed Fork

Introduction to Managed Fork Section

This section gives information about the Managed Fork service.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
enabled	True, False	This indicates whether the managed fork service is being used or not. It should be set to True or False.
condor_location	String	This should be set to be directory where condor is installed. If this is set to a blank variable or UNAVAILABLE, the configure-osg script will try to get this from the VDTSETUP_CONDOR_LOCATION or CONDOR_LOCATION environment variable.
condor_config	String	This should be set to be directory where the condor_config is located. If this is set to a blank variable or UNAVAILABLE, the configure-osg script will try to get this from the VDTSETUP_CONDOR_CONFIG or CONDOR_CONFIG environment variable.

Included topic: Configuration File Misc Services

Introduction to Misc Services Section

This section gives information about setting the options in the Misc Services section.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
glexec_location	String	This gives the location of the glexec installation on the worker nodes, if it is present. If it is not installed, set this to UNAVAILABLE
use_syslog_ng	True, False	This indicates whether syslog_ng should be setup. It should be set to True or False
use_cert_updater	True, False	This indicates whether vdt certificate updater should be enabled. It should be set to True or False. If this is not enabled, you will need to use the rpm updates or pacman updates to keep your certificates up to date.

Included topic: Configuration File RSV

Introduction to RSV Section

This section gives information about setting the options in the RSV section.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
enabled	True, False	This indicates whether the rsv service is being used or not. It should be set to True or False.
rsv_user	String	This gives username that rsv will run under. If this is blank or set to UNAVAILABLE, it will default to rsvuser.
enable_ce_probes	True, False	This indicates whether rsv should schedule CE probes. It should be set to True or False. If this is enabled, related option(s) below must be set as well
ce_hosts	String	This option lists the FQDN of the CEs that the RSV CE probes should check. This should be a list of FQDNs separated by a comma (e.g. my.host,my.host2,my.host3). This must be set if enable_ce_probes is set. If this is left blank or set to UNAVAILABLE, the CE's hostname is used by default.
enable_gums_probes	True, False	This indicates whether rsv should schedule gums probes. It should be set to True or False. If this is enabled, related option(s) below must be set as well Note that the GUMS probe is distributed as an experimental component, and admins are recommended not to enable it on production resources.
gums_hosts	String	This option lists the FQDN of the CEs or SEs, using GUMS for authentication, that the RSV GUMS probes should check. This should be a list of CE or SE FQDNs (and not a GUMS server FQDN) separated by a comma (e.g. my.host,my.host2,my.host3). This will default to the ce_hosts option if it is left blank or set to UNAVAILABLE
enable_gridftp_probes	True, False	This indicates whether rsv should schedule gridftp probes. It should be set to True or False. If this is enabled, several of the following options must be set as well
gridftp_hosts	String	This option lists the FQDN of the gridftp servers that the RSV gridftp probes should check. This should be a list of FQDNs separated by a comma (e.g. my.host,my.host2,my.host3). This will default to the ce_hosts option if it is left blank or set to UNAVAILABLE
gridftp_dir	String	This should be the directory that the gridftp probes should use during testing. It must be given if enable_gridftp_probes is enabled. This defaults to /tmp if left blank or set to UNAVAILABLE.
enable_srm_probes	True, False	This indicates whether rsv should run srm probes is being used or not. It should be set to True or False. If this is enabled, several of the following options must be set as well
srm_hosts	String	This option lists the FQDN of the srm servers that the RSV srm probes should check. This should be a list of FQDNs separated by a comma (e.g. my.host,my.host2,my.host3). This will default to the ce_hosts option if it is left blank or set to UNAVAILABLE
srm_dir	String	This should be the directory that the srm probes should use during testing. It must be given if enable_srm_probes is enabled.
srm_webservice_path	String	This option gives the webservice path that SRM probes need to use along with the host: port. For dcache installations, this should work if left blank. However Bestman-xrootd SEs normally use srm/v2/server as web service path, and so Bestman-xrootd admins will have to pass this option with the appropriate value (for example: "srm/v2/server") for the SRM probes to pass on their SE.
use_service_cert	True, False	This option indicates whether rsv should use a service certificate or not. If this is enabled, the following three options must be set as well. This should be set to True or False. If you run RSV right on a CE (SE), and only monitor that CE (SE), then you can use a service certificate. The important factor is that the service certificate or its proxy, per its policy and the OSG security group's mandate, should not leave the host it was generated for, and can only be used to test that one host. See Should I use a service certificate or a user certificate? for more details.
rsv_cert_file	String	This option should point to the public key file (pem) for your service certificate. If this is left blank or set to UNAVAILABLE and the use_service_cert setting is enabled, it will default to /etc/grid-security/rsvcert.pem
rsv_key_file	String	This option should point to the private key file (pem) for your service certificate. If this is left blank or set to UNAVAILABLE and the use_service_cert setting is enabled, it will default to /etc/grid-security/rsvkey.pem .
rsv_proxy_out_file	String	This should point to the location of the rsv proxy file. If this is left blank or set to UNAVAILABLE and the use_service_cert setting is enabled, it will default to /tmp/rsvproxy.
proxy_file	String	If you don't use a service certificate for rsv, you will need to specify a proxy file that RSV should use in the proxy_file setting. This needs to be set if use_service_cert is disabled.
enable_gratia	True, False	This option will enable RSV record uploading to central RSV collector at the GOC. This should be set to True on all OSG resources (and to False on non-OSG resources).
print_local_time	True, False	This option determines whether rsv will display times in the local time in the web pages that it produces. If this is disabled, times displayed will be given in the GMT time zone. This should be set to True or False.
setup_rsv_nagios	True, False	This option indicates whether rsv should upload results to a local nagios server instance. This should be set to True or False. This plugiin is provided as an experimental component, and admins are recommend not to enable it on production resources.
rsv_nagios_conf_file	String	The rsv_nagios_conf_file option indicates the location of the rsv nagios file to use for configuration details. This file needs to be configured locally for RSV-Nagios forwarding to work -- see inline comments in file for more information.
setup_for_apache	True, False	The setup_rsv_nagios option indicates whether rsv try to create a webpage that can be used to view the status of the rsv tests. Enabling this is highly encouraged.

Included topic: Configuration File Storage

Introduction to Storage Section

This section gives information about the options in the Storage section of the configuration file. Several of these values are constrained and need to be set in a way that is consistent with one of the OSG storage models. Please review the Storage Related Parameters section of the Environment Variables description as well as the Overview of Services and Site Planning discussions for explanations of the various storage models and the requirements for them.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
se_available	True, False	This indicates whether there is an associated SE available. It should be set to True or False.
default_se	String	If an SE is available at your cluster, set default_se to the hostname of this SE, otherwise set default_se to UNAVAILABLE.
grid_dir	String	The grid_dir setting should point to the directory which holds the files from the OSG worker node package. It should be visible on all of the computer nodes and will be accessed via the $OSG_GRID environment variable. Read access is required, though worker nodes don't need write access.
app_dir	String	The app_dir setting should point to the directory which contains the VO specific applications, this should be visible on both the CE and worker nodes and will be accessed via $OSG_APP. Only the CE needs to have write access to this directory.
data_dir	String	The data_dir setting should point to a directory that can be used to store and stage data in and out of the cluster and accessed via the $OSG_DATA variable. This directory should be readable and writable on both the CE and worker nodes.
worker_node_temp	String	The worker_node_temp directory (accessed via $OSG_WN_TMP) should point to a directory that can be used as scratch space on compute nodes. It should allow read and write access on a worker node and can be visable to just that worker node. If not set, the default is UNAVAILABLE
site_read	String	The site_read setting should be the location or url to a directory that can be read to stage in data via the variable $OSG_SITE_READ. This is an url if you are using a SE. If not set, the default is UNAVAILABLE
site_write	String	The site_write setting should be the location or url to a directory that can be write to stage out data via the variable $OSG_SITE_WRITE. This is an url if you are using a SE . If not set, the default is UNAVAILABLE

Included topic: Configuration File Squid

Introduction to Squid Section

This section gives information about the options in the Squid section of the configuration file.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
enabled	True, False	This indicates whether the squid service is being used or not. It should be set to True or False.
location	String	This should be set to the location (directory or hostname) of the squid service. This should be set to a directory if squid is installed on the CE.
policy	String	This should be set to the policy that squid is using to manage it's cache (e.g. GDSF)
cache_size	String	This option should be set to the size of the disk cache that squid has available. It should be given as the number of megabytes available (e.g. 1024)
memory_size	String	This option should be set to the size of the memory cache that squid has available. It should be given as the number of megabytes available (e.g. 1024)

Included topic: Configuration File Mona Lisa

Introduction to Monalisa Section

This section gives information about the options in the Monalisa section of the configuration file.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
enabled	True, False	This indicates whether the MonaLisa? service is being used or not. It should be set to True or False.
use_vo_modules	String	If you want Monalisa to use the OSG_VO module to monitor job usage by VO, set this to True, otherwise set this to False. This will default to True if left blank.
ganglia_support	True, False	This setting should be enabled if you are using ganglia on your cluster and you wish Monalisa to use it as well. Set this to True or False.
ganglia_host	String	If you've enabled ganglia support, you should enter the hostname or IP address of the ganglia server here.
ganglia_port	String	If you've enabled ganglia support, you should enter the port that ganglia is running on. This will default to 8649 if left blank or set to UNAVAILABLE when ganglia_support is enabled.

Included topic: Configuration File GIP

Introduction to GIP Section

This section gives information about the options in the GIP section of the configuration file.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
batch	String	This should give the name of the batch system in use on this CE. It should be one of pbs, fbs, sge, lsf, or condor.
advertise_gums	True, False	If you want GIP to query your gums server set this to True, otherwise set this to False.
advertise_gsiftp	True, False	If you want GIP to advertise your gridftp server set this to True, otherwise set this to False.
gsiftp_host	String	This should be set to the name of the gridftp server GIP will advertise if the advertise_gridftp setting is set to True.
gsiftp_path	String	This is the location on the gsiftp server that incoming data can be placed in. This should should be set to OSG_DATA if your gsiftp server is your CE.
srm	True, False	This setting indicates whether you have a SE associated with this CE whose information you would like GIP to publish. Set this to True or False.
se_name	String	If you want GIP to publish on your SE, then you should fill in the registered OSG name of the SE in the next setting (e.g. UC_ITB_SE) . If srm is set to True, then this is required.
se_host	String	If srm is set to True, then this should be set to the hostname of your SE.
srm_implementation	String	If srm is set to True, then this setting should have the SRM implementation that you are using (e.g. dcache, bestman, etc)
dynamic_dcache	True, False	If you are using a dcache based se, GIP can query it dynamically to obtain the values it should advertise, however you'll need to do some other configuration in order to accomplish this See https://twiki.grid.iu.edu/twiki/bin/view/InformationServices/DcacheGip if you have enabled this setting. This should be set to True or False.
srm_version	String	If you are advertising a SE through GIP, this setting should have the version of your srm implementation (e.g. 1.8.0-12pl4)
se_access_number	Integer	This setting gives the number of gsiftp access points available for your SE
se_access_version	String	Set this to the protocol version that should be used to access your SE. Set to 1.0.0 for gsiftp and 2.0.0 for gsiftp2 . This should probably be set to 1.0.0
se_access_endpoints	String	Set this option to the urls endpoints of your SE's gsiftp servers separated by commas if you have multiple servers (e.g. gsiftp://ftp.host1:port,gsiftp://ftp.host2:port)
se_control_version	String	Set this setting with the protocol version that your SE supports e.g. 1.1.0, 2.2.0
se_root_path	String	Set this to the path to the base path to your SE's storage area. E.g. /pnfs/your.site/data
simplified_srm	True, False	If you want all VOs to use a single path on your SE enable this setting below, otherwise set this to False
vo_dir	String	This directory will give the suffix that should be applied to the se_root_path setting above. If you enabled the simplified_srm setting, set this to the path that all VOs should use. If you are using VO specific directories, enter the path that VOs should use, PLEASE NOTE: VONAME in the path will be replaced with the VOs actual name. The VOs that will be advertised are obtained from the osg-user-vo-map.txt file. E.g. if you are enabled the simplified_srm setting and set se_root_path to /pnfs/myhost/data and set this setting to vo_location, then the path used by VOs would be /pnfs/myhost/data/vo_location
special_vo_dir	String	This option allows directories for specific VOs to be entered directly. This should be done using the following format: vo1:/vo1/dir,vo2:/vo2/dir
sc_number	Number	Enter the number of subclusters that your CE has below. This should be an integer greater than or equal to 1

For each subcluster , enter cluster information by entering the options followed by a numeric label for each option. All the information should be for the worker nodes in the cluster. The numeric label used should be less than or equal to the sc_number setting. The information needed is:

Option	Values Accepted	Description
sc_name_#	String	Should be the name of the subcluster
sc_vendor_#	String	Should be the cpu vendor (e.g. Genuine Intel, Authentic AMD, etc.)
sc_model_#	String	Should be the model of the cpu as return by /proc/cpuinfo (e.g. Dual Core AMD Opteron(tm) Processor 275)
sc_clock_#	Integer	Should be the clock speed of the cpu in Mhz
sc_numlcpus_#	Integer	Should be the number of logical cpus on the nodes in the cluster
sc_numpcpus_#	Integer	Should be the number of physical cpus on the nodes in the cluster
sc_ramsize_#	Integer	Should be the ram available in MB (e.g. 4192)
sc_inbound_#	True, False	Should be true or false depending on whether inbound connectivity is available
sc_outbound_#	True, False	Should be true or false depending on whether inbound connectivity is available
sc_nodes_#	Integer	Should be the number of worker nodes available in the cluster

Be aware the the GIP is very picky about integer values - specifically, sometimes /proc/cpuinfo will output the Mhz speed of a CPU in a floating point format; this will cause the GIP to choke silently.

Additional options can be set and passed through to the gip-attributes.conf by entering this as

OSG_GIP_MY_SETTING = foo

in the gip configuration section.

Included topic: Configuration File Install Locations

Introduction to Install Locations Section

This section gives information about the options in the Install Locations section of the configuration file.

Options

The options given in bold type are mandatory.

Option	Values Accepted	Explanation
osg	String	This should be the location of the osg installation. This will default to $VDT_LOCATION if left blank or set to UNAVAILABLE.
globus	String	This should be the location of the globus installation. This will default to $VDT_LOCATION/globus if left blank or set to UNAVAILABLE.
user_vo_map	String	This should be the location of the osg-user-vo-map.txt file . This will default to $VDT_LOCATION/monitoring/osg-user-vo-map.txt if left blank or set to UNAVAILABLE.
gridftp_log	String	This should be the location of the gridftp log file. This will default to $VDT_LOCATION/globus/var/log/gridftp.log if left blank or set to UNAVAILABLE.

Complete:
Responsible: SuchandraThapa - 06 May 2008
Reviewer - date: