/usr/share/doc/mapproxy/html/_sources/seed.txt is in mapproxy-doc 1.9.0-3+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 | Seeding
=======
The MapProxy creates all tiles on demand. To improve the performance for commonly
requested views it is possible to pre-generate these tiles. The ``mapproxy-seed`` script does this task.
The tool can seed one or more polygon or BBOX areas for each cached layer.
MapProxy does not seed the tile pyramid level by level, but traverses the tile pyramid depth-first, from bottom to top. This is optimized to work `with` the caches of your operating system and geospatial database, and not against.
mapproxy-seed
-------------
The command line script expects a seed configuration that describes which tiles from which layer should be generated. See `configuration`_ for the format of the file.
Options
~~~~~~~
.. option:: -s <seed.yaml>, --seed-conf==<seed.yaml>
The seed configuration. You can also pass the configuration as the last argument to ``mapproxy-seed``
.. option:: -f <mapproxy.yaml>, --proxy-conf=<mapproxy.yaml>
The MapProxy configuration to use. This file should describe all caches and grids that the seed configuration references.
.. option:: -c N, --concurrency N
The number of concurrent seed worker. Some parts of the seed tool are CPU intensive
(image splitting and encoding), use this option to distribute that load across multiple
CPUs. To limit the concurrent requests to the source WMS see
:ref:`wms_source_concurrent_requests_label`
.. option:: -n, --dry-run
This will simulate the seed/cleanup process without requesting, creating or removing any tiles.
.. option:: --summary
Print a summary of all seeding and cleanup tasks and exit.
.. option:: -i, --interactive
Print a summary of each seeding and cleanup task and ask if ``mapproxy-seed`` should seed/cleanup that task. It will query for each task before it starts.
.. option:: --seed=<task1,task2,..>
Only seed the named seeding tasks. You can select multiple tasks with a list of comma seperated names, or you can use the ``--seed`` option multiple times.
You can use ``ALL`` to select all tasks.
This disables all cleanup tasks unless you also use the ``--cleanup`` option.
.. option:: --cleanup=<task1,task2,..>
Only cleanup the named tasks. You can select multiple tasks with a list of comma seperated names, or you can use the ``--cleanup`` option multiple times.
You can use ``ALL`` to select all tasks.
This disables all seeding tasks unless you also use the ``--seed`` option.
.. option:: --continue
Continue an interrupted seed progress. MapProxy will start the seeding progress at the begining if the progress file (``--progress-file``) was not found. MapProxy can only continue if the previous seed was started with the ``--progress-file`` or ``--continue`` option.
.. option:: --progress-file
Filename where MapProxy stores the seeding progress for the ``--continue`` option. Defaults to ``.mapproxy_seed_progress`` in the current working directory. MapProxy will remove that file after a successful seed.
.. option:: --use-cache-lock
Lock each cache to prevent multiple parallel `mapproxy-seed` calls to work on the same cache.
It does not lock normal operation of MapProxy.
.. option:: --log-config
The logging configuration file to use.
.. versionadded:: 1.5.0
``--continue`` and ``--progress-file`` option
.. versionadded:: 1.7.0
``--log-config`` option
Examples
~~~~~~~~
Seed with concurrency of 4::
mapproxy-seed -f mapproxy.yaml -c 4 seed.yaml
Print summary of all seed tasks and exit::
mapproxy-seed -f mapproxy.yaml -s seed.yaml --summary --seed ALL
Interactively select which tasks should be seeded::
mapproxy-seed -f mapproxy.yaml -s seed.yaml -i
Seed task1 and task2 and cleanup task3 with concurrency of 2::
mapproxy-seed -f mapproxy.yaml -s seed.yaml -c 2 --seed task1,task2 \
--cleanup task3
Configuration
-------------
.. note:: The configuration changed with MapProxy 1.0.0, the old format with ``seeds`` and ``views`` is still supported but will be deprecated in the future. See :ref:`below <seed_old_configuration>` for information about the old format.
The configuration is a YAML file with three sections:
``seeds``
Configure seeding tasks.
``cleanups``
Configure cleanup tasks.
``coverages``
Configure coverages for seeding and cleanup tasks.
Example
~~~~~~~
::
seeds:
myseed1:
[...]
myseed2
[...]
cleanups:
mycleanup1:
[...]
mycleanup2:
[...]
coverages:
mycoverage1:
[...]
mycoverage2:
[...]
``seeds``
---------
Here you can define multiple seeding tasks. A task defines *what* should be seeded. Each task is configured as a dictionary with the name of the task as the key. You can use the names to select single tasks on the command line of ``mapproxy-seed``.
``mapproxy-seed`` will always process one tile pyramid after the other. Each tile pyramid is defined by a cache and a corresponding grid. A cache with multiple grids consists of multiple tile pyramids. You can configure which tile pyramid you want to seed with the ``caches`` and ``grids`` options.
You can further limit the part of the tile pyramid with the ``levels`` and ``coverages`` options.
Each seed tasks takes the following options:
``caches``
~~~~~~~~~~
A list with the caches that should be seeded for this task. The names should match the cache names in your MapProxy configuration.
``grids``
~~~~~~~~~
A list with the grid names that should be seeded for the ``caches``.
The names should match the grid names in your mapproxy configuration.
All caches of this tasks need to support the grids you specify here.
By default, the grids that are common to all configured caches will be seeded.
``levels``
~~~~~~~~~~
Either a list of levels that should be seeded, or a dictionary with ``from`` and ``to`` that define a range of levels. You can omit ``from`` to start at level 0, or you can omit ``to`` to seed till the last level.
By default, all levels will be seeded.
Examples::
# seed multiple levels
levels: [2, 3, 4, 8, 9]
# seed a single level
levels: [3]
# seed from level 0 to 10 (including level 10)
levels:
to: 10
# seed from level 3 to 6 (including level 3 and 6)
levels:
from: 3
to: 6
``coverages``
~~~~~~~~~~~~~
A list with coverage names. Limits the seed area to the coverages. By default, the whole coverage of the grids will be seeded.
``refresh_before``
~~~~~~~~~~~~~~~~~~
Regenerate all tiles that are older than the given date. The date can either be absolute or relative. By default, existing tiles will not be refreshed.
MapProxy can also use the last modification time of a file. File paths should be relative to the proxy configuration or absolute.
Examples::
# absolute as ISO time
refresh_before:
time: 2010-10-21T12:35:00
# relative from the start time of the seed process
refresh_before:
weeks: 1
days: 7
hours: 4
minutes: 15
# modification time of a given file
refresh_before:
mtime: path/to/file
Example
~~~~~~~~
::
seeds:
myseed1:
caches: [osm_cache]
coverages: [germany]
grids: [GLOBAL_MERCATOR]
levels:
to: 10
myseed2
caches: [osm_cache]
coverages: [niedersachsen, bremen, hamburg]
grids: [GLOBAL_MERCATOR]
refresh_before:
weeks: 3
levels:
from: 11
to: 15
``cleanups``
------------
Here you can define multiple cleanup tasks. Each task is configured as a dictionary with the name of the task as the key. You can use the names to select single tasks on the command line of ``mapproxy-seed``.
``caches``
~~~~~~~~~~
A list with the caches where you want to cleanup old tiles. The names should match the cache names in your mapproxy configuration.
``grids``
~~~~~~~~~
A list with the grid names for the ``caches`` where you want to cleanup.
The names should match the grid names in your mapproxy configuration.
All caches of this tasks need to support the grids you specify here.
By default, the grids that are common to all configured caches will be used.
``levels``
~~~~~~~~~~
Either a list of levels that should be cleaned up, or a dictionary with ``from`` and ``to`` that define a range of levels. You can omit ``from`` to start at level 0, or you can omit ``to`` to cleanup till the last level.
By default, all levels will be cleaned up.
Examples::
# cleanup multiple levels
levels: [2, 3, 4, 8, 9]
# cleanup a single level
levels: [3]
# cleanup from level 0 to 10 (including level 10)
levels:
to: 10
# cleanup from level 3 to 6 (including level 3 and 6)
levels:
from: 3
to: 6
``coverages``
~~~~~~~~~~~~~
A list with coverage names. Limits the cleanup area to the coverages. By default, the whole coverage of the grids will be cleaned up.
.. note:: Be careful when cleaning up caches with large coverages and levels with lots of tiles (>14).
Without ``coverages``, the seed tool works on the file system level and it only needs to check for existing tiles if they should be removed. With ``coverages``, the seed tool traverses the whole tile pyramid and needs to check every posible tile if it exists and if it should be removed. This is much slower.
``remove_all``
~~~~~~~~~~~~~~
When set to true, remove all tiles regardless of the time they were created. You still limit the tiles with the ``levels`` and ``coverage`` options. MapProxy will try to remove tiles in a more efficient way with this option. For example: It will remove complete level directories for ``file`` caches instead of comparing each tile with a timestamp.
``remove_before``
~~~~~~~~~~~~~~~~~
Remove all tiles that are older than the given date. The date can either be absolute or relative. ``remove_before`` defaults to the start time of the seed process, so that newly created tile will not be removed.
MapProxy can also use the last modification time of a file. File paths should be relative to the proxy configuration or absolute.
Examples::
# absolute as ISO time
remove_before:
time: 2010-10-21T12:35:00
# relative from the start time of the seed process
remove_before:
weeks: 1
days: 7
hours: 4
minutes: 15
# modification time of a given file
remove_before:
mtime: path/to/file
Example
~~~~~~~~
::
cleanups:
highres:
caches: [osm_cache]
grids: [GLOBAL_MERCATOR, GLOBAL_SPERICAL]
remove_before:
days: 14
levels:
from: 16
old_project:
caches: [osm_cache]
grids: [GLOBAL_MERCATOR]
coverages: [mypolygon]
levels:
from: 14
to: 18
``coverages``
-------------
There are three different ways to describe the extent of a seeding or cleanup task.
- a simple rectangular bounding box,
- a text file with one or more polygons in WKT format,
- polygons from any data source readable with OGR (e.g. Shapefile, GeoJSON, PostGIS)
Read the :doc:`coverage documentation <coverages>` for more information.
.. note:: You will need to install additional dependencies, if you want to use polygons to define your geographical extent of the seeding area, instead of simple bounding boxes. See :doc:`coverage documentation <coverages>`.
Each coverage has a name that is used in the seed and cleanup task configuration. If you don't specify a coverage for a task, then the BBOX of the grid will be used.
Example
~~~~~~~
::
coverages:
germany:
datasource: 'shps/world_boundaries_m.shp'
where: 'CNTRY_NAME = "Germany"'
srs: 'EPSG:900913'
switzerland:
datasource: 'polygons/SZ.txt'
srs: 'EPSG:900913'
austria:
bbox: [9.36, 46.33, 17.28, 49.09]
srs: 'EPSG:4326'
.. _seed_old_configuration:
Old Configuration
-----------------
.. note:: The following description is for the old seed configuration.
The configuration contains two keys: ``views`` and ``seeds``. ``views`` describes
the geographical extents that should be seeded. ``seeds`` links actual layers with
those ``views``.
Seeds
~~~~~
Contains a dictionary with layer/view mapping.::
seeds:
cache1:
views: ['world', 'germany', 'oldb']
cache2:
views: ['world', 'germany']
remove_before:
time: '2009-04-01T14:45:00'
# or
minutes: 15
hours: 4
days: 9
weeks: 8
`remove_before`:
If present, recreate tiles if they are older than the date or time delta. At the
end of the seeding process all tiles that are older will be removed.
You can either define a fixed time or a time delta. The `time` is a ISO-like date
string (no time-zones, no abbreviations). To define time delta use one or more
`seconds`, `minutes`, `hours`, `days` or `weeks` entries.
Views
~~~~~
Contains a dictionary with all views. Each view describes a coverage/geographical extent and the levels that should be seeded.
Coverages
^^^^^^^^^
.. note:: You will need to install additional dependencies, if you want to use polygons to define your geographical extent of the seeding area, instead of simple bounding boxes. See :doc:`coverage documentation <coverages>`.
There are three different ways to describe the extent of the seed view.
- a simple rectangular bounding box,
- a text file with one or more polygons in WKT format,
- polygons from any data source readable with OGR (e.g. Shapefile, PostGIS)
Read the :doc:`coverage documentation <coverages>` for more information.
Other options
~~~~~~~~~~~~~
``srs``:
A list with SRSs. If the layer contains caches for multiple SRS, only the caches
that match one of the SRS in this list will be seeded.
``res``:
Seed until this resolution is cached.
or
``level``:
A number until which this layer is cached, or a tuple with a range of
levels that should be cached.
Example configuration
^^^^^^^^^^^^^^^^^^^^^
::
views:
germany:
datasource: 'shps/world_boundaries_m.shp'
where: 'CNTRY_NAME = "Germany"'
srs: 'EPSG:900913'
level: [0, 14]
srs: ['EPSG:900913', 'EPSG:4326']
switzerland:
datasource: 'polygons/SZ.txt'
srs: EPSG:900913
level: [0, 14]
srs: ['EPSG:900913']
austria:
bbox: [9.36, 46.33, 17.28, 49.09]
srs: EPSG:4326
level: [0, 14]
srs: ['EPSG:900913']
seeds:
osm:
views: ['germany', 'switzerland', 'austria']
remove_before:
time: '2010-02-20T16:00:00'
osm_roads:
views: ['germany']
remove_before:
days: 30
|