safety-screen/Nominatim
1
0
Fork 0
forked from hans/Nominatim
Code Pull Requests Activity

Merge pull request #1578 from lonvia/docs-installation-support

Browse Source 
Update installation documentation wrt memory usage
This commit is contained in:
Sarah Hoffmann
2019-11-26 22:21:45 +01:00
committed by GitHub
parent d9fe25ac2e 0bd006eef8
commit c36896c524
5 changed files with 74 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@@ -16,7 +16,7 @@ Please make sure to add the following information:
* the expected result, preferably a link to the OSM object you want to find, * the expected result, preferably a link to the OSM object you want to find,
otherwise an address that is as precise as possible otherwise an address that is as precise as possible
To get the link to the OSM object, you can try the following: To get the link to the OSM object, you can try the following:
* go to https://openstreetmap.org * go to https://openstreetmap.org
* zoom to the area of the map where you expect the result and * zoom to the area of the map where you expect the result and
@@ -26,7 +26,7 @@ Please make sure to add the following information:
* find the object of interest in the list that appears on the left side * find the object of interest in the list that appears on the left side
* click on the object and report the URL back that the browser shows * click on the object and report the URL back that the browser shows
### When Reporting Problems with your Installation... ### When Reporting Bugs...
Please add the following information to your issue: Please add the following information to your issue:
@@ -38,6 +38,9 @@ Please add the following information to your issue:
if you run from the git repo, the output of `git rev-parse HEAD`) if you run from the git repo, the output of `git rev-parse HEAD`)
* (if applicable) exact command line of the command that was causing the issue * (if applicable) exact command line of the command that was causing the issue
Bug reports that do not include extensive information about your system,
about the problem and about what you have been trying to debug the problem
will be closed.
## Workflow for Pull Requests ## Workflow for Pull Requests

8
README.md
View File

