amazon-ecr-credential-helper

amazon-ecr-credential-helper

Docker 凭证助手自动完成 Amazon ECR 认证

Amazon ECR Docker Credential Helper 是 Docker 守护进程的凭证助手,自动化 Amazon Elastic Container Registry (ECR) 的认证流程。它支持包管理器安装和源码编译,无需手动登录即可获取 ECR 凭证。该工具兼容多种 AWS 凭证存储方式,适用于公有和私有 ECR 仓库。通过灵活配置和故障排除功能,为 Docker 用户提供了便捷的 ECR 访问体验。

Amazon ECRDocker凭证助手AWS容器注册表Github开源项目

Amazon ECR Docker 凭证助手

Amazon ECR 标志

构建 Go 报告卡 最新打包版本

Amazon ECR Docker 凭证助手是 Docker 守护程序的凭证助手,它使得使用Amazon Elastic Container Registry变得更加容易。

目录

先决条件

您的系统必须安装至少 Docker 1.11 版本。

您还必须有可用的 AWS 凭证。有关如何使用不同的 AWS 凭证的详细信息,请参阅 AWS 凭证部分

安装

Amazon Linux 2023 (AL2023)

您可以从 Amazon Linux 2023 存储库安装 Amazon ECR 凭证助手。

$ sudo dnf install -y amazon-ecr-credential-helper

安装凭证助手后,请参阅配置部分以了解如何配置 Docker 以使用该助手的说明。

Amazon Linux 2 (AL2)

您可以从 dockerecs extras 安装 Amazon ECR 凭证助手。

$ sudo amazon-linux-extras enable docker $ sudo yum install amazon-ecr-credential-helper

安装凭证助手后,请参阅配置部分以了解如何配置 Docker 以使用该助手的说明。

Mac OS

核心 tap 中提供了一个社区维护的 Homebrew 公式。

Homebrew 包

$ brew install docker-credential-helper-ecr

在 macOS 上,另一个社区维护的安装方法是使用 MacPorts。

MacPorts 包

$ sudo port install docker-credential-helper-ecr

安装凭证助手后,请参阅配置部分以了解如何配置 Docker 以使用该助手的说明。

Debian Buster(及未来版本)

您可以从 Debian Buster 存档安装 Amazon ECR 凭证助手。此包也将包含在未来的 Debian 版本中。

Debian 10 包 Debian 11 包 Debian 12 包 Debian 不稳定版包

$ sudo apt update $ sudo apt install amazon-ecr-credential-helper

安装凭证助手后,请参阅配置部分以了解如何配置 Docker 以使用该助手的说明。

Ubuntu 19.04 Disco Dingo 及更新版本

您可以从 Ubuntu 19.04 Disco Dingo(及更新版本)存档安装 Amazon ECR 凭证助手。

Ubuntu 20.04 包 Ubuntu 22.04 包

$ sudo apt update $ sudo apt install amazon-ecr-credential-helper

安装凭证助手后,请参阅配置部分以了解如何配置 Docker 以使用该助手的说明。

Arch Linux

Arch 用户仓库中提供了一个社区维护的包。

AUR 包

$ git clone https://aur.archlinux.org/amazon-ecr-credential-helper.git $ cd amazon-ecr-credential-helper $ makepkg -si

安装凭证助手后,请参阅配置部分以了解如何配置 Docker 以使用该助手的说明。

Alpine Linux

Alpine Linux aports 仓库中提供了一个社区维护的包。

Alpine Linux Edge 包

$ apk add docker-credential-ecr-login

[!注意] 徽章仅显示 edge 版本,请查看仓库以获取稳定版本或添加 --repository=http://dl-cdn.alpinelinux.org/alpine/edge/community

安装凭证助手后,请参阅配置部分以了解如何配置 Docker 以使用该助手的说明。

Windows

Windows 可执行文件可通过 GitHub 发布获取。

[!注意] Windows ARM 支持被视为实验性功能

请参阅 https://github.com/awslabs/amazon-ecr-credential-helper/issues/795

从源代码构建

要构建和安装Amazon ECR Docker凭证助手,我们建议您的系统安装Go 1.19或更高版本、gitmake

如果您刚刚安装了Go,请确保将其添加到PATH或环境变量(Windows)中。例如:

$ export GOPATH=$HOME/go
$ export PATH=$PATH:$GOPATH/bin

或在Windows中:

setx GOPATH %USERPROFILE%\go
<您现有的PATH定义>;%USERPROFILE%\go\bin

如果您没有定义PATH,下面的命令将会静默失败,运行docker-credential-ecr-login将输出:command not found

您可以通过go命令行工具安装它。

运行以下命令安装:

go install github.com/awslabs/amazon-ecr-credential-helper/ecr-login/cli/docker-credential-ecr-login@latest

[!警告] 免责声明:此存储库中的Dockerfile用于在GitHub Actions CI中测试Amazon ECR凭证助手二进制文件的交叉编译,并作为开发人员从源代码本地构建的实用工具。 它是一个参考实现,不适用于构建和运行生产容器的安全强化。

如果您已经有Docker环境,只需在任何地方克隆此存储库并运行make build-in-docker。此命令使用Docker容器内的Go构建二进制文件,并将其输出到本地目录。

通过设置TARGET_GOOS环境变量,您还可以交叉编译二进制文件。

安装凭证助手后,请参阅配置部分,了解如何配置Docker以使用该助手的说明。

配置

Docker

无需使用docker logindocker logout

docker-credential-ecr-login二进制文件放在您的PATH上,并将~/.docker/config.json文件的内容设置为:

{ "credsStore": "ecr-login" }

这将配置Docker守护程序为所有Amazon ECR注册表使用凭证助手。

