artifacthub/db-migrator

Kubernetes包管理工具镜像文档

一、镜像概述和主要用途

本镜像是一个轻量级的Kubernetes包管理工具，专注于提供查找（Find）、安装（Install）和发布（Publish）Kubernetes包的全流程能力。它旨在简化Kubernetes集群中应用、资源或配置包的管理流程，支持用户快速定位、部署和共享Kubernetes生态中的各类包资源（如Helm Chart、Kustomize包、Operator等），适用于开发、测试及生产环境的Kubernetes包生命周期管理。

二、核心功能和特性

2.1 核心功能

• 包查找：支持从指定仓库搜索Kubernetes包，提供关键词搜索、标签过滤、版本排序等能力。
• 包安装：一键安装Kubernetes包至目标集群，支持版本选择、配置自定义（如参数覆盖、资源限制调整）及依赖解析。
• 包发布：将本地Kubernetes包（如Helm Chart、Kustomize目录）打包并推送至远程仓库，支持元数据校验和版本自动递增。
• 版本管理：跟踪已安装包的版本历史，支持版本回滚、升级及冲突检测。

2.2 关键特性

• 跨平台兼容：支持Linux/Windows/macOS Docker环境。
• 集群集成：无缝对接Kubernetes集群（通过kubeconfig认证）。
• 仓库适配：兼容主流包仓库（如Helm Hub、OCI镜像仓库、私有Git仓库）。
• 轻量级设计：基于Alpine构建，镜像体积<50MB。
• 配置灵活：支持命令行参数、环境变量及配置文件三种配置方式。

三、使用场景和适用范围

3.1 典型使用场景

• Kubernetes应用部署：快速查找并安装社区或私有仓库中的应用包（如数据库、中间件）。
• 多环境包同步：在开发、测试、生产环境间同步标准化包版本，确保环境一致性。
• 团队内部包共享：将自定义Kubernetes资源包（如微服务部署模板）发布至团队私有仓库，实现共享复用。
• CI/CD流程集成：作为CI/CD流水线的中间件，自动发布构建产物（如Helm Chart）至仓库，或从仓库拉取指定包进行部署验证。

3.2 适用范围

• 开发者：本地调试Kubernetes包安装流程。
• 运维人员：批量管理集群中的应用包版本。
• 团队/企业：构建内部Kubernetes包管理体系，规范资源交付流程。

四、使用方法和配置说明

4.1 前提条件

• 已安装Docker Engine（20.10+）。
• 目标Kubernetes集群（1.21+），且本地或容器内可通过kubeconfig访问（需挂载宿主机kubeconfig文件）。
• 若使用私有仓库，需提前准备仓库访问凭证（如Token、用户名/密码）。

4.2 获取镜像

通过Docker Hub或私有仓库拉取镜像：

bash
docker pull [镜像仓库地址]/k8s-package-manager:latest
# 示例（假设官方仓库）：docker pull k8spkgmgr/k8s-package-manager:latest

4.3 基本使用示例

4.3.1 查找Kubernetes包

搜索仓库中关键词为“nginx”的包：

bash
docker run --rm \
  -v $HOME/.kube/config:/root/.kube/config:ro \  # 挂载kubeconfig（可选，若需集群验证）
  -e PACKAGE_REPO="https://charts.helm.sh/stable" \  # 指定包仓库地址
  k8spkgmgr/k8s-package-manager:latest \
  find --search "nginx" --filter "type=helm-chart"

4.3.2 安装Kubernetes包

安装指定版本的“nginx”包至Kubernetes集群：

bash
docker run --rm \
  -v $HOME/.kube/config:/root/.kube/config:ro \  # 挂载kubeconfig以访问集群
  -e PACKAGE_REPO="https://charts.helm.sh/stable" \
  -e KUBECONFIG="/root/.kube/config" \  # 指定kubeconfig路径
  k8spkgmgr/k8s-package-manager:latest \
  install --name "nginx" --version "1.23.0" --namespace "default" \
  --set "service.type=NodePort"  # 自定义安装参数

4.3.3 发布Kubernetes包

将本地Helm Chart打包并推送到私有仓库：

bash
docker run --rm \
  -v $HOME/my-chart:/chart \  # 挂载本地包目录
  -v $HOME/.kube/config:/root/.kube/config:ro \
  -e PACKAGE_REPO="https://my-private-repo.example.com" \
  -e AUTH_TOKEN="xxxxx" \  # 仓库认证令牌
  k8spkgmgr/k8s-package-manager:latest \
  publish --path "/chart" --version "1.0.0" --description "My custom nginx chart"

4.4 docker-compose配置示例

通过docker-compose.yml简化多命令场景配置：

yaml
version: "3.8"
services:
  k8s-pkg-manager:
    image: k8spkgmgr/k8s-package-manager:latest
    volumes:
      - $HOME/.kube/config:/root/.kube/config:ro  # 挂载kubeconfig
      - ./local-packages:/packages  # 本地包存储目录
    environment:
      - PACKAGE_REPO=https://my-private-repo.example.com  # 默认包仓库
      - KUBECONFIG=/root/.kube/config  # kubeconfig路径
      - AUTH_TOKEN=${REPO_TOKEN}  # 从环境变量注入认证令牌
    command: ["--help"]  # 默认命令（可替换为find/install/publish）

启动方式：

bash
REPO_TOKEN="xxxxx" docker-compose up

五、配置参数和环境变量

5.1 命令行参数

5.2 环境变量

六、注意事项

1. 集群访问权限：容器需通过挂载kubeconfig或配置KUBECONFIG环境变量获取Kubernetes集群访问权限。
2. 仓库认证：私有仓库需通过AUTH_TOKEN或挂载认证文件（如.netrc）提供凭证。
3. 版本兼容性：安装包时需确保包版本与目标Kubernetes集群版本兼容（可通过--version指定兼容版本）。
4. 本地包目录权限：挂载本地目录时需确保容器内用户（默认root）有读写权限。