augugrumi/harbor

Harbor

镜像概述和主要用途

Harbor是一个用Java编写的后端服务，核心功能是在Kubernetes集群中启动YAML定义的部署。它提供简单的配置方式，支持自定义端口、Kubernetes API地址及YAML存储路径，帮助用户简化在K8s集群中部署容器化应用的流程。

核心功能和特性

• YAML部署支持：能够解析并启动Kubernetes YAML定义的部署
• 灵活配置：支持通过命令行参数或环境变量自定义端口、配置文件路径、K8s API URL及存储路径
• 轻量部署：提供Docker镜像，支持容器化部署，便于集成到现有工作流
• 文档支持：可通过Maven生成Javadoc，便于开发和维护

使用场景和适用范围

• 开发环境中快速部署K8s YAML定义的应用
• 简化Kubernetes集群中应用部署的流程
• 需要自定义部署参数（如端口、API地址）的场景
• 作为后端服务集成到CI/CD pipeline中，实现自动化部署

使用方法和配置说明

Docker镜像拉取

bash
docker pull augugrumi/harbor

基本运行示例

bash
# 默认配置运行（端口80，使用默认API定义）
docker run --rm -p 80:80 augugrumi/harbor

# 自定义端口运行
docker run --rm -p 57684:80 augugrumi/harbor

环境变量配置

通过环境变量可自定义Harbor的行为，对应命令行参数：

带环境变量的运行示例

bash
docker run --rm \
  -p 57684:57684 \
  -e HARBOR_PORT=57684 \
  -e HARBOR_KUBERNETES_URL=https://k8s-api.example.com \
  -e HARBOR_STORAGE_PATH=/data/harbor/yaml \
  -v /local/path/to/config.json:/app/config.json \
  -e HARBOR_API_CONFIG=/app/config.json \
  augugrumi/harbor

构建自定义Docker镜像

项目使用多阶段构建，构建步骤如下：

bash
# 克隆项目
git clone https://github.com/Augugrumi/harbor.git && cd harbor

# 构建镜像
docker build -t <your-nickname>/harbor .

文档生成

可通过Maven生成Javadoc文档：

bash
# 克隆项目
git clone https://github.com/Augugrumi/harbor.git && cd harbor

# 生成Javadoc
mvn javadoc:javadoc

生成的文档位于 ./target/site/apidocs 目录。

许可证

本软件采用GPLv3+许可证。