From cacc5b4d6df9ab0998975c8927eee27a04dd7842 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jan=20Posp=C3=AD=C5=A1il?= Date: Fri, 25 Jul 2008 13:07:40 +0000 Subject: [PATCH] updated the list of environment variables --- org.glite.lb.doc/src/LBUG-Appendix.tex | 62 ++++++++++++++++++++++++++++++++++ org.glite.lb.doc/src/LBUG-Tools.tex | 23 ++++++++----- 2 files changed, 76 insertions(+), 9 deletions(-) diff --git a/org.glite.lb.doc/src/LBUG-Appendix.tex b/org.glite.lb.doc/src/LBUG-Appendix.tex index f8c999a..979fc08 100644 --- a/org.glite.lb.doc/src/LBUG-Appendix.tex +++ b/org.glite.lb.doc/src/LBUG-Appendix.tex @@ -18,3 +18,65 @@ Complete list of all job' states together with their description follows. \includegraphics[width=.6\hsize]{images/wms2-jobstat} \caption{\LB\ job state diagram} \end{figure} + +\newpage +\section{Environment variables} +\label{a:environment} +\TODO{ruda: projit} + +Complete list of all environment variables affecting LB behaviour follows with +their description and default values (if applicable). + +% default values can be read especially from org.glite.lb.common/src/param.c +% and apropriate header files + +\begin{tabularx}{\textwidth}{lX} +GLITE\_WMS\_LOG\_DESTINATION & + % see also glite/lb/log_proto.h (org.glite.lb.common/interface/log_proto.h) + address of \verb'glite-lb-logd' daemon (for logging events), + in form \verb'hostname:port', + default value is \verb'localhost:9002' \\ +GLITE\_WMS\_LOG\_TIMEOUT & + % see also glite/lb/timeouts.h (org.glite.lb.common/interface/timeouts.h) + timeout (in seconds) for asynchronous logging, + default value is \verb'120' seconds, + maximum value is \verb'300' seconds \\ +GLITE\_WMS\_LOG\_SYNC\_TIMEOUT & + % see also glite/lb/timeouts.h (org.glite.lb.common/interface/timeouts.h) + timeout (in seconds) for synchronous logging, + default value is \verb'120' seconds, + maximum value is \verb'600' seconds \\ +GLITE\_WMS\_NOTIF\_SERVER & + address of \verb'glite-lb-bkserver' daemon (for receiving notifications) + in form \verb'hostname:port', for receiving notifications, + there is no default value \\ +GLITE\_WMS\_NOTIF\_TIMEOUT & + % see also glite/lb/timeouts.h (org.glite.lb.common/interface/timeouts.h) + timeout (in seconds) for notification registration, + default value is \verb'120' seconds, + maximum value is \verb'1800' seconds \\ +GLITE\_WMS\_QUERY\_SERVER & + address of \verb'glite-lb-bkserver' daemon (for queries), + in form \verb'hostname:port', + there is no default value \\ +GLITE\_WMS\_QUERY\_TIMEOUT & + % see also glite/lb/timeouts.h (org.glite.lb.common/interface/timeouts.h) + timeout (in seconds) for queries, + default value is \verb'120' seconds, + maximum value is \verb'1800' seconds \\ +GLITE\_WMS\_LBPROXY\_STORE\_SOCK & + UNIX socket location for logging to LB Proxy, + default value is \verb'/tmp/lb_proxy_store.sock' \\ +GLITE\_WMS\_LBPROXY\_SERVE\_SOCK & + UNIX socket location for queries to LB Proxy, + default value is \verb'/tmp/lb_proxy_serve.sock' \\ +GLITE\_WMS\_LBPROXY\_USER & + user credentials (DN) when communicating with LB Proxy, + there is no default value \\ +X509\_USER\_CERT and X509\_USER\_KEY & + location of user credentials, + default values are \verb'~/.globus/usercert.pem' and \verb'~/.globus/userkey.pem' \\ +\end{tabularx} + +For backward compatibility, all \verb'GLITE_WMS_*' variables can be prefixed by +\verb'EDG_WL_' instead, for example \verb'EDG_WL_LOG_DESTINATION'. diff --git a/org.glite.lb.doc/src/LBUG-Tools.tex b/org.glite.lb.doc/src/LBUG-Tools.tex index 1906524..5d23e38 100644 --- a/org.glite.lb.doc/src/LBUG-Tools.tex +++ b/org.glite.lb.doc/src/LBUG-Tools.tex @@ -3,28 +3,33 @@ In this section we give a description of the CLI tools that a regular grid user might want to use. If not stated otherwise, the tools are distributed in the -\verb'glite-lb-client' RPM. Behaviour of the commands can be changed by -setting some of the following enviroment variables: +\verb'glite-lb-client' package. +\subsection{Environment variables} \TODO{ruda: tady kapitolku, ze prostredi je dulezite, odkaz na appendix, kde bude vsechno. common/src/param.c} +Behaviour of the commands can be changed by setting some of the following +enviroment variables: + \begin{tabularx}{\textwidth}{lX} -GLITE\_WMS\_LOG\_DESTINATION & address of \verb'glite-lb-logd' daemon, in form \verb'hostname:port', for logging events\\ +GLITE\_WMS\_LOG\_DESTINATION & address of \verb'glite-lb-logd' daemon (for logging events)\\ GLITE\_WMS\_LOG\_TIMEOUT & timeout (in seconds) for asynchronous logging\\ GLITE\_WMS\_LOG\_SYNC\_TIMEOUT & timeout (in seconds) for synchronous logging\\ -GLITE\_WMS\_NOTIF\_SERVER& address of \verb'glite-lb-bkserver' daemon, in form \verb'hostname:port', for receiving notifications\\ +GLITE\_WMS\_NOTIF\_SERVER& address of \verb'glite-lb-bkserver' daemon (for receiving notifications)\\ GLITE\_WMS\_NOTIF\_TIMEOUT& timeout (in seconds) for notification registration\\ -GLITE\_WMS\_QUERY\_SERVER& address of \verb'glite-lb-bkserver' daemon, in form \verb'hostname:port', for queries\\ +GLITE\_WMS\_QUERY\_SERVER& address of \verb'glite-lb-bkserver' daemon (for queries)\\ X509\_USER\_CERT and X509\_USER\_KEY & location of user credentials\\ \end{tabularx} -For backward compatibility, all \verb'GLITE_WMS_*' variables can be prefixed by -\verb'EDG_WL_' instead. Setting the environment variable is for some commands mandatory, -so reading the documentaion below and appropriate manpages is highly recommended. + +For a complete list of environment variables, their form and default value +description, see Appendix~\ref{a:environment}. Setting the environment variable +is for some commands mandatory, so reading the documentaion below and +appropriate manpages is highly recommended. \subsection{glite-wms-job-status and glite-wms-job-logging-info} -We start with tools that are distributed in \verb'glite-wms-ui-cli-python' RPM +We start with tools that are distributed in \verb'glite-wms-ui-cli-python' package and that can be found probably on all UI machines. Description of all user commands that are used during the job submission process (generating proxy, creating a JDL describing the job, submitting a job, retrieving output, -- 1.8.2.3