cookbooks/tilelog/README.md

   1 # tilelog Cookbook
   2
   3 This cookbook contains the tile log processing / analysis tools. This includes creating the tile log summaries of the number of tiles downloaded from the tile caches.
   4
   5 ## Requirements
   6
   7 #### cookbooks
   8 - `tools` - tilelog needs the OSM tools cookbook.
   9 - `git` - tilelog needs the OSM git cookbook to download the tile log analysis source.
  10
  11 #### packages
  12 - `gcc` - for building the analysis tool.
  13 - `make` - for building the analysis tool.
  14 - `autoconf` - for building the analysis tool.
  15 - `automake` - for building the analysis tool.
  16 - `libboost-filesystem-dev` - a dependency of the analysis tool.
  17 - `libboost-system-dev` - a dependency of the analysis tool.
  18 - `libboost-program-options-dev` - a dependency of the analysis tool.
  19
  20 ## Attributes
  21
  22 #### tilelog::default
  23 <table>
  24   <tr>
  25     <th>Key</th>
  26     <th>Type</th>
  27     <th>Description</th>
  28     <th>Default</th>
  29   </tr>
  30   <tr>
  31     <td><tt>[:tilelog][:source_directory]</tt></td>
  32     <td>String</td>
  33     <td>Directory in which the source is checked out and built.</td>
  34     <td><tt>/opt/tilelog</tt></td>
  35   </tr>
  36   <tr>
  37     <td><tt>[:tilelog][:input_directory]</tt></td>
  38     <td>String</td>
  39     <td>Directory in which the input log files can be found.</td>
  40     <td><tt>/store/logs/tile.openstreetmap.org</tt></td>
  41   </tr>
  42   <tr>
  43     <td><tt>[:tilelog][:source_directory]</tt></td>
  44     <td>String</td>
  45     <td>Directory in which the output analysis files are to be placed.</td>
  46     <td><tt>/store/planet/tile_logs</tt></td>
  47   </tr>
  48 </table>
  49
  50 ## Usage
  51
  52 #### tilelog::default
  53 TODO: Write usage instructions for each cookbook.
  54
  55 e.g.
  56 Just include `tilelog` in your node's `run_list`:
  57
  58 ```json
  59 {
  60   "name":"my_node",
  61   "run_list": [
  62     "recipe[tilelog]"
  63   ]
  64 }
  65 ```
  66
  67 ## License and Authors
  68
  69 Released under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
  70
  71 Authors: Matt Amos