AWS CodeCommit
用户指南 (API 版本 2015-04-13)

在 Windows 上使用 AWS CLI 凭证辅助程序设置到 AWS CodeCommit 存储库的 HTTPS 连接的步骤

在首次连接到 AWS CodeCommit 之前,您必须先完成初始配置步骤。对于大多数用户来说,可通过执行适用于使用 Git 凭证的 HTTPS 用户中的步骤来轻松完成这一过程。但是,如果要使用根账户、联合访问或临时凭证连接 CodeCommit,您必须使用 AWS CLI 中包含的凭证辅助程序。

本主题将指导您完成所需步骤以安装 AWS CLI、设置您的计算机和 AWS 配置文件、连接到 CodeCommit 存储库并将存储库克隆到您的计算机(这也称为创建本地存储库)。如果您刚刚接触 Git,我们建议您查看哪里可以找到有关 Git 的更多信息?中的信息。

步骤 1:CodeCommit 初始配置

按照以下步骤设置 AWS 账户、创建和配置 IAM 用户并安装 AWS CLI。AWS CLI 包含一个凭证辅助程序,您需要对其进行配置,以便通过 HTTPS 方式连接 CodeCommit 存储库。

创建和配置用于访问 CodeCommit 的 IAM 用户

  1. 通过转到 http://aws.amazon.com 并选择 Sign Up (注册) 创建一个 AWS 账户。

  2. 创建 IAM 用户或使用您的 AWS 账户中的现有用户。确保您具有与该 IAM 用户关联的访问密钥 ID 和私有访问密钥。有关更多信息,请参阅在您的 AWS 账户中创建 IAM 用户

    注意

    CodeCommit 需要使用 AWS Key Management Service。如果使用现有的 IAM 用户,请确保未向该用户附加明确拒绝 CodeCommit 要求的 AWS KMS 操作的任何策略。有关更多信息,请参阅AWS KMS 和加密

  3. 登录 AWS 管理控制台 并通过以下网址打开 IAM 控制台 https://console.aws.amazon.com/iam/

  4. 在 IAM 控制台的导航窗格中,选择 Users (用户),然后选择要配置进行 CodeCommit 访问的 IAM 用户。

  5. Permissions 选项卡上,选择 Add Permissions

  6. Grant permissions (授予权限) 中,选择 Attach existing policies directly (直接附加现有策略)

  7. 从策略列表中选择 AWSCodeCommitFullAccess 或用于 CodeCommit 访问的其他托管策略。有关更多信息,请参阅 适用于 CodeCommit 的 AWS 托管(预定义)策略

    选择要附加的策略后,选择 Next: Review (下一步: 审核) 以审核将附加到 IAM 用户的策略的列表。如果列表正确,选择 Add permissions

    有关 CodeCommit 管理的策略以及与其他组和用户共享访问存储库的更多信息,请参阅共享存储库AWS CodeCommit 的身份验证和访问控制

安装和配置 AWS CLI

  1. 在本地计算机上,下载并安装 AWS CLI。这是从命令行与 CodeCommit 进行交互的前提条件。有关更多信息,请参阅使用 AWS 命令行界面进行设置

    注意

    CodeCommit 只适用于 AWS CLI 版本 1.7.38 和后续版本。要确定您安装的 AWS CLI 的版本,请运行 aws --version 命令。

    要将旧版本的 AWS CLI 升级到最新版本,请参阅安装 AWS Command Line Interface

  2. 运行下面的命令来验证已安装用于 AWS CLI 的 CodeCommit 命令:

    aws codecommit help

    该命令返回 CodeCommit 命令的列表。

  3. 使用 configure 命令配置 AWS CLI,如下所示:

    aws configure

    出现提示时,指定要用于 CodeCommit 的 IAM 用户的 AWS 访问密钥和 AWS 秘密访问密钥。此外,请务必指定存储库所在的 AWS 区域,例如 us-east-2。系统提示指定默认输出格式时,指定 json。例如:

    AWS Access Key ID [None]: Type your target AWS access key ID here, and then press Enter AWS Secret Access Key [None]: Type your target AWS secret access key here, and then press Enter Default region name [None]: Type a supported region for CodeCommit here, and then press Enter Default output format [None]: Type json here, and then press Enter

    要连接到另一个 AWS 区域中的存储库或资源,您必须使用默认区域名称重新配置 AWS CLI。CodeCommit 支持的默认区域名称包括:

    • us-east-2

    • us-east-1

    • eu-west-1

    • us-west-2

    • ap-northeast-1

    • ap-southeast-1

    • ap-southeast-2

    • eu-central-1

    • ap-northeast-2

    • sa-east-1

    • us-west-1

    • eu-west-2

    • ap-south-1

    • ca-central-1

    • us-gov-west-1

    • us-gov-east-1

    • eu-north-1

    有关 CodeCommit 和 AWS 区域的更多信息,请参阅 区域和 Git 连接终端节点。有关 IAM、访问密钥和私有密钥的更多信息,请参阅如何获取凭证?管理 IAM 用户的访问密钥

步骤 2:安装 Git

要使用 CodeCommit 存储库中的文件、提交和其他信息,您必须在自己的本地计算机上安装 Git。CodeCommit 支持 Git 1.7.9 以及更高版本。

要安装 Git,建议访问 Git for Windows (适用于 Windows 的 Git) 等网站。如果使用此链接安装 Git,可接受所有安装默认设置,以下内容除外:

注意

Git 是一个不断发展、定期更新的平台。有时,功能上的更改可能会影响到它与 CodeCommit 协作的方式。如果遇到 Git 和 CodeCommit 的特定版本的问题,请参阅问题排查中的信息。

