Context Navigation

TemplateCustomization

Timestamp:: Nov 26, 2008, 11:19:24 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

-              v109
+              v110
 Site customization to QWG templates is done through a small set of templates used to define variables used as input by QWG templates. This doesn't cover OS basic configuration that is described in the page about [wiki:Doc/TemplateCustom template framework].
 All 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 parameter 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'''.
+All site parameters related to QWG middleware are supposed to be declared in one template `site/glite/config.tpl` (or any other site-specific templates it may include). To start a new site, import the site parameter 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'''.
 ''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.''
 …
 ''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.''
-== gLite Site Parameters ==
-gLite 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.
-In 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.
-This 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.
 == Machine types ==
 …
  * `SITE_LAT`: site latitude (number)
  * `SITE_LONG`: site longitude (number)
  * `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.
+ * `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. In addition, for WLCG sites, it must define the WLCG role (tier) and the attached T1. See example of [source:templates/trunk/sites/example/site/glite/config.tpl site parameters] for more details.
  * `SITE_EMAIL` : sysadmins contact for the site
  * `SITE_SECURITY_EMAIL` : site email contact for security issues. Default to `SITE_EMAIL`.
 …
 ''Note : `dteam` and `ops` are mandatory VOs.''
+For each VO listed in `VOS`, there must be a template defining the VO parameters in `vo/params`. The template name must be the same as the VO name used in `VOS`. If the VO to be added has no template to define its parameters, refer to next section about adding a new VO.
+An alternative to listing explicitly all the VOs supported on a node, it is possible to define variable `VOS` as the string `ALL` (instead of a list). In this case, all the VOs with parameters available in the configuration (normally all the VOs registered on [http://www.gridops.org CIC portal]) are configured. This specific value should normally be restricted to UIs where there is no VO accounts created. It's main usage is to let user on a UI act as a member of any VO they may be registered in. On a gsissh-enabled UI, it is advisable to restrict the VOs allowed to connect to the UI with `gsissh` to a limited number of VOs when `VOS='ALL'`. See section on UI configuration for more details.
+For each VO listed in `VOS`, there must be a template defining the VO parameters in `vo/params` or an entry in `vo/site/aliases`. The template name in `vo/params` must be the VO full name even though a VO alias name is used in `VOS`. If the VO to be added has no template to define its parameters, refer to next section about adding a new VO.
+''Note: VO alias names are alternative names for VOs locally defined. Unlike, VO names which are guaranteed to be unique, VO aliases may collapse with another alias or full name. They must be used mainly to maintain backward compatibility in existing configuration where a name other than the VO full name was used. The use of VO alias is '''strongly''' discouraged for new configuration or new VO added to an existing configuration.''
 === VO accounts ===
 …
 Most of the variables related to the CE configuration are in fact used to configure the underlying LRMS. The following variables are independent of the LRMS used:
+ * `CE_HOST` : CE host name
+ * `CE_PRIV_HOST` : alternate name of CE host. Used in configuration where WNs are in a private network and CE has 2 network names/adresses.
+ * `CE_HOST`: CE host name
+ * `CE_PRIV_HOST`: alternate name of CE host. Used in configuration where WNs are in a private network and CE has 2 network names/adresses.
+=== Home Directories of VO Accounts ===
+QWG templates support both shared and non shared home directories for VO accounts. See section on NFS Server for more information on how to configure shared home directories. Shared home directories are the recommended configuration and are required to support MPI.
+Independently of the shared/non shared configuration, the following variable is used to configure home directories for VO accounts:
+ * `VO_HOMES`: a nlist defining parent of home directories for all the VO accounts. For each entry, the key is the VO name as defined in variable `VOS` (it may be a VO alias name) and the value is the parent directory for the corresponding accounts (pool accounts and other accounts associated with roles). A special entry, `DEFAULT` may be used to define home directory parent for all the VOs without an explicit entry.
+Wen supporting multiple VOs, the number of accounts can be very large (several thousands). This may lead to performance problems if they all share a common parent. In the value defining the parent directory, it is possible to use the following keywords to create a per-VO parent under a common root (in a common file system):
+ * `@VONAME@` : will be expanded to the VO full name
+ * `@VOALIAS@` : will be expanded to the VO alias name locally defined. When possible, it is better to use the VO full name which is unique and will not change.
+For example, the following variable create one directory per VO under `/home` and accounts for each VOs will be created in the VO-specific directory:
+{{{
+variable VO_HOMES ?= nlist(
+  'DEFAULT',       '/home/@VONAME@',
+);
+}}}
 === Defining Queues ===
 …
 ''TODO'': make this configurable as a variable (e.g. CE_BANNED_USERS)
+== WN Configuration ==
+__Base template__ :
+ * DPM : `machine-types/wn`.
+WN configuration is derived from CE and batch system configuration. To configure your WN for specific local requirements, use variable `WN_CONFIG_SITE`` which must be a template with all the specific actions required on your local nodes.
 == SE Configuration ==