ncsa/checks

NCSA CHECKS 镜像文档

概述

NCSA CHECKS是一个专为Kubernetes设计的init容器镜像，用于在主容器启动前检查依赖服务是否就绪。通过在init阶段执行连接性验证，确保依赖服务（如数据库、消息队列、HTTP服务等）已准备好接受连接，避免主应用因依赖服务未就绪而启动失败。

核心功能与特性

• 多服务支持：可检查RabbitMQ、MongoDB、HTTP URL、PostgreSQL等多种服务的就绪状态
• 灵活配置：通过环境变量定义检查参数，适配不同服务的连接需求
• 明确退出码：每种检查类型对应唯一退出码，便于问题定位
• Kubernetes集成：作为init容器无缝融入Kubernetes部署流程，确保依赖服务就绪后启动主容器

使用场景

适用于Kubernetes环境中任何存在依赖服务的应用部署，例如：

• 微服务架构中依赖数据库（PostgreSQL）、消息队列（RabbitMQ）的应用
• 需要验证外部HTTP服务可用性的场景
• 需确认数据库表存在后才启动的应用部署

使用方法与配置说明

Kubernetes部署示例

以下示例展示如何在Kubernetes Deployment中使用该镜像作为init容器，检查RabbitMQ和PostgreSQL服务就绪状态：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: mywebapp
spec:
  replicas: 1
  selector:
    matchLabels:
      app: mywebapp
  template:
    metadata:
      labels:
        app: mywebapp
    spec:
      initContainers:
        - name: check-rabbitmq  # 检查RabbitMQ就绪状态
          image: "ncsa/checks:1.0.0"
          env:
            - name: RABBITMQ_URI  # RabbitMQ连接URI（必填）
              value: "amqp://user:pass@rabbitmq/%2F"
        - name: check-postgresql  # 检查PostgreSQL就绪状态
          image: "ncsa/checks:1.0.0"
          env:
            - name: PGURI  # PostgreSQL连接URI（必填）
              value: "postgresql://postgres:secret@postgresql:5432/mydb"
            - name: PGTABLE  # 可选，需验证存在的表名
              value: "users"
      containers:
        - name: mywebapp  # 主应用容器
          image: mywebapp:1.0
          ports:
            - containerPort: 80
          env:
            - name: RABBITMQ_URI
              value: "amqp://user:pass@rabbitmq/%2F"
            - name: PGHOST
              value: "postgres"
            - name: PGUSER
              value: "postgres"

支持的检查类型

RabbitMQ

• 描述：检查是否能连接到RabbitMQ服务器
• 退出码：1
• 参数：
  • RABBITMQ_URI [必填]：RabbitMQ服务器连接URI（格式：amqp://user:pass@host/%2F）

MongoDB

• 描述：检查是否能连接到MongoDB服务器
• 退出码：2
• 参数：
  • MONGO_URI [必填]：MongoDB服务器连接URI（格式：mongodb://user:pass@host:port/dbname）

URL

• 描述：检查URL是否可达且返回200状态码；若提供可选文本，则需在响应体中包含该文本
• 退出码：3
• 参数：
  • URL [必填]：待检查的URL地址
  • URL_TEXT [可选]：响应体中需包含的文本内容

PostgreSQL

• 描述：检查数据库是否可用；若提供可选表名，则需验证该表存在
• 退出码：4
• 参数：
  • PGURI [必填*]：PostgreSQL连接URI（格式：postgresql://user:pass@host:port/dbname）
  • PGUSER [必填*]：数据库用户名
  • PGPASSWORD [必填*]：数据库密码
  • PGHOST [必填*]：数据库主机地址
  • PGPORT [必填*]：数据库端口
  • PGDATABASE [必填*]：数据库名称
  • PGTABLE [可选]：需存在的表名

*注：PostgreSQL检查需提供PGURI，或单独提供PGUSER、PGPASSWORD、PGHOST、PGPORT、PGDATABASE参数

未来计划

• 新增check_service功能：检查指定host:port是否可达
• 为每种检查类型添加简单测试用例
• 为MongoDB检查添加数据库/集合验证功能