Amazon ECR Docker凭证助手可以与您现有的docker登录认证令牌一起使用:

{ "credsStore": "ecr-login", "auths": { "https://index.docker.io/v1/": { "auth": [docker.io-auth-token] }, "registry.gitlab.com": { "auth": [gitlab-auth-token] }, } }

使用Docker 1.13.0或更高版本,您可以为不同的ECR注册表配置不同的凭证助手。要为特定的ECR注册表使用此凭证助手,请创建一个credHelpers部分,包含ECR注册表的URI:

{ "credHelpers": { "public.ecr.aws": "ecr-login", "<aws_account_id>.dkr.ecr.<region>.amazonaws.com": "ecr-login" } }

如果您使用docker操作使用不同身份验证凭证的注册表,这将非常有用。

AWS凭证

Amazon ECR Docker凭证助手允许您使用存储在不同位置的AWS凭证。标准位置包括:

要使用共享凭证文件(~/.aws/credentials)中与不同命名配置文件相关联的凭证,您可以设置AWS_PROFILE环境变量。

Amazon ECR Docker凭证助手读取并支持AWS共享配置文件(~/.aws/config)中指定的一些配置选项。要禁用这些选项,您必须将AWS_SDK_LOAD_CONFIG环境变量设置为false。支持的选项包括:

  • 使用role_arnsource_profile指定的假定角色
  • 使用credential_process指定的外部凭证进程
  • Web身份,如Kubernetes中的IAM角色服务账户注:使用非root用户容器的Kubernetes用户可能会遇到此bug中描述的权限问题,可能需要通过调整Kubernetes securityContext来采取解决方案。

Amazon ECR Docker凭证助手使用与AWS CLI和AWS SDK相同的凭证。有关配置AWS凭证的更多信息,请参阅AWS Command Line Interface用户指南中的配置和凭证文件

凭证必须应用允许访问Amazon ECR的策略。

Amazon ECR Docker凭证助手

环境变量示例值描述
AWS_ECR_DISABLE_CACHEtrue如果设置为非空值,则禁用本地文件身份验证缓存
AWS_ECR_CACHE_DIR~/.ecr指定本地文件身份验证缓存目录位置
AWS_ECR_IGNORE_CREDS_STORAGEtrue忽略对docker登录或注销的调用,并假装它们成功

使用方法

docker pull 123456789012.dkr.ecr.us-west-2.amazonaws.com/my-repository:my-tag

docker push 123456789012.dkr.ecr.us-west-2.amazonaws.com/my-repository:my-tag

docker pull public.ecr.aws/amazonlinux/amazonlinux:latest

如果您已为AWS CLI配置了其他配置文件,可以在调用docker时通过指定AWS_PROFILE环境变量来使用这些配置文件。 例如:

AWS_PROFILE=myprofile docker pull 123456789012.dkr.ecr.us-west-2.amazonaws.com/my-repository:my-tag

无需使用docker logindocker logout

故障排除

如果您之前通过手动使用docker login命令对ECR存储库进行过身份验证, 那么Docker可能已经存储了一个已过期的身份验证令牌。 Docker将继续尝试使用该缓存的身份验证令牌, 而不是利用凭证助手。您必须使用docker logout 123456789012.dkr.ecr.us-west-2.amazonaws.com/my-repository显式删除先前缓存的过期令牌。之后, Docker将开始利用ECR凭证助手获取新的凭证,您将不再需要使用docker logindocker logout

Amazon ECR Docker凭证助手的日志存储在~/.ecr/log中。

有关Amazon ECR的更多信息,请参阅Amazon Elastic Container Registry用户指南

实验性功能

标记为实验性的功能可选择提供给用户进行测试和提供反馈。

如果您测试任何实验性功能,可以通过功能的跟踪问题提供反馈,包括:

  • 您使用该功能的体验
  • 问题或困难
  • 改进建议

实验性功能在设计和实现上尚不完整。可能随时引入向后不兼容的更改或完全停止支持。因此,不建议在生产环境中使用实验性功能。

安全披露

如果您认为发现了潜在的安全问题,请不要在Issues中发布。相反,请按照此处的说明操作或直接发送电子邮件至AWS安全团队

许可证

Amazon ECR Docker凭证助手根据Apache 2.0许可证授权。

编辑推荐精选

讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

Hunyuan3D-2

Hunyuan3D-2

高分辨率纹理 3D 资产生成

Hunyuan3D-2 是腾讯开发的用于 3D 资产生成的强大工具,支持从文本描述、单张图片或多视角图片生成 3D 模型,具备快速形状生成能力,可生成带纹理的高质量 3D 模型,适用于多个领域,为 3D 创作提供了高效解决方案。

3FS

3FS

一个具备存储、管理和客户端操作等多种功能的分布式文件系统相关项目。

3FS 是一个功能强大的分布式文件系统项目,涵盖了存储引擎、元数据管理、客户端工具等多个模块。它支持多种文件操作,如创建文件和目录、设置布局等,同时具备高效的事件循环、节点选择和协程池管理等特性。适用于需要大规模数据存储和管理的场景,能够提高系统的性能和可靠性,是分布式存储领域的优质解决方案。

TRELLIS

TRELLIS

用于可扩展和多功能 3D 生成的结构化 3D 潜在表示

TRELLIS 是一个专注于 3D 生成的项目,它利用结构化 3D 潜在表示技术,实现了可扩展且多功能的 3D 生成。项目提供了多种 3D 生成的方法和工具,包括文本到 3D、图像到 3D 等,并且支持多种输出格式,如 3D 高斯、辐射场和网格等。通过 TRELLIS,用户可以根据文本描述或图像输入快速生成高质量的 3D 资产,适用于游戏开发、动画制作、虚拟现实等多个领域。

下拉加载更多