georgeciachir/small-app

镜像概述

本镜像为一个小型Spring Boot应用，默认暴露8080端口，提供多个HTTP端点，主要用于K8s学习场景，可演示存活探针（liveness probe）、就绪探针（readiness probe）等功能的配置与验证。

核心功能和特性

主要端点

1. 问候端点

• HTTP方法：GET
• 路径：/{your_name}
• 功能：接收路径参数your_name，返回问候消息
• 响应示例：请求/John返回"Hello, John !"

2. 健康检查端点

• HTTP方法：GET
• 路径：/health
• 功能：返回应用健康状态
• 响应：
  • 健康状态：HTTP 200 OK，响应体"Up"
  • 非健康状态：HTTP 500 INTERNAL_SERVER_ERROR，响应体"Down"

3. 健康状态修改端点

• HTTP方法：POST
• 路径：/health/{healthy}
• 参数：healthy（布尔值，true/false）
• 功能：手动修改应用健康状态（用于演示K8s存活探针检测）
• 示例：POST /health/false将健康状态设置为"Down"

4. 就绪检查端点

• HTTP方法：GET
• 路径：/readiness
• 功能：返回应用就绪状态（当前固定返回就绪）
• 响应：HTTP 200 OK，响应体"Ready"

使用场景和适用范围

• K8s学习与实践：用于演示K8s存活探针（检测/health端点）和就绪探针（检测/readiness端点）的配置
• 容器健康监控测试：验证容器健康状态切换对K8s Pod调度的影响
• Spring Boot基础端点开发示例：作为简单HTTP端点实现的参考案例

使用方法和配置说明

基本部署

Docker Run命令

bash
docker run -d -p 8080:8080 --name spring-boot-k8s-demo [镜像名称]

• -p 8080:8080：将容器8080端口映射到主机8080端口
• --name：指定容器名称（可选）

端点访问示例

1. 访问问候端点

bash
curl http://localhost:8080/Alice
# 响应："Hello, Alice !"

2. 检查健康状态

bash
curl http://localhost:8080/health
# 默认响应："Up"（HTTP 200）

3. 修改健康状态

bash
# 设置为非健康状态
curl -X POST http://localhost:8080/health/false
# 再次检查健康状态
curl http://localhost:8080/health
# 响应："Down"（HTTP 500）

# 恢复健康状态
curl -X POST http://localhost:8080/health/true
curl http://localhost:8080/health
# 响应："Up"（HTTP 200）

4. 检查就绪状态

bash
curl http://localhost:8080/readiness
# 响应："Ready"（HTTP 200）

Docker Compose配置示例

创建docker-compose.yml文件：

yaml
version: '3'
services:
  spring-boot-demo:
    image: [镜像名称]
    ports:
      - "8080:8080"
    restart: always

启动服务：

bash
docker-compose up -d

配置说明

本应用无需额外配置，默认监听8080端口，所有端点开箱即用。如需修改端口，可通过Spring Boot配置文件调整（需重新构建镜像）。