vaporio/k8s-elector

Kubernetes原生边车选举服务镜像

镜像概述

本镜像是一个轻量级的Kubernetes原生边车（Sidecar）选举服务，专为解决Kubernetes集群中边车容器的主从选举问题而设计。通过原生集成Kubernetes API，实现边车容器在多副本部署环境下的自动主从角色分配，确保仅一个主边车实例执行关键任务，其他实例作为备用，提升系统可靠性。

核心功能与特性

• 轻量级设计：资源占用低，适合作为边车容器与主应用协同部署
• Kubernetes原生：深度集成Kubernetes API，利用原生资源（如ConfigMap、Lease）实现选举机制
• 自动选举：无需手动干预，基于预定义规则自动完成主从角色选举
• 故障切换：主实例故障时，自动从备用实例中选举新主，确保服务连续性
• 简单集成：支持通过环境变量或配置文件灵活配置，易于集成到现有Kubernetes部署中

使用场景

• 日志/指标收集：确保仅一个边车实例负责聚合多副本应用的日志或指标
• 服务网格代理：在服务网格场景中管理边车代理的主从角色，避免重复处理
• 有状态应用辅助：为有状态应用提供主从选举支持，如数据库副本集的辅助管理
• 分布式锁场景：作为轻量级分布式锁服务，协调多实例间的资源竞争

使用方法

Kubernetes部署示例

以下是在Kubernetes中部署带有边车选举服务的Deployment示例：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: example-app
spec:
  replicas: 3
  selector:
    matchLabels:
      app: example-app
  template:
    metadata:
      labels:
        app: example-app
    spec:
      containers:
      - name: main-app
        image: your-main-app-image:latest
        ports:
        - containerPort: 8080
      - name: sidecar-elector
        image: [镜像名称]:[版本]
        env:
        - name: ELECTION_LOCK_NAME
          value: "example-app-sidecar-lock"
        - name: NAMESPACE
          valueFrom:
            fieldRef:
              fieldPath: metadata.namespace
        - name: LEASE_DURATION
          value: "30s"
        - name: RENEW_DEADLINE
          value: "15s"
        - name: RETRY_PERIOD
          value: "5s"

Docker运行示例（测试环境）

bash
docker run -d \
  --name sidecar-elector \
  -e ELECTION_LOCK_NAME=test-lock \
  -e NAMESPACE=default \
  -e KUBERNETES_SERVICE_HOST=kube-apiserver.example.com \
  -e KUBERNETES_SERVICE_PORT=6443 \
  [镜像名称]:[版本]

配置说明

环境变量

选举状态输出

选举服务通过以下方式暴露当前状态：

• 文件输出：在/var/run/sidecar-elector/status文件中写入当前角色（leader或follower）
• 环境变量注入：可配置将选举结果注入到主应用容器的环境变量（需通过Kubernetes Downward API实现）
• HTTP接口：默认在:8080/health提供健康检查接口，返回当前选举状态

注意事项

• 确保Kubernetes集群版本≥1.14（Lease API支持）
• 边车容器需具备访问Kubernetes API的权限（建议通过Service Account配置RBAC权限）
• 多副本部署时，建议replicas数量≥2以确保高可用性
• 选举锁资源会在Pod删除时自动清理，无需手动干预