You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/deployment/environment.adoc
+17-20
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,9 @@
2
2
3
3
== Database
4
4
5
-
Model Catalogue is currently tested and deployed against *MySQL* database server with InnoDB
5
+
The Model Catalogue is currently tested and deployed against a *MySQL* database server, which uses InnoDB
6
6
storage engine. The application was tested with versions `5.6.x` and `5.7.x`. The database
7
-
schema is created automatically yet if the database is created automatically following
8
-
indexes are not present but highly recommended:
7
+
schema is created automatically by Grails. It is highly recommended to add the following indexes (for some reason):
9
8
10
9
[source,SQL]
11
10
----
@@ -14,45 +13,43 @@ CREATE INDEX change_idx_2 ON `change` (parent_id, system, other_side, changed_id
14
13
CREATE INDEX change_idx_3 ON `change` (author_id, other_side, system, date_created);
15
14
----
16
15
17
-
The expected load are lower tens of users so the CPU and memory can be rather small (`db.t2.micro` or `db.t2.micro`
18
-
equivalent). Average database can take consume about 2 GB of disk space.
16
+
The expected load is in the tens of users so the CPU and memory can be rather small (`db.t2.micro` or `db.t2.micro`
17
+
equivalent). An average database can consume about 2 GB of disk space.
19
18
20
19
Daily backups are expected to enabled for the database.
21
20
22
21
== Search
23
22
24
-
Model Catalogue uses *Elasticsearch* server as a search engine. Currently the version `2.3.5` is in use and
25
-
should be compatible to any newer release in `2.3.x` but not with the newer ones. The version
26
-
of the server should correspond the drivers used by the application. The best way to achieve this is to use
23
+
The Model Catalogue uses *Elasticsearch* server as a search engine. Currently version `2.3.5` is in use and
24
+
the Catalogue should be compatible with any `2.3.x` release but there is no guarantee for later releases e.g. `2.4.x`. The version of the Elastic Search server should correspond to the drivers used by the Catalogue application. The best way to achieve this is to use the
27
25
https://hub.docker.com/r/metadata/registry-elasticsearch/[metadata/registry-elasticsearch] Docker image which is
28
26
guaranteed to be synchronized with the main application image https://hub.docker.com/r/metadata/registry/[metadata/registry]
29
27
and expected Elasticsearch settings.
30
28
31
-
The search indicies can be rebuild from the database yet the docker container should be run with `-v /path/to/es/backup:/usr/share/elasticsearch/data`
32
-
to retain the indicies between the potential container restarts and upgrades.
29
+
The search indices can be rebuilt from the database, but to retain indices between container restarts and upgrades, docker container should be run with `-v [backup-path]:/usr/share/elasticsearch/data`
33
30
34
-
When the main application is not running on the same docker engine then the port `9300` needs to be published with `-p 9300:9300`.
31
+
If the main Catalogue application and the Elastic Search server are not running on the same Docker engine,, then the port `9300` needs to be published with `-p 9300:9300`.
35
32
36
-
To achieve the best performance 4 GB of system memory is recommended. You can achieve this by running the container with
37
-
`--memory="4g" -e ES_HEAP_SIZE=2g` parameters.
33
+
To achieve the best performance 4 GB of system memory is recommended. You can achieve this by running the container with the parameters
34
+
`--memory="4g" -e ES_HEAP_SIZE=2g`.
38
35
39
36
See https://www.elastic.co/blog/how-to-make-a-dockerfile-for-elasticsearch[How to Make a Dockerfile for Elasticsearch] for
40
37
further information.
41
38
42
-
Here's the summary of recommended `docker run` parameters (the port setting is omited as running within the same engine is recommended):
39
+
Here's the summary of recommended `docker run` parameters (the port setting is omitted as running within the same engine is recommended):
Model Catalogue is Java web application running on Tomcat 8 and JDK 8. It is distributed as Docker image https://hub.docker.com/r/metadata/registry/[metadata/registry]
47
+
The Model Catalogue is a Java web application running on Tomcat 8 and JDK 8. It is distributed as Docker image https://hub.docker.com/r/metadata/registry/[metadata/registry]
51
48
which contains the application deployed as ROOT application and the link:production.adoc[Model Catalogue configuration file]
52
-
enabled to get important configuration from the environmental variables. You can find reference of all the environmental variables at the end of this section.
49
+
enabled to get important configuration from the environmental variables. You can find reference for all the environmental variables at the end of this section.
53
50
54
-
The average memory consumption of the application is under 2 GB but some of the processes such as search reindexing or
55
-
some of the reports may require more memory to run. Because of this the recommended memory setting for production environment is 8 GB.
51
+
The average memory consumption of the application is under 2 GB, but some of the processes such as search reindexing or
52
+
producing some of the reports may require more memory to run. Because of this the recommended memory setting for production environment is 8 GB.
56
53
57
54
CPU consumption is usually low.
58
55
@@ -63,8 +60,8 @@ Mail server configuration is needed to enable user self-registration and sending
63
60
64
61
Users can log in with their Google accounts if Google API key and secret is set.
65
62
66
-
As the number of environmental variable is high the best way how to supply it to the docker command is with environment file `--env-file mc.env`. The file
67
-
contains variable declaration in `ENV_VAR=value` format on each line.
63
+
As the number of environmental variables is high the best way to supply it to the docker command is with an environment file: `--env-file mc.env`. The file
64
+
should contain variable declarations in the format `ENV_VAR=value` on each line.
68
65
69
66
For most secure communication with the Elasticsearch server run the Elasticsearch container within the same docker engine and link it with `--link mc-es:mc-es`.
0 commit comments