peterevans/nominatim-k8s

适用于Kubernetes的Nominatim

https://images.microbadger.com/badges/image/peterevans/nominatim-k8s.svg](https://microbadger.com/images/peterevans/nominatim-k8s) https://circleci.com/gh/peter-evans/nominatim-k8s/tree/master.svg?style=svg](https://circleci.com/gh/peter-evans/nominatim-k8s/tree/master)

https://github.com/openstreetmap/Nominatim 适用于Google Container Engine (GKE) 上的Kubernetes环境。

该Docker镜像及示例Kubernetes配置文件提供了一种持久化Nominatim数据并实现不可变部署的解决方案。

支持的标签及对应Dockerfile链接

• https://github.com/peter-evans/nominatim-docker/tree/v2.6.2
• https://github.com/peter-evans/nominatim-docker/tree/v2.6.1
• https://github.com/peter-evans/nominatim-docker/tree/v2.6.0
• https://github.com/peter-evans/nominatim-docker/tree/v2.5.4

使用方法

该Docker镜像可独立运行，无需依赖Kubernetes：

bash
docker run -d -p 8080:8080 \
-e NOMINATIM_PBF_URL='http://download.geofabrik.de/asia/maldives-latest.osm.pbf' \
--name nominatim docker.xuanyuan.run/peterevans/nominatim-k8s:latest

通过日志验证数据库是否构建完成及Apache是否正常提供服务：

docker logs -f <容器ID>

之后可访问浏览器地址：http://localhost:8080/

Kubernetes部署

https://github.com/openstreetmap/Nominatim 从PBF文件导入数据到PostgreSQL可能需要超过一小时（针对单个国家）。若部署中的Pod失败，等待新Pod启动可能导致服务中断。

示例Kubernetes文件提供了一种将单个数据库持久化到存储中的方法，供部署中的所有Pod使用。每个Pod拥有独立数据库可避免单点故障，替代方案是维护高可用PostgreSQL集群。

PostgreSQL的数据目录会归档到存储中，并在新Pod启动时恢复。此方法虽简单，但比pg_dump/pg_restore更快，可减少Pod启动时间。

说明

初始部署流程：

1. 创建包含Google Cloud IAM服务账号JSON密钥的Secret（该账号需具备Google Storage的读写权限）。
2. 部署金丝雀（canary）部署。
3. 等待数据库创建完成并将其归档上传至Google Storage。
4. 删除金丝雀部署。
5. 部署稳定版（stable track）部署。

更新实时部署以使用新PBF数据：

1. 在稳定版部署旁部署金丝雀部署。
2. 等待数据库创建完成并上传归档至Google Storage。
3. 删除金丝雀部署。
4. 对稳定版部署执行滚动更新，创建使用新数据库的Pod。

创建Secret

bash
# Google Cloud项目ID及服务账号详情
PROJECT_ID=my-project
SA_NAME=my-service-account
SA_DISPLAY_NAME="My Service Account"
SA_EMAIL=$SA_NAME@$PROJECT_ID.iam.gserviceaccount.com
KEY_FILE=service-account-key.json

# 创建新的GCP IAM服务账号
gcloud iam service-accounts create $SA_NAME --display-name "$SA_DISPLAY_NAME"

# 为服务账号创建并下载新密钥
gcloud iam service-accounts keys create $KEY_FILE --iam-account $SA_EMAIL

# 为服务账号授予"Storage Object Viewer"和"Storage Object Creator" IAM角色
gcloud projects add-iam-policy-binding $PROJECT_ID --member serviceAccount:$SA_EMAIL --role roles/storage.objectViewer
gcloud projects add-iam-policy-binding $PROJECT_ID --member serviceAccount:$SA_EMAIL --role roles/storage.objectCreator

# 创建包含服务账号密钥文件的Secret
kubectl create secret generic nominatim-storage-secret --from-file=$KEY_FILE

部署配置

部署前需编辑金丝雀部署和稳定版部署的env部分：

• NOMINATIM_MODE - 从PBF数据CREATE（创建）或从Google StorageRESTORE（恢复）。
• NOMINATIM_PBF_URL - PBF数据文件的URL（NOMINATIM_MODE=RESTORE时可选）。
• NOMINATIM_DATA_LABEL - 数据的唯一标识标签，例如maldives-20161213。
• NOMINATIM_SA_KEY_PATH - JSON服务账号密钥的路径，需与Secret挂载的mountPath匹配。
• NOMINATIM_PROJECT_ID - Google Cloud项目ID。
• NOMINATIM_GS_BUCKET - Google Storage存储桶。
• NOMINATIM_PG_THREADS - PostgreSQL可用线程数，默认值为2。

许可证

MIT许可证 - 详见LICENSE文件。