rudester/postgres-toolbox

postgres-toolbox 镜像文档

镜像概述

postgres-toolbox 是一个专为在Kubernetes环境中操作PostgreSQL数据库设计的工具集合镜像。该镜像集成了多种PostgreSQL管理工具和Kubernetes客户端工具，旨在简化PostgreSQL数据库在Kubernetes集群中的日常运维、监控、备份恢复及配置管理等任务。项目源码可参考：https://github.com/rudimk/postgres-toolbox%E3%80%82

核心功能与特性

• 多工具集成：包含PostgreSQL客户端工具（如psql、pg_dump、pg_restore）和Kubernetes工具（如kubectl），满足数据库与容器编排平台的联动操作需求。
• 环境适应性：针对Kubernetes环境优化，支持直接与集群内PostgreSQL实例交互，无需额外配置本地工具链。
• 轻量级设计：基于精简基础镜像构建，减少资源占用，适合在容器化环境中快速部署和使用。
• 灵活配置：支持通过环境变量或挂载配置文件自定义连接参数，适配不同PostgreSQL集群配置。

使用场景

• Kubernetes环境PostgreSQL日常运维：执行数据库连接、查询、数据导入导出等操作。
• 数据库备份与恢复：使用pg_dump/pg_restore工具对Kubernetes内PostgreSQL实例进行数据备份和恢复。
• 开发测试环境辅助：快速部署工具环境，验证数据库配置或调试数据库相关问题。
• 集群迁移支持：协助在Kubernetes集群间或集群内外迁移PostgreSQL数据。

使用方法

基本使用（Docker Run）

通过以下命令启动工具容器，可直接与Kubernetes集群内的PostgreSQL实例交互：

bash
docker run --rm -it \
  -v $HOME/.kube/config:/root/.kube/config \  # 挂载Kubernetes配置，实现kubectl访问集群
  rudimk/postgres-toolbox:latest

进入容器后，可直接使用内置工具：

• 连接PostgreSQL：psql -h <postgres-service> -U <username> -d <database>
• 执行Kubernetes操作：kubectl get pods -n <namespace>
• 数据库备份：pg_dump -h <postgres-service> -U <username> -d <database> > backup.sql

自定义连接参数

通过环境变量指定默认PostgreSQL连接信息，简化操作：

bash
docker run --rm -it \
  -v $HOME/.kube/config:/root/.kube/config \
  -e POSTGRES_HOST=<postgres-service> \
  -e POSTGRES_USER=<username> \
  -e POSTGRES_DB=<database> \
  rudimk/postgres-toolbox:latest

进入容器后，可直接使用psql命令连接默认数据库。

Docker Compose配置

创建docker-compose.yml文件，定义工具服务：

yaml
version: '3'
services:
  postgres-toolbox:
    image: rudimk/postgres-toolbox:latest
    volumes:
      - $HOME/.kube/config:/root/.kube/config
      - ./backups:/backups  # 挂载本地目录用于存储备份文件
    environment:
      - POSTGRES_HOST=postgres-service
      - POSTGRES_USER=admin
      - POSTGRES_DB=appdb
    tty: true
    stdin_open: true

启动服务：docker-compose up -d，进入容器：docker-compose exec postgres-toolbox sh。

注意事项

• 确保挂载的Kubernetes配置文件（~/.kube/config）具有访问目标PostgreSQL所在命名空间的权限。
• 敏感信息（如数据库密码）建议通过Kubernetes Secrets管理，避免直接在命令行或环境变量中暴露。
• 执行备份等操作时，建议挂载本地目录到容器内，以便持久化存储备份文件。