diff --git a/dcapi/doc/Makefile.am b/dcapi/doc/Makefile.am index feb97b2a3a..60941dd85b 100644 --- a/dcapi/doc/Makefile.am +++ b/dcapi/doc/Makefile.am @@ -55,7 +55,7 @@ HTML_IMAGES= # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). # e.g. content_files=running.sgml building.sgml changes-2.0.sgml -content_files= +content_files=intro.xml config.xml # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded # These files must be listed here *and* in content_files diff --git a/dcapi/doc/config.xml b/dcapi/doc/config.xml new file mode 100644 index 0000000000..fcca10f2b3 --- /dev/null +++ b/dcapi/doc/config.xml @@ -0,0 +1,177 @@ + + + + Configuration + + + The DC-API library uses a configuration file to control its operations. The + location of the config file must be specified by the master application when + it calls the DC_initMaster() function. + + Individual work units may also use a config file that has a slightly + different format than the master's config file. Work unit config files + however are usually generated by the DC-API library on the master side so + applications should not be concerned about it. + + + + + Configuration file format + + + The DC-API configuration file contains key-value pairs organized into + groups. The full syntax description can be found in the + Desktop + Entry Specification, but we + also give a brief explanation below. + + + Lines starting with # are considered comments + and are ignored. Groups are started by a line containing the group's name + between brackets ([ and ]). Groups + are terminated by the start of an other group or by the end of the file. + + + A group may contain a list of key = value assignments, + each in a separate line. White space arount the = + character is ignored. Note that the DC-API do not use the localized string + feature of the Desktop Entry Specification. + + + + + Generic configuration items + + + The DC-API configuration file should contain a group called + Master that defines global configuration options. + There may be also groups called Client-CLIENTNAME where + CLIENTNAME is the logical name of a client application + the master wishes to start (the same string that is passed to the + DC_createWU() function). + + + + Configuration values for the master application + + + The following entries can be specified in the Master + group. Grid backends may require and/or allow further items; refer to the + backend-specific documentation. + + + + WorkingDirectory + + + REQUIRED. The working directory of the master application. The value + must be an absolute path. The DC-API sets the master's current + directory to the value specified here when the DC_initMaster() function is called. + + + + + InstanceUUID + + + REQUIRED. The value must be a Universally Unique Identifier. The + value must be unique for every master application running on the + same grid backend. If two master applications are started with the + same InstanceUUID value, their behaviour is + undefined. + + + + + LogLevel + + + OPTIONAL. Specifies the verbosity of log messages generated by the + DC-API or by the master application if it uses the DC_log() or DC_vlog() functions. The allowed values + in the order of increasing priority are Debug, + Info, Notice, + Warning, Error and + Critical, the default being + Notice. + + + + + LogFile + + + OPTIONAL. Specifies the name of the file where log messages should + be written to. If not specified, log messages are sent to the + application's standard output. + + + + + + + Configuration values individual work units + + + + LogLevel + + + OPTIONAL. Specifies the verbosity of log messages generated by the + DC-API or by the client application if it uses the DC_log() or DC_vlog() functions. The allowed values + in the order of increasing priority are Debug, + Info, Notice, + Warning, Error and + Critical, the default being + Notice. + + + + + LogFile + + + OPTIONAL. Specifies the name of the file where log messages should + be written to. If not specified, log messages are sent to the + application's standard output. The value must be a relative file + name without any path components. + + + The default value is specified by the DC-API when it creates the + work unit and generally it should not be overridden. + + + + + SendCfgKeys + + + OPTIONAL. Specifies a ;-separated list of + configuration keys that should be sent to the client application + when a work unit is created. LogLevel and + LogFile are always included so those should not + be listed. + + + The client application may use the DC_getCfgStr(), DC_getCfgInt(), and DC_getCfgBool() functions to + access the values of the keys specified by + SendCfgKeys + + + + + + + + + + diff --git a/dcapi/doc/dc-docs.xml b/dcapi/doc/dc-docs.xml index 8c022010c2..440426367b 100644 --- a/dcapi/doc/dc-docs.xml +++ b/dcapi/doc/dc-docs.xml @@ -7,6 +7,19 @@ DC-API Manual + + General information + + + + + + Backend-specific information + + + + + Reference @@ -14,4 +27,4 @@ - + diff --git a/dcapi/doc/intro.xml b/dcapi/doc/intro.xml new file mode 100644 index 0000000000..47acec89a4 --- /dev/null +++ b/dcapi/doc/intro.xml @@ -0,0 +1,45 @@ + + + + Introduction + + + The DC-API was created by MTA SZTAKI to allow easy implementation and + deployment of distributed applications on multiple grid environments. + + + In order to accomodate the needs of very different grid environments, the + DC-API supports only a restricted master-worker programming model. The + restrictions include: + + + + Master-worker concept: there is a designated + master process running somewhere on the grid + infrastructure. The master process can submit worker processes called + work units. + + + + + Every work unit is a sequential application. + + + + + There is support for limited messaging between the master and the + running work units. It can be used to send status and control + messages, but it is not suitable for parallel programming. + + + + + There can not be any direct communication between work units. + + + + + + +