spunon/regup

Regup镜像说明

镜像概述

Regup是运行在Kubernetes Pod中的辅助容器，与应用容器同Pod部署，用于将应用服务注册到HashiCorp Consul，支持选择Pod或主机地址端口注册，并提供多种健康检查方式，同时自动处理服务注销。

核心功能

• 支持以Pod或主机地址（NODE_IP/POD_IP）注册服务到Consul
• 提供HTTP、TCP及脚本三种健康检查方式
• 自动处理服务在Consul中的注销
• 同一Pod内可运行多个Regup容器，处理多端口及多健康检查需求

使用场景

适用于Kubernetes集群中需要将服务注册到Consul进行服务发现的场景，例如微服务架构下的服务注册与健康状态监控。

配置说明

通过环境变量配置Regup容器，关键变量如下：

• NODE_IP: 主机节点IP（必填，需通过fieldRef获取）
• POD_IP: Pod IP（若ADDRESS_TYPE为POD则必填）
• ADDRESS_TYPE: 注册地址类型（必填，可选POD/NODE）
• SERVICE_NAME: 服务名称（必填）
• SERVICE_PORT: 服务端口（必填）
• HEALTH_TYPE: 健康检查类型（若启用检查则必填，可选HTTP/TCP/Script）
• HEALTH_ENDPOINT: HTTP/TCP检查端点（HEALTH_TYPE为HTTP/TCP时必填）
• HEALTH_SCRIPT: 脚本检查命令（HEALTH_TYPE为Script时必填）
• HEALTH_INTERVAL: 检查间隔（默认10s）
• HEALTH_TIMEOUT: 检查超时（默认1s）

部署示例（Nginx + Regup）

以下是使用Regup注册Nginx服务到Consul的Deployment示例：

yaml
apiVersion: apps/v1beta1
kind: Deployment
metadata:
  name: nginx-deployment
spec:
  replicas: 3
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      # 演示用Nginx容器
      - name: nginx
        image: nginx
        ports:
        - name: http
          containerPort: 80
  
      # Regup辅助容器（注册Pod到Consul）
      - name: regup
        image: docker.io/spunon/regup:v1
        imagePullPolicy: Always
        env:
        # 必填 - 主机节点IP，假设Consul Agent以hostNetwork=true运行在节点上
        - name: NODE_IP
          valueFrom:
            fieldRef:
              fieldPath: status.hostIP
        # Pod IP - 若ADDRESS_TYPE为POD则必填
        - name: POD_IP
          valueFrom:
            fieldRef:
              fieldPath: status.podIP
        # 必填 - 注册地址类型（POD/NODE）
        - name: ADDRESS_TYPE
          value: "POD"
        # 必填 - 服务名称
        - name: SERVICE_NAME
          value: "nginx"
        # 必填 - 服务端口
        - name: SERVICE_PORT
          value: "80"
        # 服务ID后缀（同一节点多实例时使用）
        - name: UNIQUE_ID
          value: "0"
        # 必填（若启用健康检查）- 健康检查类型
        - name: HEALTH_TYPE
          value: "Script"
        # Script检查命令（替代HEALTH_ENDPOINT）
        - name: HEALTH_SCRIPT
          value: "curl -sI [***]{SERVICE_IP}:${SERVICE_PORT} | grep HTTP | grep 200"
        # 不健康后注销时间（默认1m）
        - name: HEALTH_DEREGISTER_AFTER
          value: "1m"
        # 检查间隔（默认10s）
        - name: HEALTH_INTERVAL
          value: "10s"
        # 检查超时（默认1s）
        - name: HEALTH_TIMEOUT
          value: "1s"
        # 跳过TLS验证（默认true）
        - name: HEALTH_TLS_SKIP_VERIFY
          value: "true"
        # Consul协议（默认http）
        - name: CONSUL_PROTOCOL
          value: "http"