cvallance/mongo-k8s-sidecar

Mongo Kubernetes副本集Sidecar

镜像概述

本项目是一个概念验证（PoC）工具，用于在Kubernetes环境中设置MongoDB副本集，能够处理任意类型的集群规模调整，并能适应MongoDB和Kubernetes可能遇到的各种运行场景。

核心功能

• 自动初始化MongoDB副本集
• 动态维护副本集成员（添加新节点、移除异常节点）
• 支持StatefulSet稳定网络ID作为副本集节点标识
• 支持SSL加密连接配置
• 支持MongoDB认证（用户名/密码）
• 适应Kubernetes集群的动态变化

使用场景

• Kubernetes集群中部署高可用MongoDB副本集
• 需要动态扩展或缩容MongoDB集群
• 需要自动化维护MongoDB副本集状态
• 需要在K8s环境中实现MongoDB的高可靠性

配置说明

环境变量参数

副本集节点标识示例

默认配置（Pod IP）

[ { _id: 1,
   name: '10.48.0.70:27017',
   stateStr: 'PRIMARY',
   ...},
 { _id: 2,
   name: '10.48.0.72:27017',
   stateStr: 'SECONDARY',
   ...},
 { _id: 3,
   name: '10.48.0.73:27017',
   stateStr: 'SECONDARY',
   ...} ]

StatefulSet稳定网络ID（需设置KUBERNETES_MONGO_SERVICE_NAME）

[ { _id: 1,
   name: 'mongo-prod-0.mongodb.db-namespace.svc.cluster.local:27017',
   stateStr: 'PRIMARY',
   ...},
 { _id: 2,
   name: 'mongo-prod-1.mongodb.db-namespace.svc.cluster.local:27017',
   stateStr: 'SECONDARY',
   ...},
 { _id: 3,
   name: 'mongo-prod-2.mongodb.db-namespace.svc.cluster.local:27017',
   stateStr: 'SECONDARY',
   ...} ]

• StatefulSet名称：mongo-prod
• 无头服务名称：mongodb
• 命名空间：db-namespace

带SSL的MongoDB部署示例

MongoDB容器命令

yaml
- name: my-mongo
  image: mongo
  command:
    - mongod
    - "--replSet"
    - heroku
    - "--bind_ip"
    - 0.0.0.0
    - "--smallfiles"
    - "--noprealloc"
    - "--sslMode"
    - "requireSSL"
    - "--sslPEMKeyFile"
    - "/data/ssl/mongodb.pem"
    - "--sslAllowConnectionsWithoutCertificates"
    - "--sslAllowInvalidCertificates"
    - "--sslAllowInvalidHostnames"

卷与卷挂载

yaml
volumeMounts:
  - name: mongo-persistent-storage
    mountPath: /data/db
  - name: mongo-ssl
    mountPath: /data/ssl
- name: mongo-sidecar
  image: cvallance/mongo-k8s-sidecar:latest
  env:
    - name: MONGO_SIDECAR_POD_LABELS
      value: "role=mongo,environment=prod"
    - name: MONGO_SSL_ENABLED
      value: 'true'
volumes:
  - name: mongo-ssl
    secret:
      secretName: mongo

创建SSL Secret

使用Makefile

bash
export MONGO_SECRET_NAME=mongo-ssl
export KUBECTL_NAMESPACE=default
cd examples && make generate-certificate

手动创建

bash
kube create secret generic mongo --from-file=./keys

（keys目录需包含名为mongodb.pem的SSL证书文件）

调试

TODO：克隆、挂载和监控的说明

待完成

• 添加测试
• 集成CircleCI
• 优化K8s调用以避免内存过滤