开源项目 `container-retention-policy` 使用教程

1. 项目介绍

container-retention-policy 是一个用于管理 GitHub Container Registry (GHCR) 中旧容器镜像版本的工具。该项目通过自动化流程，帮助用户定期清理不再需要的容器镜像，从而节省存储空间并保持环境整洁。

2. 项目快速启动

安装

首先，确保你已经安装了 pip，然后使用以下命令安装 container-retention-policy：

pip install container-retention-policy

配置

在项目根目录下创建一个配置文件 config.yaml，内容如下：

registry: ghcr.io
repository: your-username/your-repo
token: your-github-token
retention:
  days: 30
  keep: 5

运行

使用以下命令运行清理脚本：

container-retention-policy --config config.yaml

3. 应用案例和最佳实践

应用案例

假设你是一个持续集成/持续部署 (CI/CD) 流程的维护者，定期发布新的容器镜像版本。为了防止存储空间被无限制占用，你可以使用 container-retention-policy 定期清理旧版本。

最佳实践

1. 定期执行：建议将清理任务添加到 CI/CD 流程中，定期执行。
2. 保留策略：根据项目需求设置合理的保留天数和保留版本数量。
3. 安全性：确保 GitHub Token 的安全性，避免泄露。

4. 典型生态项目

GitHub Actions

container-retention-policy 可以与 GitHub Actions 结合使用，实现自动化清理。以下是一个示例 GitHub Actions 配置：

name: Container Retention
on:
  schedule:
    - cron: '0 0 * * *'
jobs:
  cleanup:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v2
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: 3.8
    - name: Install dependencies
      run: pip install container-retention-policy
    - name: Run container retention policy
      run: container-retention-policy --config config.yaml
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

通过以上配置，你可以定期清理旧的容器镜像版本，保持环境整洁。