Merge pull request #210 from developmentseed/update/docs_envs

Update docker-compose config - readme and  environment-variable files

Author: Ruben L. Mendoza

.dockerignore

@@ -21,6 +21,7 @@ db-backup-restore/
 nominatim-data/
 postgresdata/
 taginfo-data/
+data/
 .env
 .env-nominatim
 .env-nominatim.example
@@ -31,10 +32,14 @@ taginfo-data/
 .env-tasking-manager.example
 .env-tiler
 .env-tiler.example
-.env.example
+.env.example\
+.env.*
+.env.*.example
 # ignore all *.class files in all folders, including build root
 **/*.json
 
 # ignore all markdown files (md) beside all README*.md
 *.md
 !README*.md
+
+envs/

.env-nominatim.example

@@ -5,6 +5,8 @@
 .env-overpass
 .env-taginfo
 .DS_Store
+.env.*
+!.env.*.example
 
 usa.values.yaml
 prod.values.yaml
@@ -21,7 +23,6 @@ tiler-imposm-data/
 tiler-server-data/
 nominatim-pgdata/
 taginfo-data/
-data/
 *.osm
 *.pbf
 *.bz2
@@ -31,4 +32,6 @@ tiler-imposm/cachedir/
 tiler-imposm/diff/
 tiler-imposm/imposm3_expire_dir
 tiler-server/imposm/
-overpass-api-db/
+overpass-api-db/
+data/*/
+!data/README.md

.env-taginfo.example

@@ -13,28 +13,38 @@ You will need `docker` and `docker-compose` installed on your system.
 
 ### Run locally
 
-Copy `.env.example` to `.env` and edit as appropriate. 
+Osm-seed contains different containers, you may need to comment out some of them at docker-compose.yml according to your use case.
+
+Copy the required environment files  form `envs/` folder, e.g `envs/.env.db.example` to `.env.db` and edit as appropriate. 
 
 Run `docker-compose build` to build all Dockerfiles defined in `docker-compose.yml`.
 
-Run `source .env && docker-compose up` to run all containers defined in `docker-compose`
+Run `docker-compose up` to run all containers defined in `docker-compose.yml`
+
+Once `docker-compose` is running, you should be able to access a local instance of services:
 
-Once `docker-compose` is running, you should be able to access a local instance of the OpenStreetMap website on `http://localhost:80`
+   - OpenStreetMap website on `http://localhost:80`
+   - Api DB on port 5432
+   - Tiler DB on port 5433
+   - Vector tile server on `http://localhost:9090`
+   - Nominatim DB on port 5434
+   - Nominatim API on  `http://localhost:7070`
+   - Overpass API on `http://localhost:8081`
+   - Tasking Manager API on `http://localhost:5050`
+   - Taginfo API website on `http://localhost:4567`
+   - OpenStreetMap website on `http://localhost:80`
 
 NOTE: 
 
  - The map-tiles on the instance are being served from the main osm.org website currently. 
  - Make sure the port 5432 and 80 are not busy.
+ - Data outputs from osm-seed is going to be store i the `data/` folder.
 
-### Building and Running individual containers
 
-Sometime you may require building and running a container by itself, so to do that and to put the container on the same network as other containers it maybe dependent on, first you should create a network.
-
-e.g
+### Building and Running individual containers
 
-```
-docker network create osm_network
+Sometime you may require building and running a container by itself, so to do that and to put the container on the same network as other containers, take a looks on the folder [`images`](images/) of each contianer.
 
-```
+### Run in Kubernetes Cluster
 
-And then follow the README file in folders specific for each container definition, to configure, edit and test individual containers. 
+For running in kubernetes use helm templates, https://devseed.com/osm-seed-chart/

.env-tiler.example

@@ -16,17 +16,24 @@ This project provides docker container definitions for various aspects of the Op
 
 ### What's included now:
 
- - `web` A container that runs The OpenStreetMap Rails Port.
- - `db` A container that runs OSM Api database.
- - `populate-apidb` A container that runs `osmium` to import data into the api-db.
- - `planet-dump` A container that exports a planet replication in pbf format.
- - `replication-job`  A container that exports data from the api-db every minute, hour or day.
- - `db-backup-restore` A container that runs database backup.
- - A `Helm` [chart](https://www.helm.sh/), simplifying the process of deploying the entire system onto a Kubernetes cluster.
-
-### Diagram
+ - [`web`](images/web) A container that runs The OpenStreetMap Rails Port - https://wiki.openstreetmap.org/wiki/Main_Page.
+ - [`db`](images/db) A container that runs OSM Api database.
+ - [`populate-apidb`](images/populate-apidb) A container that runs `osmium` to import data into the api-db.
+ - [`planet-dump`](images/planet-dump) A container that exports a planet replication in pbf format.
+ - [`full-history`](images/full-history) A container that exports a full planet replication in pbf format.
+ - [`replication-job`](images/replication-job)  A container that exports data from the api-db every minute, hour or day.
+ - [`db-backup-restore`](images/db-backup-restore) A container that runs database backup.
+
+ - [`tiler-db`](images/tiler-db) A container that runs tiler database.
+ - [`tiler-imposm`](images/tiler-imposm) A container that runs updates from minute replication job.
+ - [`tiler-server`](images/tiler-server) A container that runs vector tile server base on tegola - https://github.com/go-spatial/tegola
+
+ - [`nominatim`](images/nominatim) A container that runs geocoder using data from `planet-dump` and `replication-job`
+ - [`overpass-api`](images/overpass-api) A container that runs read-only API for filtering  map data - https://wiki.openstreetmap.org/wiki/Overpass_API
+ - [`taginfo`](images/taginfo) A container that runs a service for finding and aggregating information about osm-seed tags - https://wiki.openstreetmap.org/wiki/Taginfo
+ - [`tasking-manager-api`](images/tasking-manager-api) A container that runs Task manager rest api - https://github.com/pgmorgan/task-manager-api
 
-![](https://user-images.githubusercontent.com/1152236/49454074-6c6b2280-f7b2-11e8-944d-e47136d1dcf9.png)
+ - A `Helm` [chart](https://www.helm.sh/), simplifying the process of deploying the entire system onto a Kubernetes cluster.
 
 ### Usage
 For more details on installation, see [INSTALL.md](INSTALL.md).

.env.example

@@ -0,0 +1,2 @@
+# Data folder to store  osm-seed outputs
+