davradocker/ruban-ms-microservice-manager

K8s后台服务创建工具镜像

镜像概述和主要用途

本镜像是一款面向应用开发者的工具，旨在简化在Kubernetes（K8s）集群中创建和部署后台服务的流程。通过自动化生成Kubernetes资源配置、集成常用部署工具及简化配置步骤，帮助开发者快速将后台服务（如API服务、定时任务、消息处理服务等）部署到K8s环境，减少手动编写K8s配置文件的复杂度，提升开发效率。

核心功能和特性

核心功能

• 自动生成K8s资源配置：支持自动生成Deployment、Service、ConfigMap等核心K8s资源配置文件，无需手动编写YAML/JSON。
• 多服务类型支持：适配无状态服务（Deployment）、定时任务（CronJob）、事件驱动服务（Job）等多种后台服务类型。
• 配置简化：通过环境变量或配置文件定义服务参数，自动映射为K8s资源属性（如副本数、端口、镜像版本等）。
• 快速部署集成：生成的配置可直接通过kubectl应用到K8s集群，支持一键部署和版本回滚。
• 常用工具集成：内置日志采集（对接ELK）、健康检查、资源监控（Prometheus）配置模板。

关键特性

• 低学习成本：无需深入掌握K8s语法，开发者通过简单参数即可生成生产级配置。
• 多语言支持：兼容Java、Go、Python等主流后端语言的服务部署需求。
• 可扩展性：支持自定义K8s资源模板，适配复杂业务场景。
• 轻量级：镜像体积小（基于Alpine），启动速度快，资源占用低。

使用场景和适用范围

适用场景

• 后端应用开发者：快速将本地开发的后台服务部署到K8s集群，无需手动编写K8s配置。
• 微服务架构：在微服务项目中，自动化生成各服务的K8s资源配置，统一管理服务依赖和网络策略。
• CI/CD流程集成：作为CI/CD pipeline的中间步骤，在代码构建完成后自动生成部署配置并推送到K8s集群。
• 开发测试环境：快速搭建临时后台服务（如数据处理服务、测试用API），支持一键清理资源。
• 定时/事件驱动服务：简化定时任务（如日志归档）、事件处理（如消息队列消费）等后台服务的K8s配置。

适用范围

• 需部署到K8s集群的后台应用开发者（后端、DevOps）。
• 微服务架构或分布式系统的服务部署场景。
• 中小型团队（减少K8s配置的人力成本）。
• 开发/测试/生产环境的后台服务快速交付需求。

详细使用方法和配置说明

前提条件

• 已安装Docker Engine（20.10+）。
• 已配置Kubernetes集群（1.21+），且本地kubectl可连接集群（kubectl config view验证）。
• 本地用户具备K8s集群的部署权限（如edit或admin角色）。

镜像获取

bash
docker pull k8s-bg-service-creator:latest

基本使用流程

1. 生成K8s资源配置

通过docker run命令启动容器，传入服务参数，自动生成K8s配置文件并输出到本地目录。

示例：生成无状态后台服务配置

bash
docker run -it --rm \
  -v $(pwd)/k8s-config:/output \  # 挂载本地目录接收输出配置
  -e SERVICE_NAME="user-api" \    # 服务名称
  -e SERVICE_TYPE="deployment" \  # 服务类型（deployment/cronjob/job）
  -e REPLICAS=2 \                 # 副本数
  -e IMAGE="myapp/user-api:v1.0" \# 服务镜像
  -e PORT=8080 \                  # 服务端口
  k8s-bg-service-creator:latest

执行后，本地./k8s-config目录将生成deployment.yaml和service.yaml文件。

2. 部署到K8s集群

使用生成的配置文件部署服务：

bash
kubectl apply -f ./k8s-config/

验证部署：

bash
kubectl get deployments user-api  # 查看Deployment状态
kubectl get pods -l app=user-api  # 查看Pod状态
kubectl get service user-api      # 查看Service暴露的端口

高级配置

环境变量参数说明

配置文件示例（高级自定义）

若需复杂配置（如资源限制、环境变量注入、挂载卷），可通过挂载配置文件config.yaml实现：

yaml
# config.yaml 示例
service:
  name: "payment-processor"
  type: "deployment"
  replicas: 2
container:
  image: "myapp/payment:v2.1"
  port: 8080
  command: ["java", "-jar", "/app/payment.jar"]
  resources:  # 资源限制
    limits:
      cpu: "1"
      memory: "1Gi"
    requests:
      cpu: "500m"
      memory: "512Mi"
  env:
    - name: "DB_HOST"
      value: "mysql-service"
    - name: "DB_PORT"
      value: "3306"
  volumes:
    - name: "config-volume"
      configMap:
        name: "payment-config"
  volumeMounts:
    - name: "config-volume"
      mountPath: "/app/config"
monitoring:
  enabled: true
  port: 9090
  path: "/metrics"

启动容器时挂载配置文件：

bash
docker run -it --rm \
  -v $(pwd)/config.yaml:/app/config.yaml \
  -v $(pwd)/k8s-config:/output \
  k8s-bg-service-creator:latest --config /app/config.yaml

部署到K8s的完整示例

1. 生成定时任务服务配置

bash
docker run -it --rm \
  -v $(pwd)/k8s-config:/output \
  -e SERVICE_NAME="log-cleaner" \
  -e SERVICE_TYPE="cronjob" \
  -e IMAGE="myapp/log-cleaner:v1.2" \
  -e COMMAND="/clean.sh --days=7" \
  -e CRON_SCHEDULE="0 0 * * *" \  # 每天0点执行
  -e LOG_LEVEL="info" \
  k8s-bg-service-creator:latest

2. 应用配置到K8s

bash
kubectl apply -f ./k8s-config/cronjob.yaml

3. 验证定时任务

bash
kubectl get cronjobs log-cleaner  # 查看CronJob状态
kubectl get jobs --selector=app=log-cleaner  # 查看历史任务

注意事项

• 生成的K8s配置文件需根据实际集群环境（如网络插件、存储类）调整细节。
• 生产环境建议通过CI/CD流水线集成本工具，避免手动执行docker run。
• 定时任务（CronJob）需确保集群支持CronJob资源（K8s 1.21+默认启用）。
• 启用监控（ENABLE_MONITORING=true）时，需确保集群已部署Prometheus Operator。