@@ -19,6 +19,14 @@ https://nominatim.org/release-docs/develop/ .
Installation Installation
============ ============
**Nominatim is a complex piece of software and runs in a complex environment.
Installing and running Nominatim is something for experienced system
administrators only who can do some trouble-shooting themselves. We are sorry,
but we can not provide installation support. We are all doing this in our free
time and there is just so much of that time to go around. Do not open issues in
our bug tracker if you need help. You can ask questions on the mailing list
(see below) or on [help.openstreetmap.org](https://help.openstreetmap.org/).**
The latest stable release can be downloaded from https://nominatim.org. The latest stable release can be downloaded from https://nominatim.org.
There you can also find [installation instructions for the release](https://nominatim.org/release-docs/latest/admin/Installation). There you can also find [installation instructions for the release](https://nominatim.org/release-docs/latest/admin/Installation).

55
docs/admin/Import-and-Update.md
View File

@@ -29,7 +29,7 @@ Add to your `settings/local.php`:
@define('CONST_Osm2pgsql_Flatnode_File', '/path/to/flatnode.file'); @define('CONST_Osm2pgsql_Flatnode_File', '/path/to/flatnode.file');
Replace the second part with a suitable path on your system and make sure Replace the second part with a suitable path on your system and make sure
the directory exists. There should be at least 40GB of free space. the directory exists. There should be at least 64GB of free space.
## Downloading additional data ## Downloading additional data
@@ -62,7 +62,7 @@ involve a GB or US postcode. This data can be optionally downloaded:
In its default setup Nominatim is configured to import the full OSM data In its default setup Nominatim is configured to import the full OSM data
set for the entire planet. Such a setup requires a powerful machine with set for the entire planet. Such a setup requires a powerful machine with
at least 32GB of RAM and around 800GB of SSD hard disks. Depending on your at least 64GB of RAM and around 800GB of SSD hard disks. Depending on your
use case there are various ways to reduce the amount of data imported. This use case there are various ways to reduce the amount of data imported. This
section discusses these methods. They can also be combined. section discusses these methods. They can also be combined.
@@ -124,7 +124,7 @@ The style can be changed with the configuration `CONST_Import_Style`.
To give you an idea of the impact of using the different styles, the table To give you an idea of the impact of using the different styles, the table
below gives rough estimates of the final database size after import of a below gives rough estimates of the final database size after import of a
2018 planet and after using the `--drop` option. It also shows the time 2018 planet and after using the `--drop` option. It also shows the time
needed for the import on a machine with 32GB RAM, 4 CPUS and SSDs. Note that needed for the import on a machine with 64GB RAM, 4 CPUS and SSDs. Note that
the given sizes are just an estimate meant for comparison of style requirements. the given sizes are just an estimate meant for comparison of style requirements.
Your planet import is likely to be larger as the OSM data grows with time. Your planet import is likely to be larger as the OSM data grows with time.
@@ -135,7 +135,7 @@ street | 42h | 400 GB | 180 GB
address | 59h | 500 GB | 260 GB address | 59h | 500 GB | 260 GB
full | 80h | 575 GB | 300 GB full | 80h | 575 GB | 300 GB
You can also customize the styles further. For an description of the You can also customize the styles further. For a description of the
style format see [the development section](../develop/Import.md). style format see [the development section](../develop/Import.md).
## Initial import of the data ## Initial import of the data
@@ -147,18 +147,44 @@ Download the data to import and load the data with the following command
from the build directory: from the build directory:
```sh ```sh
./utils/setup.php --osm-file <data file> --all [--osm2pgsql-cache 28000] 2>&1 | tee setup.log ./utils/setup.php --osm-file <data file> --all 2>&1 | tee setup.log
``` ```
The `--osm2pgsql-cache` parameter is optional but strongly recommended for ***Note for full planet imports:*** Even on a perfectly configured machine
planet imports. It sets the node cache size for the osm2pgsql import part the import of a full planet takes at least 2 days. Once you see messages
(see `-C` parameter in osm2pgsql help). As a rule of thumb, this should be with `Rank .. ETA` appear, the indexing process has started. This part takes
about the same size as the file you are importing but never more than the most time. There are 30 ranks to process. Rank 26 and 30 are the most complex.
2/3 of RAM available. If your machine starts swapping reduce the size. They take each about a third of the total import time. If you have not reached
rank 26 after two days of import, it is worth revisiting your system
configuration as it may not be optimal for the import.
Computing word frequency for search terms can improve the performance of ### Notes on memory usage
forward geocoding in particular under high load as it helps PostgreSQL's query
planner to make the right decisions. To recompute word counts run: In the first step of the import Nominatim uses osm2pgsql to load the OSM data
into the PostgreSQL database. This step is very demanding in terms of RAM usage.
osm2pgsql and PostgreSQL are running in parallel at this point. PostgreSQL
blocks at least the part of RAM that has been configured with the
`shared_buffers` parameter during [PostgreSQL tuning](Installation#PostgreSQL_tuning)
and needs some memory on top of that. osm2pgsql needs at least 2GB of RAM for
its internal data structures, potentially more when it has to process very large
relations. In addition it needs to maintain a cache for node locations. The size
of this cache can be configured with the parameter `--osm2pgsql-cache`.
When importing with a flatnode file, it is best to disable the node cache
completely and leave the memory for the flatnode file. Nominatim will do this
by default, so you do not need to configure anything in this case.
For imports without a flatnode file, set `--osm2pgsql-cache` approximately to
the size of the OSM pbf file (in MB) you are importing. Make sure you leave
enough RAM for PostgreSQL and osm2pgsql as mentioned above. If the system starts
swapping or you are getting out-of-memory errors, reduce the cache size or
even consider using a flatnode file.
## Tuning the database
Accurate word frequency information for search terms helps PostgreSQL's query
planner to make the right decisions. Recomputing them can improve the performance
of forward geocoding in particular under high load. To recompute word counts run:
```sh ```sh
./utils/update.php --recompute-word-counts ./utils/update.php --recompute-word-counts
@@ -176,7 +202,8 @@ you also need to enable these key phrases like this:
./utils/specialphrases.php --wiki-import > specialphrases.sql ./utils/specialphrases.php --wiki-import > specialphrases.sql
psql -d nominatim -f specialphrases.sql psql -d nominatim -f specialphrases.sql
Note that this command downloads the phrases from the wiki link above. Note that this command downloads the phrases from the wiki link above. You
need internet access for the step.
## Installing Tiger housenumber data for the US ## Installing Tiger housenumber data for the US

24
docs/admin/Installation.md
View File

@@ -55,15 +55,15 @@ For running continuous updates:
### Hardware ### Hardware
A minimum of 2GB of RAM is required or installation will fail. For a full A minimum of 2GB of RAM is required or installation will fail. For a full
planet import 32GB of RAM or more are strongly recommended. planet import 64GB of RAM or more are strongly recommended. Do not report
out of memory problems if you have less than 64GB RAM.
For a full planet install you will need at least 700GB of hard disk space For a full planet install you will need at least 800GB of hard disk space
(take into account that the OSM database is growing fast). SSD disks (take into account that the OSM database is growing fast). SSD disks
will help considerably to speed up import and queries. will help considerably to speed up import and queries.
On a 6-core machine with 32GB RAM and SSDs the import of a full planet takes Even on a well configured machine the import of a full planet takes
a bit more than 2 days. Without SSDs 7-8 days are more realistic. at least 2 days. Without SSDs 7-8 days are more realistic.
## Setup of the server ## Setup of the server
@@ -73,17 +73,21 @@ You might want to tune your PostgreSQL installation so that the later steps
make best use of your hardware. You should tune the following parameters in make best use of your hardware. You should tune the following parameters in
your `postgresql.conf` file. your `postgresql.conf` file.
shared_buffers (2GB) shared_buffers = 2GB
maintenance_work_mem (10GB) maintenance_work_mem = (10GB)
work_mem (50MB) autovacuum_work_mem = 2GB
effective_cache_size (24GB) work_mem = (50MB)
effective_cache_size = (24GB)
synchronous_commit = off synchronous_commit = off
checkpoint_segments = 100 # only for postgresql <= 9.4 checkpoint_segments = 100 # only for postgresql <= 9.4
max_wal_size = 1GB # postgresql > 9.4
checkpoint_timeout = 10min checkpoint_timeout = 10min
checkpoint_completion_target = 0.9 checkpoint_completion_target = 0.9
The numbers in brackets behind some parameters seem to work fine for The numbers in brackets behind some parameters seem to work fine for
32GB RAM machine. Adjust to your setup. 64GB RAM machine. Adjust to your setup. A higher number for `max_wal_size`
means that PostgreSQL needs to run checkpoints less often but it does require
the additional space on your disk.
For the initial import, you should also set: For the initial import, you should also set:

5
lib/setup/SetupClass.php
View File

@@ -29,10 +29,13 @@ class SetupFunctions
warn('resetting threads to '.$this->iInstances); warn('resetting threads to '.$this->iInstances);
} }
// Assume we can steal all the cache memory in the box (unless told otherwise)
if (isset($aCMDResult['osm2pgsql-cache'])) { if (isset($aCMDResult['osm2pgsql-cache'])) {
$this->iCacheMemory = $aCMDResult['osm2pgsql-cache']; $this->iCacheMemory = $aCMDResult['osm2pgsql-cache'];
} elseif (!is_null(CONST_Osm2pgsql_Flatnode_File)) {
// When flatnode files are enabled then disable cache per default.
$this->iCacheMemory = 0;
} else { } else {
// Otherwise: Assume we can steal all the cache memory in the box.
$this->iCacheMemory = getCacheMemoryMB(); $this->iCacheMemory = getCacheMemoryMB();
} }