From 3ccbafd1acb644963f0af273a5900bdf09df1e72 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Franti=C5=A1ek=20Dvo=C5=99=C3=A1k?= Date: Fri, 24 Feb 2006 17:37:20 +0000 Subject: [PATCH] Man page for JP IS daemon, some little fixes. --- org.glite.jp.index/Makefile | 4 +- org.glite.jp.index/doc/README | 8 +- org.glite.jp.index/doc/glite-jp-indexd.sgml | 279 ++++++++++++++++++++++++++ org.glite.jp.index/doc/glite-jpis-client.sgml | 7 + 4 files changed, 292 insertions(+), 6 deletions(-) create mode 100644 org.glite.jp.index/doc/glite-jp-indexd.sgml diff --git a/org.glite.jp.index/Makefile b/org.glite.jp.index/Makefile index c0324e3..797d03c 100644 --- a/org.glite.jp.index/Makefile +++ b/org.glite.jp.index/Makefile @@ -50,10 +50,10 @@ daemon:=glite-jp-indexd examples:=glite-jpis-test glite-jpis-client test:=run-test.sh test_files:=dump1.sql simple_query.in simple_query.out complex_query.in complex_query.out authz.out -MANS1:=glite-jpis-client.1 +MANS1:=glite-jpis-client.1 glite-jp-indexd.8 MANS8:= MANS:=${MANS1} ${MANS8} -HTMLS:=glite-jpis-client.html +HTMLS:=glite-jpis-client.html glite-jp-indexd.html is_prefix:=jpis_ is_client_prefix:=jpis_client_ ps_prefix:=jpps_ diff --git a/org.glite.jp.index/doc/README b/org.glite.jp.index/doc/README index 6294074..6261664 100644 --- a/org.glite.jp.index/doc/README +++ b/org.glite.jp.index/doc/README @@ -27,7 +27,7 @@ user jpis. JP-IS interactions: -- JP primary storage - feedins data from primary storage to the IS according +- JP primary storage - feedings data from primary storage to the IS according to particular IS instance administrator needs (expressed by IS configuration) - IS user query interface - implements IS service for end users @@ -96,10 +96,10 @@ GLITE_JPIS_PS - location of JP-PS server (_required parameter_) GLITE_JPIS_DEBUG - setting to '-d' forces the daemon not to daemonize GLITE_JPIS_QT - defines query type 'hist' ... history query - 'cont' ... continuaous query - 'both' ... compination of previous types + 'cont' ... continuous query + 'both' ... combination of previous types GLITE_JPIS_AUTH - setting to '-n' forces the daemon not to check - authorization + authorisation GLITE_JPIS_PORT - used port (default 8902) GLITE_JPIS_DB - database connection string (default jpis/@localhost:jpis1) diff --git a/org.glite.jp.index/doc/glite-jp-indexd.sgml b/org.glite.jp.index/doc/glite-jp-indexd.sgml new file mode 100644 index 0000000..3a28aac --- /dev/null +++ b/org.glite.jp.index/doc/glite-jp-indexd.sgml @@ -0,0 +1,279 @@ + + + + + + glite-jp-indexd + 8 + EU EGEE Project + + + + glite-jp-indexd + daemon providing subset of data from Job Provenance + + + + + glite-jp-indexd + + + -h + --help + + + + -s + --ps-server + HOST:PORT + + -d + + + -q + --query-type + + hist + cont + both + + + + -n + --no-auth + + + + -m + --mysql + USER/PASSWORD@HOST:DBNAME + + + -p + --port + PORT + + + -i + --pidfile + FILE.PID + + + -o + --logfile + FILE.LOG + + + + + + DESCRIPTION + +glite-jp-index is stand-alone daemon which is using MySQL database. It provides subset of attributes and jobs from Job Provenance. + + + + + OPTIONS + + +With no options you get simple usage message as with . + + + + + | + +Primary storage server address +(http://HOSTNAME:PORT). + + + + + | + +Don't run as daemon, additional diagnostics. + + + + + | + +Type of query: , or (default: ). + + + + hist + history query + + + cont + continuous query + + + both + combination of previous types + + + + + + + | + +Don't check user identity with result owner. + + + + + | + +Database connect string: USER/PASSWORD@HOST:DBNAME (default: ). + + + + + | + +Port to listen (default: ). + + + + + | + +File to store master pid (default: /var/run/glite-jp-indexd.pid or $HOME/glite-jp-indexd.pid). + + + + + | + +File to store logs (default: /var/run/glite-jp-indexd.log or $HOME/glite-jp-indexd.log). + + + + + +Other parameters will be configurable in close future. Its current hard-coded values are in org.glite.jp.index/src/conf.[ch]. + + + + + Starting the daemon + +Preferred way of starting the daemon is using start-up script (config/startup). It loads glite.conf file (personal version may be stored in ~/.glite.conf) where many variables may be set to configure the daemon. The script takes following variables: + + + + + GLITE_JPIS_PS + +Location of JP-PS server (_required parameter_), for example http://umbar.ics.muni.cz:8901. + + + + + GLITE_JPIS_DEBUG + +Setting to '-d' forces the daemon not to daemonize. + + + + + GLITE_JPIS_QT + +Defines query type (see parameter). + + + + + GLITE_JPIS_AUTH + +Setting to '-n' forces the daemon not to check authorisation. + + + + + GLITE_JPIS_PORT + +Used port (default is 8902). + + + + + GLITE_JPIS_DB + +Database connection string, see parameter. + + + + + GLITE_JPIS_LOGFILE + +Log file (default in startup script is $GLITE_LOCATION_VAR/log/glite-jp-indexd.log). + + + + + GLITE_JPIS_PIDFILE + +Pid file (default is in startup script is $GLITE_LOCATION_VAR/run/glite-jp-indexd.pid). + + + + + + + RETURN VALUE + + + 0 + Success start. + + + + 1 + +Error (database or network initialisation for example). + + + + + + + EXAMPLES + + + configure file for startup script + GLITE_LOCATION_VAR=/opt/glite/var +GLITE_JPIS_DB=jpis/@localhost:jpis1 +GLITE_JPIS_PORT=8902 +GLITE_JPIS_LOGFILE=$GLITE_LOCATION_VAR/run/glite-jp-indexd.log +GLITE_JPIS_PIDFILE=$GLITE_LOCATION_VAR/run/glite-jp-indexd.pid +GLITE_JPIS_DEBUG=0 +GLITE_JPIS_PS=JPPS:8901 +GLITE_JPIS_QT=cont + + + + + glite-jp-indexd -s JPPS:8901 -i $HOME/jpis.log -o $HOME/jpis.pid + +Manual run of the JP index server. Use local MySQL database, communicates with Job Provenance on JPPS:8901, listen on default port, store logs and pid to given files. + + + + + + + SEE ALSO + glite-jpis-client(1) + + + + AUTHOR + EU DataGrid Work Package 1, CESNET group. + + + diff --git a/org.glite.jp.index/doc/glite-jpis-client.sgml b/org.glite.jp.index/doc/glite-jpis-client.sgml index fb6d8ba..0593485 100644 --- a/org.glite.jp.index/doc/glite-jpis-client.sgml +++ b/org.glite.jp.index/doc/glite-jpis-client.sgml @@ -1,9 +1,11 @@ + glite-jpis-client 1 + EU EGEE Project @@ -183,4 +185,9 @@ parameters from stdin and show results in non-XML form. glite-jp-indexd(8) + + AUTHOR + EU DataGrid Work Package 1, CESNET group. + + -- 1.8.2.3