yannig/eni-flask-healthcheck

Kubernetes ENI书籍示例：简单Flask应用

镜像概述和主要用途

本镜像为ENI出版社Kubernetes书籍配套的示例应用，是一个集成健康检查功能的简单Flask Web应用。主要用于演示容器化应用的基础构建、部署流程及健康检查机制，适合Kubernetes初学者学习和实践容器应用开发与运维。

核心功能和特性

• 基于Flask框架开发的轻量级Web应用
• 内置健康检查接口，支持应用状态监控
• 简洁的代码结构，易于理解和扩展
• 极小的镜像体积，启动快速，资源占用低

使用场景和适用范围

• Kubernetes入门学习中的容器部署示例
• 容器健康检查机制的实践教学
• 简单Web应用容器化的基础参考
• 开发环境中的测试应用模板

使用方法和配置说明

基本运行方式

通过Docker命令直接启动容器：

bash
docker run -d -p 5000:5000 [镜像名称]

健康检查接口

应用提供标准健康检查端点：

• 访问路径：/health
• 响应内容：返回JSON格式健康状态
• 状态码：200表示应用健康，非200表示异常

自定义配置

支持通过环境变量调整应用参数：

• PORT：指定应用监听端口，默认5000
• HEALTH_CHECK_PATH：自定义健康检查路径，默认/health

示例：自定义端口和健康检查路径

bash
docker run -d \
  -e PORT=8080 \
  -e HEALTH_CHECK_PATH=/status \
  -p 8080:8080 \
  [镜像名称]

Docker部署示例

1. 基础部署（docker run）

bash
# 启动默认配置的应用
docker run --name flask-example -d -p 5000:5000 [镜像名称]

# 查看应用日志
docker logs -f flask-example

# 验证健康检查
curl http://localhost:5000/health

2. 完整docker-compose配置

创建docker-compose.yml文件：

yaml
version: '3.8'
services:
  flask-app:
    image: [镜像名称]
    container_name: flask-k8s-example
    ports:
      - "5000:5000"
    environment:
      - PORT=5000
      - HEALTH_CHECK_PATH=/health
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:5000/health"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 30s
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

查看健康状态：

bash
docker inspect --format='{{.State.Health.Status}}' flask-k8s-example