Skip to content

README.md

Latest commit

 

History

History
27 lines (25 loc) · 1.5 KB

README.md

File metadata and controls

27 lines (25 loc) · 1.5 KB
Raw

Documentation

  • Deployment options: the two modes (crd, configmap), what each needs, how to install and operate them, and running the runner without the operator.
  • Database: the rights a sync's user needs, setup SQL, and read-only access for consumers.
  • Features: upstreams, actions, expire tiles, re-imports and renames, storage, monitoring, security, several regions, passwords.
  • Design: architecture, the sync state machine, workspaces, trust model, credentials and the test tiers.
  • Monitoring: Prometheus metrics, alerts and what to do when they fire.
  • State machines: Mermaid diagrams of the import lifecycle, production during a re-import, the sync phase and one run.
  • Development: building and testing.
  • OSM metadata, changesets and audit trails: spec.metadata: changeset ids, element versions, history and changesets next to imposm's tables (package internal/osmmeta).
  • Problems found by the tests: imposm bugs the tests found, and how the operator works around them.

The spec reference is api/v1alpha1/types.go (JSON Schema: config/schema/); examples/ has ImposmSync resources (minimal, with expire tiles), a ConfigMap sync, Helm values for Geofabrik regions, the planet and openstreetmap.fr, and a CloudNativePG database.