开源项目 `public-image-mirror` 使用教程

开源项目 public-image-mirror 使用教程

public-image-mirror很多镜像都在国外。比如 gcr 。国内下载很慢，需要加速。项目地址:https://gitcode.com/gh_mirrors/pu/public-image-mirror

1. 项目的目录结构及介绍

public-image-mirror/
├── LICENSE
├── README.md
├── allows.txt
├── domain.txt
├── exclude.txt
├── mirror.txt
├── privileged.txt
├── editorconfig
├── gitignore
├── pyproject.toml
├── poetry.lock
├── setup.cfg
└── ecr_mirror/
    ├── __init__.py
    ├── cli.py
    ├── config.py
    ├── sync.py
    └── utils.py

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• allows.txt, domain.txt, exclude.txt, mirror.txt, privileged.txt: 配置文件，用于定义镜像同步的规则和策略。
• editorconfig, gitignore: 编辑器配置和版本控制忽略文件。
• pyproject.toml, poetry.lock: 项目依赖管理文件。
• setup.cfg: 项目配置文件。
• ecr_mirror/: 项目主要代码目录，包含多个 Python 模块。

2. 项目的启动文件介绍

项目的启动文件是 ecr_mirror/cli.py，这是一个命令行接口文件，用于启动和管理镜像同步任务。

# ecr_mirror/cli.py
import click
from ecr_mirror.config import Config
from ecr_mirror.sync import Sync

@click.group()
@click.option('--registry-id', type=str, help='The registry ID')
@click.option('--role-arn', type=str, help='Assume a specific role to push to AWS')
@click.option('--override-os', type=str, default='linux', help='Specify the OS of images')
@click.option('--override-arch', type=str, default='amd64', help='Specify the ARCH of images')
@click.pass_context
def cli(ctx, registry_id, role_arn, override_os, override_arch):
    ctx.ensure_object(dict)
    ctx.obj['config'] = Config(registry_id, role_arn, override_os, override_arch)

@cli.command()
@click.pass_context
def sync(ctx):
    config = ctx.obj['config']
    sync = Sync(config)
    sync.run()

if __name__ == '__main__':
    cli(obj={})

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个：

• pyproject.toml: 定义项目依赖和构建工具的配置。
• setup.cfg: 项目的基本配置文件，包括包的元数据和安装选项。
• allows.txt, domain.txt, exclude.txt, mirror.txt, privileged.txt: 这些文件定义了镜像同步的具体规则，例如允许同步的镜像、排除的镜像、镜像的域名等。

# pyproject.toml
[tool.poetry]
name = "ecr-mirror"
version = "0.1.0"
description = "Mirror public docker images to ECR automagically"
authors = ["DaoCloud"]

[tool.poetry.dependencies]
python = "^3.8"
click = "^7.0"
boto3 = "^1.17.0"

[tool.poetry.dev-dependencies]
pytest = "^6.2.2"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

# setup.cfg
[metadata]
name = ecr-mirror
version = 0.1.0
description = Mirror public docker images to ECR automagically
author = DaoCloud
license = Apache-2.0

[options]
packages = find:
install_requires =
    click>=7.0
    boto3>=1.17.0

[options.packages.find]
where = .

以上是 public-image-mirror 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

public-image-mirror很多镜像都在国外。比如 gcr 。国内下载很慢，需要加速。项目地址:https://gitcode.com/gh_mirrors/pu/public-image-mirror