Merge pull request #126 from rustprooflabs/v0_2_0_rc

Prepare Release v0.2.0

Author: rustprooflabs

.github/workflows/docker-build.yml

@@ -2,14 +2,16 @@ name: Publish PgOSM-Flex Docker image
 on:
   push:
     branches:
-      - main
+      - broken-see-gh132
 jobs:
   push_to_registry:
     name: Push PgOSM-Flex image to Docker Hub
     runs-on: ubuntu-latest
     steps:
       - name: Check out the repo
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - name: Login to DockerHub
         uses: docker/login-action@v1
         with:

DOCKER-RUN.md

@@ -27,21 +27,38 @@ docker run --name pgosm -d \
     -p 5433:5432 -d rustprooflabs/pgosm-flex
 ```
 
-## Run and Customize PgOSM-Flex
+## Run PgOSM-Flex
+
+The following `docker exec` command runs PgOSM Flex to load the District of Columbia
+region
+
+The command  `bash docker/run_pgosm_flex.sh` runs the full process. The
+script uses a region (`north-america/us`) and sub-region (`district-of-columbia`)
+that must match values in URLs from the Geofabrik download server.
+The 3rd parameter tells the script the server has 8 GB RAM available for osm2pgsql, Postgres, and the OS.  The PgOSM-Flex layer set is defined (`run-all`).
+
+
+```bash
+docker exec -it \
+    -e POSTGRES_PASSWORD=mysecretpassword -e POSTGRES_USER=postgres \
+    pgosm bash docker/run_pgosm_flex.sh \
+    north-america/us \
+    district-of-columbia \
+    8 \
+    run-all
+```
+
+
+## Customize PgOSM-Flex
 
 The following command sets the four (4) main env vars used to customize PgOSM-Flex.
 
-* `PGOSM_SRID` - Override default SRID 3857 to custom SRID
+* `PGOSM_SRID` - Set custom SRID, must be in `public.spatial_ref_sys`.  Default `3857`
 * `PGOSM_DATA_SCHEMA_NAME` - Final schema name for the OpenStreetMap data. Default `osm`
-* `PGOSM_DATA_SCHEMA_ONLY` - When `false` (default) the `pgosm` schema is exported along with the `PGOSM_DATA_SCHEMA_NAME` schema
+* `PGOSM_DATA_SCHEMA_ONLY` - When `false` (default) the QGIS styles and `pgosm` schema are exported along with the `PGOSM_DATA_SCHEMA_NAME` schema
 * `PGOSM_DATE` - Used to document data loaded to DB in `osm.pgosm_flex.pgosm_date`, and for archiving PBF/MD5 files.  Defaults to today.
 * `PGOSM_LANGUAGE` - Used to prefer specific language when it exists.
 
-The command  `bash docker/run_pgosm_flex.sh` runs the full process. The
-script uses a region (`north-america/us`) and sub-region (`district-of-columbia`)
-that must match values in URLs from the Geofabrik download server.
-The osm2pgsql cache is set (`2000`) and the PgOSM-Flex layer set is defined (`run-all`).
-
 
 ```bash
 docker exec -it \
@@ -50,11 +67,11 @@ docker exec -it \
     -e PGOSM_DATA_SCHEMA_ONLY=true \
     -e PGOSM_DATA_SCHEMA_NAME=osm_dc \
     -e PGOSM_DATE='2021-03-11' \
-    -e PGOSM_LANGUAGE=kn \
+    -e PGOSM_LANGUAGE=en \
     pgosm bash docker/run_pgosm_flex.sh \
     north-america/us \
     district-of-columbia \
-    500 \
+    8 \
     run-all
 ```
 
@@ -81,5 +98,26 @@ docker run --name pgosm -d \
     -p 5433:5432 -d rustprooflabs/pgosm
 ```
 
+## Configure Postgres in Docker
+
+Add customizations with the `-c` switch, e.g. `-c shared_buffers=1GB`,
+to customize Postgres' configuration at run-time in Docker.
+
+
+
+```bash
+docker run --name pgosm -d \
+    -v ~/pgosm-data:/app/output \
+    -v /etc/localtime:/etc/localtime:ro \
+    -e POSTGRES_PASSWORD=mysecretpassword \
+    -p 5433:5432 -d rustprooflabs/pgosm-flex \
+    -c shared_buffers=1GB \
+    -c maintenance_work_mem=1GB \
+    -c checkpoint_timeout=300min \
+    -c max_wal_senders=0 -c wal_level=minimal \
+    -c checkpoint_completion_target=0.9 \
+    -c random_page_cost=1.0
+```
+
 
 

Dockerfile

@@ -9,8 +9,16 @@ RUN apt-get update \
         libboost-dev libboost-system-dev \
         libboost-filesystem-dev libexpat1-dev zlib1g-dev \
         libbz2-dev libpq-dev libproj-dev lua5.2 liblua5.2-dev \
+        python3 python3-distutils \
+        curl \
     && rm -rf /var/lib/apt/lists/*
 
+RUN curl -o /tmp/get-pip.py https://bootstrap.pypa.io/get-pip.py \
+    && python3 /tmp/get-pip.py \
+    && rm /tmp/get-pip.py
+
+RUN pip install requests
+
 
 WORKDIR /tmp
 RUN git clone git://github.com/openstreetmap/osm2pgsql.git \
@@ -24,6 +32,7 @@ RUN git clone git://github.com/openstreetmap/osm2pgsql.git \
         libboost-dev libboost-system-dev \
         libboost-filesystem-dev libexpat1-dev zlib1g-dev \
         libbz2-dev libpq-dev libproj-dev \
+        curl \
     && apt autoremove -y \
     && cd /tmp && rm -r /tmp/osm2pgsql
 

MANUAL-STEPS-RUN.md

@@ -226,3 +226,30 @@ psql -d $PGOSM_CONN -f ./sql/road_major.sql
 
 
 > WARNING:  Running multiple `osm2pgsql` commands requires processing the source PBF multiple times. This can waste considerable time on larger imports.  Further, attempting to define multiple styles with additional `--style=style.lua` switches results in only the last style being processed.  To mix and match multiple styles, create a custom Lua script similar to `run-all.lua` or `run-no-tags.lua`.
+
+
+
+## Additional structure and helper data
+
+**Optional**
+
+Deploying the additional table structure is done via [sqitch](https://sqitch.org/).
+
+Assumes this repo is cloned under `~/git/pgosm-flex/` and a local Postgres
+DB named `pgosm` has been created with the `postgis` extension installed.
+
+```bash
+cd ~/git/pgosm-flex/db
+sqitch deploy db:pg:pgosm
+```
+
+With the structures created, load helper road data.
+
+```bash
+cd ~/git/pgosm-flex/db
+psql -d pgosm -f data/roads-us.sql
+```
+
+
+Currently only U.S. region drafted, more regions with local `maxspeed` are welcome via PR!
+