codecentric/spring-boot-admin

Spring Boot Admin Docker 镜像文档

1. 镜像概述

1.1 主要用途

本镜像包含 Spring Boot Admin 的基础预构建版本，用于快速部署和演示 Spring Boot 应用的监控与管理功能。其核心定位为开发环境工具，提供基础的 Spring Boot Admin 服务能力。

1.2 重要说明

• 非生产环境专用：镜像仅包含基础构建，未经过生产环境所需的安全加固、性能优化及高可用配置，严禁用于生产环境。
• 无官方支持：该镜像为基础示例，不提供官方技术支持。
• 风险提示：使用本镜像需自行承担风险，建议仅在隔离的非生产环境中使用。

2. 核心功能与特性

基于镜像内置的应用配置（如下代码所示），提供以下核心能力：

java
@Configuration
@EnableDiscoveryClient  // 启用服务发现
@EnableScheduling       // 启用定时任务
@EnableAdminServer      // 启用 Spring Boot Admin 服务
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

2.1 核心功能

• Spring Boot 应用监控：支持监控 Spring Boot 应用的健康状态、指标数据（如内存、CPU 使用率）、环境变量、日志配置等基础信息。
• 服务自动发现：通过 @EnableDiscoveryClient 实现对注册到服务发现中心的 Spring Boot 应用的自动发现与管理。
• 定时任务支持：通过 @EnableScheduling 支持定时任务调度，可用于周期性检查应用状态或执行管理操作。

3. 使用场景与适用范围

3.1 适用场景

• 开发环境：本地开发时快速搭建 Spring Boot 应用监控环境。
• 演示环境：用于展示 Spring Boot Admin 功能的基础用法。
• 测试环境：在非生产测试环境中验证应用监控流程。

3.2 不适用场景

• 生产环境：缺乏安全加固、高可用设计及性能优化，无法满足生产级稳定性要求。
• 关键业务系统：不提供官方支持，故障恢复能力不足，可能导致业务中断。
• 高可用性要求场景：未实现集群部署或故障转移机制，无法保障服务持续可用。

4. 使用方法与配置说明

4.1 前提条件

• 已安装 Docker Engine（20.10+ 版本推荐）。
• （可选）Docker Compose（用于多容器管理）。

4.2 运行容器

4.2.1 基础运行命令（docker run）

通过以下命令启动容器，默认暴露 8080 端口（Spring Boot 默认端口）：

bash
docker run -d \
  --name spring-boot-admin \
  -p 8080:8080 \
  <镜像名称>:<标签>  # 替换为实际镜像名称和标签（如 codecentric/spring-boot-admin:latest）

4.2.2 Docker Compose 配置示例

创建 docker-compose.yml 文件，定义服务配置：

yaml
version: '3.8'
services:
  spring-boot-admin:
    image: <镜像名称>:<标签>  # 替换为实际镜像名称和标签
    container_name: spring-boot-admin
    ports:
      - "8080:8080"  # 映射容器端口到主机
    volumes:
      - ./conf:/usr/share/codecentric/conf  # 挂载自定义配置目录（可选）
    restart: unless-stopped  # 非生产环境建议使用，生产环境不推荐

启动服务：

bash
docker-compose up -d

4.3 配置说明

4.3.1 默认配置

镜像内置基础配置，覆盖 Spring Boot Admin 核心功能（如监控端点启用、服务发现等），默认配置文件路径为 /usr/share/codecentric/conf/application.yml（或 .properties）。

4.3.2 自定义配置

通过挂载本地配置文件覆盖默认配置，支持 .yml 或 .properties 格式：

1. 创建本地配置文件（如 application.yml）：

   yaml
   # 示例：自定义服务端口、日志级别
   server:
     port: 8081  # 修改 Admin Server 端口
   logging:
     level:
       root: INFO  # 调整日志级别
   spring:
     boot:
       admin:
         monitor:
           period: 10000  # 监控检查周期（毫秒）
   

2. 挂载配置文件到容器：

   • 使用 docker run 命令时：

     bash
     docker run -d \
       --name spring-boot-admin \
       -p 8081:8081 \  # 匹配自定义端口
       -v /path/to/local/conf:/usr/share/codecentric/conf \  # 本地配置目录挂载到容器
       <镜像名称>:<标签>
     

   • 使用 Docker Compose 时，在 volumes 中添加挂载配置（见 4.2.2 示例）。

5. 注意事项

• 非生产环境限制：严禁用于生产环境，可能存在安全漏洞、性能瓶颈及功能缺失。
• 配置权限：挂载本地配置文件时，确保文件权限允许容器内进程读取（建议设置文件权限为 644）。
• 无官方支持：镜像问题需自行排查，无官方技术支持渠道。
• 服务发现依赖：若需启用服务自动发现，需确保环境中存在服务注册中心（如 Eureka、Consul），并在配置中指定注册中心地址。