步骤 3:设置凭证辅助程序

AWS CLI 包含一个可供您配合 CodeCommit 使用的 Git 凭证辅助程序。该 Git 凭证辅助程序需要 AWS 凭证配置文件,后者存储了 IAM 用户的 AWS 访问密钥 ID 和 AWS 秘密访问密钥(以及默认 AWS 区域名称和默认输出格式)的副本。Git 凭证辅助程序使用该信息自动对 CodeCommit 进行身份验证,因此,当您使用 Git 与 CodeCommit 交互时,不必每次都输入该信息。

  1. 打开命令提示符,使用 Git 运行 git config,在其中指定为 AWS 凭证配置文件使用 Git 凭证辅助程序,这可以使 Git 凭证辅助程序发送存储库的路径。

    git config --global credential.helper "!aws codecommit credential-helper $@" git config --global credential.UseHttpPath true

    Git 凭证辅助程序向 .gitconfig 文件写入以下内容:

    [credential] helper = !aws codecommit credential-helper $@ UseHttpPath = true

    重要

    • 如果您使用的是 Bash 仿真器而不是 Windows 命令行,则必须使用单引号而不是双引号。

    • 凭证辅助程序将使用默认的 AWS 配置文件或 Amazon EC2 实例角色。如果您已创建要使用的 AWS 凭证配置文件,例如 CodeCommitProfile,可以按照如下方式修改命令来使用它:

      git config --global credential.helper "!aws codecommit credential-helper --profile CodeCommitProfile $@"

      这将向 .gitconfig 文件中写入以下内容:

      [credential] helper = !aws codecommit credential-helper --profile=CodeCommitProfile $@ UseHttpPath = true
    • 如果您的配置文件名称包含空格,则在运行此命令后,必须编辑 .gitconfig 文件以使用单引号 (') 将此命令引起来。否则,凭证辅助程序将不起作用。

    • 如果您的 Windows 版 Git 安装包含 Git Credential Manager 实用程序,则在前几次连接尝试后,您会看到 403 错误或向 Credential Manager 实用程序提供凭证的提示。解决该问题的最可靠的方法是卸载并重新安装 Windows 版 Git,安装时不要选中 Git Credential Manager 实用程序选项,因为它与 CodeCommit 不兼容。若要保留 Git Credential Manager 实用程序,您必须执行额外的配置步骤来使用 CodeCommit,这包括手动修改 .gitconfig 文件,以指定在连接 CodeCommit 时使用 AWS CodeCommit 的凭证辅助程序。从 Credential Manager 实用程序(可在“控制面板”中找到该实用程序)中删除任何已存储的凭证。删除所有已存储的凭证后,向 .gitconfig 文件中添加以下内容并将其保存,然后在新的命令提示符窗口中重试连接:

      [credential "https://git-codecommit.us-east-2.amazonaws.com"] helper = !aws codecommit credential-helper $@ UseHttpPath = true [credential "https://git-codecommit.us-east-1.amazonaws.com"] helper = !aws codecommit credential-helper $@ UseHttpPath = true

      您可能还必须先通过指定 --system 而非 --global--local 来重新配置 git config 设置,之后所有连接才能正常工作。

    • 如果您想要在同一台本地计算机上为 CodeCommit 使用不同的 IAM 用户,您应指定 git config --local 而不是 git config --global,并为每个 AWS 凭证配置文件运行配置。

  2. 运行 git config --global --edit 验证上面的值是否已写入用户配置文件的 .gitconfig 文件(默认为 %HOME%\.gitconfigdrive:\Users\UserName\.gitconfig)。如果成功,您应该能够看到前面的值(以及 Git 全局配置文件中已有的值)。要退出,通常需要键入 :q,然后按 Enter。

步骤 4:连接 CodeCommit 控制台并克隆存储库

如果管理员已将 CodeCommit 存储库的名称和连接详细信息发送给您,您可以跳过该步骤并直接克隆存储库。

连接 CodeCommit 存储库

  1. 通过以下网址打开 CodeCommit 控制台:https://console.aws.amazon.com/codesuite/codecommit/home

  2. 在区域选择器中,选择已创建存储库的 AWS 区域。存储库特定于 AWS 区域。有关更多信息,请参阅 区域和 Git 连接终端节点

  3. 从列表中选择需要连接的存储库。这将打开该存储库的 Code (代码) 页。

    如果看到 Welcome (欢迎) 页面,而不是存储库列表,说明没有存储库与您的 AWS 账户关联。要创建存储库,请参阅创建 AWS CodeCommit 存储库或按照Git 与 CodeCommit 教程教程中的步骤进行操作。

  4. 复制在连接存储库时使用的 HTTPS URL。

  5. 打开命令提示符,使用该 URL 及 git clone 命令克隆存储库。这将在运行命令的目录的子目录中创建本地存储库。例如,要将名为 MyDemoRepo 的存储库克隆到美国东部(俄亥俄州)区域中名为 my-demo-repo 的本地存储库,请运行以下命令:

    git clone https://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo my-demo-repo

    在某些版本的 Windows 上,您可能会看到一条弹出消息,要求您输入用户名和密码。这是 Windows 的内置凭证管理系统,但它与 AWS CodeCommit 的凭证辅助程序不兼容。请选择 Cancel

    有关如何连接存储库的更多信息,请参阅通过克隆存储库来连接 CodeCommit 存储库

后续步骤

您已满足先决条件。请按照CodeCommit 教程中的步骤进行操作,开始使用 CodeCommit。