Mercurial > dive4elements > gnv-client

annotate doc/config-manual/administering_artifact-server.tex @ 949:11d8cc2deb92 1.0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
merged doc/1.0
author Thomas Arendsen Hein <thomas@intevation.de>
date Fri, 28 Sep 2012 12:13:58 +0200
parents 975bb59bb136
children
rev   line source
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
1 \subsection{Configuring and Running the Artifact-Server}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
2
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
3 This section describes the possibilities to configure the
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
4 artifact-server. The following properties do affect mostly technical
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
5 funtions of the server.
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
6
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
7 This section describes the possibilities in a kind of a reference
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
8 manual. Information for the process of installing and integration can be
948
975bb59bb136 Adapted config-manual according to admin-manual
Hans Plum <hans.plum@intevation.de>
parents: 947
diff changeset
9 found in the Administration Manual of the GNV-System.
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
10 The following elements are covered here:
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
11
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
12 \begin{lstlisting}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
13 artifact-database
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
14 |-- geo-backend # pointing to database connection, SQL configuration
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
15 |-- rest-server # port, listen addresses
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
16 |-- database # internal database storing artifacts
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
17 |-- ehcache # pointing to cache configuration
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
18 |-- cleaner # time of cleanups FIXME
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
19 `-- export-secret # signing project files
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
20 \end{lstlisting}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
21
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
22 \paragraph*{geo-backend}
948
975bb59bb136 Adapted config-manual according to admin-manual
Hans Plum <hans.plum@intevation.de>
parents: 947
diff changeset
23 {\em Function}: The geo-backend encapsulates the logic for accessing the
975bb59bb136 Adapted config-manual according to admin-manual
Hans Plum <hans.plum@intevation.de>
parents: 947
diff changeset
24 database backend. At this time, the use of ESRI ArcSDE 9.3.1 is supported.
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
25
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
26 At least, the following options for configuring the element {\tt
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
27 geo-backend} are required:
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
28
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
29 \begin{itemize}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
30 \item {\tt backend-configuration}: path to the file defining the
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
31 connection properties to the database backend, preconfigured to {\tt
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
32 arcsdeconnection.properties}. Normally, just the
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
33 connection parameters have to de adapted. Further information can be
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
34 found in the file itself.
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
35
948
975bb59bb136 Adapted config-manual according to admin-manual
Hans Plum <hans.plum@intevation.de>
parents: 947
diff changeset
36 \item {\tt query-configuration}: path to the file listing a SQL statements,\\
975bb59bb136 Adapted config-manual according to admin-manual
Hans Plum <hans.plum@intevation.de>
parents: 947
diff changeset
37 preconfigured to \texttt{queries.properties}. Further information can be
975bb59bb136 Adapted config-manual according to admin-manual
Hans Plum <hans.plum@intevation.de>
parents: 947
diff changeset
38 found at chapter~\ref{ref:queries.properties},
975bb59bb136 Adapted config-manual according to admin-manual
Hans Plum <hans.plum@intevation.de>
parents: 947
diff changeset
39 p.~\ref{ref:queries.properties}
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
40 \end{itemize}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
41
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
42
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
43 \paragraph*{rest-server}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
44 {\em Function}: The REST-Server needs a HTTP binding configured via:
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
45
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
46 \begin{itemize}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
47 \item {\tt port}: port the server should listen on. Preconfigured on
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
48 8181.
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
49 \item {\tt listen}: for security reason the accessibility can be
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
50 limited. The parameter needs an IP-address or a hostname.
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
51 Accessibility to the entire network can be done by
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
52 removing/commenting out of the element.
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
53 \end{itemize}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
54
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
55
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
56 \paragraph*{database}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
57 {\em Function}: The internal database of the system for storing
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
58 artifacts representing a parameterisation of a client session. So fare,
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
59 the filebased database H2 is supported. Connecting to other backends can
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
60 be provided.
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
61
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
62 \begin{itemize}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
63 \item {\tt user}: database user for connecting to the
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
64 artifact-database. In new installations "SA" is used.
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
65 \item {\tt password}: password of the database user for
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
66 authentification.
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
67 \item {\tt url}: Connection URL to the database-files.
947
9a28846dfb9c Final QS for V1.0
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
68 In the preconfiguration, they are written to \\
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
69 \verb| ${artifacts.config.dir}/../artifactdb|
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
70 \end{itemize}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
71
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
72
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
73 \paragraph*{ehcache}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
74 {\em Function}: The cache for storing result sets of the database. The
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
75 configuration in {\tt ehcache.xml} should not been adapted. Changing has
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
76 at least consequence to the system requirements.
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
77
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
78 \begin{itemize}
947
9a28846dfb9c Final QS for V1.0
Hans Plum <hans.plum@intevation.de>
parents: 938
diff changeset
79 \item {\tt configuration}: the path to the configuration file. \\
938
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
80 Preconfigured: \verb+${artifacts.config.dir}/ehcache.xml+
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
81 \end{itemize}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
82
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
83
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
84 \paragraph*{cleaner}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
85 {\em Function}: Process for cleaning up the artifact-database. Artifacts
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
86 have a time-to-life. Died artifacts need to be removed. Changing the
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
87 interval has consequences to the size of the database.
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
88
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
89 \begin{itemize}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
90 \item {\tt sleep-time}: Time interval in milliseconds between 2
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
91 checks. Preconfigured: 60000 (1 minute)
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
92 \end{itemize}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
93
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
94
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
95 \paragraph*{export-secret}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
96 {\em Function}: Signature for signing project files that were created by
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
97 the artifact-server instance. Before reading a projectfile the server
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
98 checks the file against that signature/check sum.
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
99
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
100 {\bf Be aware, changing the signature of updating the source code of
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
101 artifacts will prevent of using existing project-files.}
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
102
2d84fc30ab58 Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
103 For setting up the secret, c.f. the tips in the admin manual.
http://dive4elements.wald.intevation.org