Changes between Version 140 and Version 141 of Doc/gLite/TemplateCustomization


Ignore:
Timestamp:
Dec 20, 2009, 12:39:22 AM (16 years ago)
Author:
/O=GRID-FR/C=FR/O=CNRS/OU=LAL/CN=Michel Jouvin
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Doc/gLite/TemplateCustomization

    v140 v141  
    104104''Note: VO alias names are alternative names for VOs locally defined. Unlike, VO names which are guaranteed to be unique, VO aliases may clash with another alias or full name. They must be used mainly to maintain backward compatibility in existing configurations where a name other than the VO full name was used. The use of VO alias is '''strongly''' discouraged for a new configuration or new VOs added to an existing configuration.''
    105105 
     106For some specific purposes, it is possible to execute a site-specific template just before starting the VO configuration, after the site paramaters have been read and the OS configuration has been done. Use variable `NODE_VO_CONFIG` to specify the name of the template.
     107
    106108
    107109=== VO accounts ===
    … …  
    129131
    130132
    131 === Site Specific Defaults for VO Parameters ===
    132 
    133 It is possible to define site specific defaults for VOs that override standard default. This must be done by defining variable `VOS_SITE_PARAMS` as a nlist. This nlist can contain one entry per VO plus an entry `DEFAULT`. Entry `DEFAULT` is used to define paramaters that will apply to all VOs, other entries apply only to one specific VO. The entry key is the VO name (except for `DEFAULT`), as used in `VOS` variable.
     133=== Site Specific Defaults for VO Parameters === #VODefaultParams
     134
     135It is possible to define site specific defaults for VOs that override standard default. This must be done by defining entry `DEFAULT` in  nlist variable `VOS_SITE_PARAMS`. This entry is used to define paramaters that will apply to all VOs if they are not defined explicitly in VO parameters.
    134136
    135137Each entry value must be the name of a structure template or a nlist defining any of these properties :
    … …  
    138140 * `create_keys` : Create SSH keys for VO accounts. Default defined by variable `CREATE_KEYS` variable.
    139141 * `unlock_accounts` : a regexp defining host names where the VO accounts must be unlocked
    140  * `pool_digits` : define default number of digits to use when creating pool accounts
    141  * `pool_offset` : define offset from VO base uid for the first pool account
    142  * `pool_start` : index of the first pool accounts to create for a VO
    143  * `pool_size` : number of pool accounts to create by default for a VO
     142 * `pool_digits` : default number of digits to use when creating pool accounts
     143 * `pool_offset` : offset from VO base uid for the first pool account (normal users)
     144 * `pool_start` : index of the first account to create for a VO in its allocated VO range
     145 * `pool_size` : number of pool accounts to create by default for a VO (normal users)
     146 * `fqan_pool_size` : number of pool accounts to create for specific FQANs
    144147 * `sw_mgr_role` : description of VO software manager role. Avoid to change default.
    145148 * Location of standard services. See [wiki:Doc/gLite/TemplateCustomization#DefaultServicesforaVO below].
    146149
    147 For example, to define a site specific RB for VO Alice, create a template `vo/site/alice.tpl` in your site directory like :
     150'Note: some properties are invalid in the context of the `DEFAULT` entry, in particular: `account_prefix`, `base_uid`, `gid`, `name`, `voms_servers`, `voms_roles`.''
     151
     152
     153=== Overriding default VO Parameters ===
     154
     155In addition to define [#VODefaultParams default values] for VO parameters, it is possible to override default VO parameters, as specified in templates located in [source:trunk/grid/glite-3.2/vo/params vo/params], with site specific values. This is possible to do it on a per-VO basis or for all VOs configured on a machine. This is done using the same variable (nlist) as for [#VODefaultParams default parameters], `VOS_SITE_PARAMS`. To override default parameters for one specific VO, the key must be the VO name, as used in `VOS` variable. To override default parameters for all configured VOs, use special entry `LOCAL`.
     156
     157''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`.''
     158
     159The allowed properties are the same as for [#VODefaultParams default parameters].
     160
     161'Note: some properties are invalid in the context of the `LOCAL` entry (as with `DEFAULT`), in particular: `account_prefix`, `base_uid`, `gid`, `name`, `voms_servers`, `voms_roles`.''
     162
     163For example, to define a site specific WMS for VO Alice, create a template `vo/site/alice.tpl` in your site directory like :
    148164{{{
    149165structure template vo/site/alice;
    150166
    151 'rb_hosts' = 'myrb.example.org';
    152 }}}
    153 
    154 and add the following entry in `VOS_SITE_PARAMS` in your `site/glite/config.tpl` :
    155 {{{
    156 variable VOS_SITE_PARAMS = nlist ('alice', 'vo/site/alice',
    157                                  );
    158 }}}
    159 
    160 ''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`.''
     167'wms_hosts' = 'wms.example.org';
     168}}}
    161169
    162170Alternativly, you can define these parameters directly into `VOS_SITE_PARAMS` :
    163171{{{
    164 variable VOS_SITE_PARAMS = nlist ('alice', nlist('rbhosts' , 'myrb.example.org',
     172variable VOS_SITE_PARAMS = nlist ('alice', nlist('wms_hosts' , 'wms.example.org',
    165173                                                ),
    166174                                 );
    167175}}}
    168176
    169 In 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.
    170 
    171177=== Site-specific parameters for VOMS role accounts ===
     178
    172179VOs often define roles in VOMS for specific purposes. For example, the ATLAS VO defines the role `production` which can only be used by users allowed to run production jobs. The roles defined for a VO are automatically retrieved by the `update.vo.config` and task. By default, a single account with an arbitrary suffix is automatically generated for each role found. For example, the following is an extract of the accounts generated for roles in the ATLAS VO:
    173180
    … …  
    186193}}}
    187194
    188 A particular site may wish to define its own parameters for a particular VOMS role. You can do this by defining entries in the nlist variable VOMS_ROLE_CONFIG_SITE. In this example, the parameters are set for the role `production` in the ATLAS VO:
     195A particular site may wish to define its own parameters for a particular VOMS role. This can be done with nlist variable VOMS_ROLE_CONFIG_SITE. In this variable the key is a VO name and the value a nlist where the key is the role. The value of this second nlist has the same format as `VOS_SITE_PARAMS`.
     196
     197In this example, the Atlas role `production` is configured to use pool accounts:
    189198{{{
    190199variable
    191200  VOMS_ROLE_CONFIG_SITE =
    192201   nlist("atlas",                            # VO
    193      nlist(escape("production"),             # role FQAN
    194         nlist(  "description","production",  # role params
    195         "fqan", "production",
    196         "name", "production",
    197         "pool_size", 20,
    198         "base_uid", 35800,
    199         "pool_digits", 3,
    200         "pool_start", 1,
    201         "gid", 35080,
    202         "suffix", "prd") ));
     202     nlist(escape("/atlas/Role=production"),             # role FQAN
     203        nlist("pool_size", 20,
     204              "suffix", "prd") ));
    203205}}}
    204206