Mercurial > dive4elements > gnv-client

annotate doc/admin-manual/operating-the-system.tex @ 911:11ebb00c8bf4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added overview of the subject-sepcific configuration and its file structure doc/trunk@1045 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Hans Plum <hans.plum@intevation.de>
date Tue, 04 May 2010 06:51:36 +0000
parents 1ebde13e620f
children fb1e051713cc
rev   line source
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
1 \section{Management of operational processes}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
2
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
3 Availability of the components
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
4 1. Database server
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
5 2. Artefact-server
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
6 3. Apache Tomcat running the WebClient
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
7 4. Apache WebServer
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
8
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
9 During a server startup the installed components get started
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
10 automatically.
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
11
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
12 \subsection{Managing the Artefact Server}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
13
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
14 \subsubsection*{Start Stop Restart}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
15
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
16 The artefact server can be restarted without stopping the WebClient.
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
17 During the restart-process client accessing the server get an approriate
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
18 message. Their session data will not be lost if the artefact database
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
19 will remain untouched.
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
20
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
21 Stopping artefact server
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
22 \verb+ /etc/init.d/artefact-server stop+
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
23
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
24 Starting artefact server
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
25 \verb+ /etc/init.d/artefact-server start+
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
26
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
27 Restarting artefact server
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
28 \verb+ /etc/init.d/artefact-server restart+
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
29
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
30 \subsubsection*{Monitoring the System}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
31
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
32 C.f. Testing the installation for the levels: operating system,
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
33 network and service availability
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
34
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
35 \subsubsection*{Troubleshooting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
36
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
37 Database problems
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
38 For checking problems for problems with the connection to the database
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
39 server, check the logfile of the artefact-server (c.f. FIXME
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
40 installation) look for entries like FIXME.
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
41
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
42 In most cases, a restart of the artefact-server will help to solve
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
43 problems in the artefact-server. If you still encounter problems, check
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
44 for the network connection to the database server and the maturity of
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
45 the database server.
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
46
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
47
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
48 Inconsistencies between original data and cached data
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
49 The artefact-server stores result sets of the database in a cache and
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
50 provides maps via configuration files for MapServer based on shapefiles.
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
51 In case of inconsistencies showing up for longer than twice the
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
52 maximum of the update cycle of internal ETL processes, do the following
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
53 as user \verb+root+:
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
54
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
55 \begin{lstlisting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
56 /etc/init.d/artefact-server stop
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
57 rm -ri \$ARTEFACT-SERVER-HOME/cache/*
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
58 /etc/init.d/artefact-server start
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
59 \end{lstlisting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
60
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
61 \subsection{Managing the GNV-Client}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
62 \subsubsection*{Start Stop Restart}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
63
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
64 The GNV-WebClient can be managed by controlling Apache Tomcat instance:
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
65
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
66 Status GNV-WebClient
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
67 \verb+ /etc/init.d/tomcat5.5 status+
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
68
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
69 Stopping GNV-WebClient
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
70 \verb+ /etc/init.d/tomcat5.5 stop+
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
71
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
72 Starting GNV-WebClient
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
73 \verb+ /etc/init.d/tomcat5.5 start+
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
74
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
75 Restarting GNV-WebClient
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
76 \verb+ /etc/init.d/tomcat5.5 restart+
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
77
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
78 \subsubsection*{Monitoring the System}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
79
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
80 For different possibilities c.f. Testing the installation
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
81
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
82 \subsubsection*{Troubleshooting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
83
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
84 The GNV-WebClient can not accessed through the Apache WebServer, do the
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
85 following:
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
86 1. \verb+ /etc/init.d/apache2 restart+
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
87 2. Check in your browser at \verb+ http://\$SERVERNAME/gnv+
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
88
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
89 If you still encounter problems, follow the next these steps:
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
90 {\bf Caution: The entire application will be down until the WebServer is
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
91 back up}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
92 \begin{lstlisting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
93 /etc/init.d/apache2 stop
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
94 /etc/init.d/tomcat5.5 stop
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
95 rm -r /usr/share/tomcat5.5/work/Catalina/localhost/gnv/*
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
96 /etc/init.d/tomcat5.5 start # wait until tomcat is up
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
97 /etc/init.d/apache2 start
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
98 \end{lstlisting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
99
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
100 For further information, you look into the Logging during the use of the
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
101 GNV WebClient
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
102 \verb+ tail -f -n 50 /usr/share/tomcat5.5/logs/gnv.log+
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
103
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
104 To get even more logging, do the following:
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
105
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
106 {\bf Caution: The entire application will be down until the Apache Tomcat
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
107 has started properly; the higher log-level can affect the
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
108 runtime-behaviour of the client}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
109 \begin{lstlisting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
110 /etc/init.d/tomcat5.5 stop
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
111 Set logging to DEBUG (FIXME)
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
112 vim /usr/share/tomcat5.5/webapps/gnv/WEB-INF/classes/log4j.properties
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
113 /etc/init.d/tomcat5.5 start # wait until tomcat is up
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
114 tail -f -n 50 /usr/share/tomcat5.5/logs/gnv.log
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
115 \end{lstlisting}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
116
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
117 It is recommended to undo the logging configuration, after the relevant
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
118 part has been found.
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
119
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
120 \section{Lists of References}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
121 FIXME
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
122
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
123 FIXME: How to adapt the address/port of connection to REST-server.E
http://dive4elements.wald.intevation.org