实战使用HarborAPI批量删除镜像：高效管理镜像仓库的指南

在容器化部署日益普及的今天，Harbor作为一款开源的企业级Registry服务器，提供了强大的镜像管理功能。然而，随着项目的不断迭代和镜像的频繁更新，镜像仓库中往往会积累大量无用或过时的镜像，占用宝贵的存储空间。手动逐个删除这些镜像不仅效率低下，还容易出错。本文将详细介绍如何通过Harbor API实现批量删除镜像的实战操作，帮助开发者高效管理镜像仓库。

一、Harbor API概述

Harbor API是Harbor提供的一套RESTful API接口，允许开发者通过编程方式与Harbor服务器进行交互，实现镜像的上传、下载、查询、删除等操作。利用Harbor API，我们可以编写脚本或程序，自动化完成批量删除镜像的任务，极大地提高工作效率。

二、准备工作

1. 获取Harbor API访问权限

在使用Harbor API之前，首先需要确保有足够的权限进行镜像删除操作。通常，这需要管理员权限或具有相应项目删除权限的用户账号。

2. 了解Harbor API基本结构

Harbor API的URL通常遵循以下格式：https://<harbor-server>/api/v2.0/<resource>，其中<harbor-server>是Harbor服务器的地址，<resource>表示要操作的资源类型，如projects、repositories、artifacts等。

3. 准备开发环境

为了调用Harbor API，我们需要一个能够发送HTTP请求的环境。这可以是任何编程语言，如Python、Java、Go等，或者使用命令行工具如curl。本文以Python为例，展示如何通过requests库调用Harbor API。

三、实战步骤

1. 查询需要删除的镜像

在批量删除之前，首先需要确定哪些镜像需要被删除。这可以通过Harbor的Web界面手动筛选，或者通过API查询获取镜像列表。以下是一个使用Python查询特定项目下所有镜像的示例：

import requests
# Harbor服务器地址和API版本
HARBOR_URL = "https://your-harbor-server"
API_VERSION = "v2.0"
# 项目名称
PROJECT_NAME = "your-project-name"
# 获取项目ID（假设已知或通过其他API获取）
# 这里简化处理，实际中可能需要先调用获取项目列表的API
PROJECT_ID = "your-project-id"
# 认证信息
AUTH = ("username", "password")
# 查询项目下所有仓库
REPOS_URL = f"{HARBOR_URL}/api/{API_VERSION}/projects/{PROJECT_ID}/repositories"
response = requests.get(REPOS_URL, auth=AUTH, verify=False)  # verify=False仅用于示例，生产环境应启用SSL验证
repos = response.json()
# 遍历仓库，查询每个仓库下的镜像
for repo in repos:
    REPO_NAME = repo["name"]
    ARTIFACTS_URL = f"{HARBOR_URL}/api/{API_VERSION}/projects/{PROJECT_ID}/repositories/{REPO_NAME}/artifacts"
    artifacts_response = requests.get(ARTIFACTS_URL, auth=AUTH, verify=False)
    artifacts = artifacts_response.json()
    # 这里可以添加逻辑来筛选需要删除的镜像，如按标签、创建时间等
    # 示例中仅打印镜像信息
    for artifact in artifacts:
        print(f"Repository: {REPO_NAME}, Tag: {artifact['tags'][0]['name'] if artifact['tags'] else 'No tag'}")

2. 批量删除镜像

确定了需要删除的镜像后，接下来就是通过API进行批量删除。以下是一个删除特定镜像的示例：

# 假设已经确定了要删除的镜像的repository和tag
REPO_TO_DELETE = "library/nginx"
TAG_TO_DELETE = "1.21-alpine"
# 构建删除镜像的URL
DELETE_URL = f"{HARBOR_URL}/api/{API_VERSION}/projects/{PROJECT_ID}/repositories/{REPO_TO_DELETE}/artifacts/{TAG_TO_DELETE}"
# 发送DELETE请求删除镜像
delete_response = requests.delete(DELETE_URL, auth=AUTH, verify=False)
if delete_response.status_code == 200:
    print(f"Successfully deleted {REPO_TO_DELETE}:{TAG_TO_DELETE}")
else:
    print(f"Failed to delete {REPO_TO_DELETE}:{TAG_TO_DELETE}, status code: {delete_response.status_code}")

3. 自动化批量删除脚本

为了更高效地批量删除镜像，我们可以将上述查询和删除逻辑整合到一个脚本中，通过参数化输入来指定删除条件，如项目名称、镜像名称模式、标签模式等。以下是一个简化的自动化批量删除脚本框架：

import requests
import re
def delete_images_by_pattern(project_id, repo_pattern, tag_pattern):
    # 查询项目下所有仓库
    REPOS_URL = f"{HARBOR_URL}/api/{API_VERSION}/projects/{project_id}/repositories"
    response = requests.get(REPOS_URL, auth=AUTH, verify=False)
    repos = response.json()
    deleted_count = 0
    for repo in repos:
        repo_name = repo["name"]
        if re.match(repo_pattern, repo_name):
            ARTIFACTS_URL = f"{HARBOR_URL}/api/{API_VERSION}/projects/{project_id}/repositories/{repo_name}/artifacts"
            artifacts_response = requests.get(ARTIFACTS_URL, auth=AUTH, verify=False)
            artifacts = artifacts_response.json()
            for artifact in artifacts:
                if artifact['tags']:
                    for tag in artifact['tags']:
                        if re.match(tag_pattern, tag['name']):
                            DELETE_URL = f"{HARBOR_URL}/api/{API_VERSION}/projects/{project_id}/repositories/{repo_name}/artifacts/{tag['name']}"
                            delete_response = requests.delete(DELETE_URL, auth=AUTH, verify=False)
                            if delete_response.status_code == 200:
                                print(f"Deleted {repo_name}:{tag['name']}")
                                deleted_count += 1
                            else:
                                print(f"Failed to delete {repo_name}:{tag['name']}, status code: {delete_response.status_code}")
    print(f"Total deleted images: {deleted_count}")
# 使用示例
PROJECT_ID = "your-project-id"
REPO_PATTERN = r"library/.*"  # 匹配library下的所有镜像
TAG_PATTERN = r"old-.*"  # 匹配标签以old-开头的镜像
delete_images_by_pattern(PROJECT_ID, REPO_PATTERN, TAG_PATTERN)

四、安全注意事项

认证与授权：确保使用具有足够权限的账号进行API调用，避免泄露敏感信息。
SSL验证：在生产环境中，务必启用SSL验证，避免中间人攻击。
备份数据：在执行批量删除操作前，建议备份重要数据，以防误删。
日志记录：记录所有API调用和删除操作，便于审计和故障排查。

五、总结

通过Harbor API实现批量删除镜像，可以显著提高镜像管理的效率，减少手动操作的错误和耗时。本文介绍了Harbor API的基本结构、查询和删除镜像的方法，以及一个简化的自动化批量删除脚本框架。希望这些内容能帮助开发者更好地管理Harbor镜像仓库，提升工作效率。

HarborAPI实战：高效批量删除镜像指南