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