Changes between Version 23 and Version 24 of Doc/gLite/TemplateCustomization/Services

Timestamp:

Feb 6, 2013, 11:33:53 AM (11 years ago)

Author:

/O=GRID-FR/C=FR/O=CNRS/OU=LAL/CN=Michel Jouvin

Comment:

--

Doc/gLite/TemplateCustomization/Services

@@ -495 +495 @@
 
 QWG templates allow to configure one or several Xrootd federations in a Xrootd cluster. Configuring a federation involves two steps:
- * Declaring federation default parameters in variable `XROOTD_FEDERATION_PARAMS` variable. This variable is a nlist whose keys are the federation identifiers (arbitrary, internal to the configuration description) and whose values are the federation parameters defined as a nlist. Default templates already contains parameters for Atlas (FAX, QWG identifier `atlas`) and CMS (AAA, QWG identifier `cms`) Xrootd federations.
+ * Declaring federation default parameters in variable `XROOTD_FEDERATION_PARAMS` variable. This variable is a nlist whose keys are the federation identifiers (arbitrary, internal to the configuration description) and whose values are the federation parameters defined as a nlist.
  * Declaring in the Xrootd cluster configuration (or DPM configuration when using DPM/Xrootd) the federations to activate on the cluster. This is done with variable `XROOTD_FEDERATION_LIST` variable which is a list of federation identifier, matching entries in `XROOTD_FEDERATION_PARAMS`, or a string if there is only one fedederation to configure.
  
-Supported configuration parameters that can be configured through `XROOTD_FEDERATION_PARAMS` are:
- * See [source:templates/trunk/grid/emi-2/glite/xrootd/config_federation.tpl config_federation.tpl]
+Configuration parameters that can be customized through `XROOTD_FEDERATION_PARAMS` are:
+ * `fedredir`: host name of the global federation redirector that must be contacted by the local Xrootd cluster. Required, no default.
+ * `cmsd_mgr_port`: cmsd port on federation redirector as specified by `fedredir`. Required, no default.
+ * `xrd_mgr_port`: xrootd port on federation redirector as specified by `fedredir`. Required, no default.
+ * `local_port`:  port used by the local federation redirector. Required, no default.
+ * `instance`: name of the xrootd/cmsd instance on the local host that will be part of the federation. Required, default: federation identifier.
+ * `lfc_host`: name of the LFC server used by name-to-name translation library, if any. Optional, no default.
+ * `n2n_library`: name-to-name (N2N) translation library used by redirector to translate the user path to local storage path. Optional, no default. When not specified, no N2N library will be used.
+ * `n2n_options`: N2N library options, if any. Optional, no default.
+ * `n2n_packages`: packages required by N2N library that need to be installed. This is a list of nlist. Each nlist specifies a package with keys `name`, `version`, `arch` (all keys are required if a package is specified). Optional, no default.
+ * `valid_path_prefix`: user path prefix that are usable (exported, as specified by `all.export` Xrootd configuration directive) through the redirector. Required, default: `/voname/`.
+ * `vo`: VO served by this federation. Required, default: federation identifier.
+
+For an example of federation parameter definition, you may want to look at [source:templates/trunk/grid/emi-2/glite/xrootd/config_federation.tpl config_federation.tpl] (variable `XROOTD_FEDERATION_PARAMS_DEFAULT`, reserved for internal use, but sharing the same format).
+
+''Note: If you use a well-known federation, most of these parameters should be already defined with appropriate defaults. Examples of such federations are Atlas FAX federation (federation identifier `atlas`) and CMS AAA (federation identifier `cms`). For these federations, it should be enough to specify `fedredir` in `XROOTD_FEDERATION_PARAMS` (and optionally `lfc_host` if one is used by N2N translation and the default is not appropriate for your site).''