Changes between Version 95 and Version 96 of Doc/gLite/TemplateCustomization


Ignore:
Timestamp:
Oct 19, 2008, 2:40:07 PM (17 years ago)
Author:
/O=GRID-FR/C=FR/O=CNRS/OU=LAL/CN=Michel Jouvin
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Doc/gLite/TemplateCustomization

    v95 v96  
    66Site customization to QWGtemplates is done through a small set of templates used to define variables used as input by QWG templates. This doesn't cover OS basic configurationt that is decribed in the page about [wiki:Doc/TemplateCustom template framework].
    77
    8 All site parameters related to QWG middleware are supposed to be declared in template `pro_lcg2_config_site.tpl`. To start a new site, import the site paramater template [source:templates/trunk/sites/example/site/pro_lcg2_config_site.tpl example]. The list of all available variables with their description and their default value can be consulted in template source:templates/trunk/grid/glite-3.1/defaults/glite.tpl. '''This template is a critical part of standard templates and should not be modified or duplicated'''.
     8All site parameters related to QWG middleware are supposed to be declared in template `site/glite/config.tpl`. To start a new site, import the site paramater template [source:templates/trunk/sites/example/site/site/glite/config.tpl example]. The list of all available variables with their description and their default value can be consulted in template source:templates/trunk/grid/glite-3.1/defaults/glite.tpl. '''This template is a critical part of standard templates and should not be modified or duplicated'''.
    99
    1010''Note : Information in this page may document features or configuration options not present in the current release. These information are related to changes and improvement that will be available in next release and are already present in the [source:templates/branches/gLite-3.1 current development branch]. If you are urgently requiring these features, [wiki:Download/QWGTemplates use content] of this branch.''
    1111
    12 Documentation in this page is based on [source:templates/trunk/grid/glite-3.1 QWG templates for gLite 3.1]. Everything mentionned here also applies to [source:templates/trunk/grid/glite-3.0.0 QWG templates for gLite 3.0], except when explicitly stated.
     12Documentation in this page is based on [source:templates/trunk/grid/glite-3.1 QWG templates for gLite 3.1]. Most of the documentation also applies to deprecated [source:templates/trunk/grid/glite-3.0.0 QWG templates for gLite 3.0], except when explicitly stated or for features supported only by 3.1 serie.
     13
     14''Note: this documentation often makes reference to a template called `site/glite/config.tpl`. This template used to be called `pro_lcg2_config_site.tpl` in the past. Both names are valid and taken into account by current templates, even though the namespaced name is the recommended one.''
     15
     16== gLite Site Parameters ==
     17
     18gLite site parameters are grouped in one site specific template, `site/glite/config.tpl`. Look at the [source:templates/trunk/sites/example/site/glite/config.tpl example] for typical site parameters. To create a new site, you can copy and modify the example. Comments in this file explain the valid values.
     19
     20In addition to explicit configuration values specified in site parameters, one [source:templates/trunk/grid/glite-3.1/defaults/glite/config.tpl template] defines the default values for each parameter used in the templates.
     21
     22This page explains in more details the main variables allowed for gLite customization to your site. Refer to the [source:templates/trunk/sites/example/site/glite/config.tpl example] or the [source:templates/trunk/grid/glite-3.1/defaults/glite/config.tpl default values] for a more detailed list of available parameters.
    1323
    1424== Machine types ==
    … …  
    4252The following sections describe specific variables that can be used with each machine type. The machine type template to include is specified at the beginning of the section as ''Base template''. In addition, to get more details, you can look at [source:templates/clusters/example-3.1/profiles examples].
    4353
     54
     55== Site Information ==
     56
     57Every EGEE site must publish some general information about it, mainly:
     58
     59 * `SITE_NAME`: the site name
     60 * `SITE_LOC`: site geographical location. Format must be "City, Country".
     61 * `SITE_LAT`: site latitude (number)
     62 * `SITE_LONG`: site longitude (number)
     63 * `SITE_OTHER_INFO` : must contain at least the ROC your site is attached to, specified as "EGEE-ROC=xx" with xx the ROC country code.
     64 * `SITE_EMAIL` : sysadmins contact for the site
     65 * `SITE_SECURITY_EMAIL` : site email contact for security issues. Default to `SITE_EMAIL`.
     66 * `SITE_SECURITY_EMAIL` : site email contact for user support. Default to `SITE_EMAIL`.
     67
     68See [http://goc.grid.sinica.edu.tw/gocwiki/How_to_publish_my_site_information GOC wiki] for more information on site informations.
     69
    4470== VO Configuration ==
    4571
    46 List of VOs to configure on a specific node is defined in variable `VOS`. Generally a site-wide default value is defined in `pro_lcg2_config_site.tpl` (defined with operator `?=`). This value can be overidden on a specific machine by defining `VOS` variable in the machine profile, before including the machine type profile.
     72List of VOs to configure on a specific node is defined in variable `VOS`. Generally a site-wide default value is defined in `site/glite/config.tpl` (defined with operator `?=`). This value can be overidden on a specific machine by defining `VOS` variable in the machine profile, before including the machine type profile.
    4773
    4874An example of VOS definition is :
    … …  
    75101
    76102
     103=== Defining a VO alias name ===
     104
     105VO names, now based on a DNS-like name, can be quite long and not very convenient to use in the configuration. This is possible to define a local alias for the VO name and use it in the site configuration in place of the VO name.
     106
     107To define such an alias, a template [source:templates/trunk/grid/glite-3.1/vo/site/aliases.tpl aliases.tpl] must exist in directory `vo/site` in your site or cluster directory. This template must define the variable `VOS_ALIASES` as a nlist where the key is the VO alias name and the value the actual VO name.
     108
     109For example:
     110{{{
     111variable VOS_ALIASES ?= nlist(
     112  'agata',  'vo.agata.org',
     113  'apc',  'vo.apc.univ-paris7.fr',
     114  'astro',  'astro.vo.eu-egee.org',
     115  'lal',  'vo.lal.in2p3.fr',
     116);
     117}}}
     118
     119
    77120=== Site Specific Defaults for VO Parameters ===
    78121
    … …  
    90133 * `sw_mgr_role` : description of VO software manager role. Avoid to change default.
    91134 * Location of standard services. See [wiki:Doc/gLite/TemplateCustomization#DefaultServicesforaVO below].
     135
    92136For example, to define a site specific RB for VO Alice, create a template `vo/site/alice.tpl` in your site directory like :
    93137{{{
    … …  
    97141}}}
    98142
    99 and add the following entry in `VOS_SITE_PARAMS` in your `pro_lcg2_config_site.tpl` :
     143and add the following entry in `VOS_SITE_PARAMS` in your `site/glite/config.tpl` :
    100144{{{
    101145variable VOS_SITE_PARAMS = nlist ('alice', 'vo/site/alice',
    102146                                 );
    103147}}}
     148
     149''Note: if a template `vo/site/VONAME` can be located, it'll be loaded even though there is no explicit entry for the VO into variable `VOS_SITE_PARAMS`.''
    104150
    105151Alternativly, you can define these parameters directly into `VOS_SITE_PARAMS` :
    … …  
    110156}}}
    111157
    112 In addition to `VOS_SITE_PARAMS`, '''which is the recommended method''' to specify site-specific parameters for VO configuration, it is also possible to execute a site-specific template before doing the configuration related to VOs. Use variable `NODE_VO_CONFIG` to specify the name of the template.
     158In addition to `VOS_SITE_PARAMS`, '''which is the recommended method''' to specify site-specific parameters for VO configuration, it is also possible for some specific purposes to execute a site-specific template before doing the configuration related to VOs. Use variable `NODE_VO_CONFIG` to specify the name of the template.
    113159
    114160=== Adding a New VO ===
    … …  
    238284 * `NFS_LOCAL_CLIENTS` : list of other local hosts requiring access to NFS server
    239285
    240 These variables can be a string, a list or a nlist. A string value is interpreted as a list with one element. When specified as a list or string, the value must be regexp matching name of nodes that must be given access to NFS server. The access right is the value of variable `NFS_DEFAULT_RIGHTS`. When specified as a nlist, the key must be an '''escaped''' regexp and the value is the access rights.
    241 
    242 ''Note : when possible, this is recommended to replace default value for NFS_WN_HOSTS by one or several regexpsmatching WN names.''
     286These variables can be a string, a list or a nlist. A string value is interpreted as a list with one element. When specified as a list or string, the value must be regexp matching name of nodes that must be given access to NFS server. In this case, the access rights (export options) is based on variable `NFS_DEFAULT_RIGHTS`. When specified as a nlist, the key must be an '''escaped''' regexp matching node names (in exports format, only `*` and `?` wilcards permitted) and the value is the export options between `()`.
     287
     288''Note : when possible, this is recommended to replace default value for NFS_WN_HOSTS (list of all WNs) by one or several regexps matching WN names.''
     289
     290`NFS_DEFAULT_RIGHTS` is a nlist which must contain a `DEFAULT` entry used for any file system without an explicit entry and optionally one entry per file system (key is the escaped file system path) when defaults are not appropriate. Default is `rw` with root squashing enabled for all file systems (`DEFAULT` entry), except `/home` where root squashing is disabled.
     291
     292Antoher variable, `NFS_CLIENT_HOSTS` allows to define per file system the clients allowed to access the file system. There is a default entry (`DEFAULT`) used for any file system without an explicit entry. The default value for default entry is all the hosts specified by `NFS_CE_HOSTS`, `NFS_WN_HOSTS` and `NFS_LOCAL_CLIENTS`. Key specifying a file system path must be escaped. Host list of allowed clients may be specified using regexps in export format.
     293
     294''Note: currently `NFS_CLIENT_HOSTS` is used to build the list of hosts in `exports` file but has no impact on the mounting of file systems on clients.''
    243295
    244296=== NFS Server ===
    … …  
    266318 * `CE_LOCAL_QUEUES` : a list of Torque queue to define that will not be available for grid usage (accessible only with standard Torque commands). This list has a format very similar to `CE_QUEUES`, except that key containing queue name is called `names` instead of `vos` and that its value is useless.
    267319 * `CE_PRIV_HOST` : alternate name of PBS/Torque server. Used in configuration where WNs are in a private network and PBS/Torque master has 2 network names/adresses.
    268  * `CE_QUEUES` : a nlist defining for each queue the list of VOs allowed to access the queue and optionally the specific attributes of the queue. Access list for queue is defined under `vos` key, attributes under `attlist` key. The value for each key is a nlist where the key is queue name. For access list, the value is a list of VO allowed access to the queue. For queue attributes, the value is a nlist where the key is a Torque attribute and the value the attribute value. Look at [source:templates/trunk/sites/example/site/pro_lcg2_config_site.tpl example] for more information on how to define one queue for each supported VO.
     320 * `CE_QUEUES` : a nlist defining for each queue the list of VOs allowed to access the queue and optionally the specific attributes of the queue. Access list for queue is defined under `vos` key, attributes under `attlist` key. The value for each key is a nlist where the key is queue name. For access list, the value is a list of VO allowed access to the queue. For queue attributes, the value is a nlist where the key is a Torque attribute and the value the attribute value. Look at [source:templates/trunk/sites/example/site/site/glite/config.tpl example] for more information on how to define one queue for each supported VO.
    269321 * `TORQUE_SUBMIT_FILTER` : this variable allow to redefine the script used as a Torque submit filter. A default filter is provided in standard templates.
    270322 * `TORQUE_TMPDIR` : normally defined to refer to the working area created by Torque for each job, on a local filesystem. Define as `null` if you don't want job current directory to be redefined to this directory.
    … …  
    282334
    283335For more details about all of these variables, their format and their default values, look at template defining [source:templates/trunk/grid/glite-3.1/defaults/glite/config.tpl default values] for gLite related variables.
     336
     337''Note: the standard name for a queue is the VO name. With some VO names, this results in a name longer than the maximum allowed by Torque. A workaround is to define a VO alias and use it in your configuration. See section about VO configuration.
    284338
    285339=== MAUI ===
    … …  
    380434 * `arch` : used to define `GlueSEArchitecture` for the SE. This parameter is optional and defaults to `multidisk` that should be appropriate for standard configurations.
    381435
    382 For more details, look at [source:templates/trunk/sites/example/site/pro_lcg2_config_site.tpl example] and comments in [source:/templates/trunk/grid/glite-3.0.0/defaults/glite.tpl gLite defaults].
     436For more details, look at [source:templates/trunk/sites/example/site/site/glite/config.tpl example] and comments in [source:/templates/trunk/grid/glite-3.0.0/defaults/glite.tpl gLite defaults].
    383437
    384438''Note : Format of `SE_HOSTS` has been changed in gLite-3.0.2-11 release of QWG templates. Look at [wiki:ReleaseNotes/gLite-3.0#gLite-3.0.2-11:SE_HOSTSformatchange release notes] to know how to migrate from previous format.''
    … …  
    522576WMS and LB site-specific configuration is normally kept in one template, even if they run on several machines, to maintain consistency. Variable `WMS_CONFIG_SITE` must be defined to the name of this template, even for a LB. If you want to use a separate template to configure LB (not recommended), you can also use LB-specific variable, `LB_CONFIG_SITE .
    523577
    524 List of VOs supported by WMS, if not your default list as defined in your [source:templates/trunk/sites/example/site/pro_lcg2_config_site.tpl site-specific parameters], must be defined in another template that will be included very early in the configuration. Variable `NODE_VO_CONFIG` must be defined to the name of this template. This template generally contains only variable `VOS` definition.
     578List of VOs supported by WMS, if not your default list as defined in your [source:templates/trunk/sites/example/site/site/glite/config.tpl site-specific parameters], must be defined in another template that will be included very early in the configuration. Variable `NODE_VO_CONFIG` must be defined to the name of this template. This template generally contains only variable `VOS` definition.
    525579
    526580Main variables available to customize WMS and LB configuration are :
    … …  
    564618=== Configuring BDII URLs on a site BDII ===
    565619
    566 A site BDII aggretates information published by several other BDIIs, typically resource BDIIs or subsite BDIIs. List of resources to aggregate are specicified by variable `BDII_URLS`. This variable is typically defined in site parameters, [source:templates/trunk/sites/example/site/pro_lcg2_config_site.tpl pro_lcg2_config_site.tpl], and is ignored on all nodes except a site (or combined) BDII.
    567 
    568 Variable `BDII_URLS` is nlist of URLs corresponding to the Globus MDS or resource BDII URLs to aggregate on the site BDII. Key is a arbitrary name (like `CE`, `DPM1`...) and value is the URL. See [source:templates/trunk/sites/example/site/pro_lcg2_config_site.tpl site configuration] example.
    569 
    570 For site using an internal hierarchy of site and subsite BDIIs, it is possible to use `BDII_URLS` for subsite BDIIs and `BDII_URLS_SITE` for site BDII. This allow both to coexist in the same site parameter template (typically [source:templates/trunk/sites/example/site/pro_lcg2_config_site.tpl pro_lcg2_config_site.tpl]).
     620A site BDII aggretates information published by several other BDIIs, typically resource BDIIs or subsite BDIIs. List of resources to aggregate are specicified by variable `BDII_URLS`. This variable is typically defined in site parameters, [source:templates/trunk/sites/example/site/site/glite/config.tpl site/glite/config.tpl], and is ignored on all nodes except a site (or combined) BDII.
     621
     622Variable `BDII_URLS` is nlist of URLs corresponding to the Globus MDS or resource BDII URLs to aggregate on the site BDII. Key is a arbitrary name (like `CE`, `DPM1`...) and value is the URL. See [source:templates/trunk/sites/example/site/site/glite/config.tpl site configuration] example.
     623
     624For site using an internal hierarchy of site and subsite BDIIs, it is possible to use `BDII_URLS` for subsite BDIIs and `BDII_URLS_SITE` for site BDII. This allow both to coexist in the same site parameter template (typically [source:templates/trunk/sites/example/site/site/glite/config.tpl site/glite/config.tpl]).
    571625
    572626`BDII_URLS` can contain an entry for a ''combined BDII''. When configuring BDII on this server, this entry will be transparently removed. This allows to move site BDII server to another machine already running a resource BDII without editing `BDII_URLS`.
    … …  
    590644== MPI Support ==
    591645
    592 To activate MPI support on the CE and WNs, you need to define variable `ENABLE_MPI` to `true` in your site parameters (normally `pro_lcg2_config_site.tpl`). It is disabled by default.
     646To activate MPI support on the CE and WNs, you need to define variable `ENABLE_MPI` to `true` in your site parameters (normally `site/glite/config.tpl`). It is disabled by default.
    593647
    594648A default set of RPMs for various flavours of MPI (MPICH, MPICH2, OPENMPI, LAM) will be installed. If you would like to install a custom version of a particular MPI implementation, you can do so by defining the following variables: