使用 git-remote-codecommit 建立到 AWS CodeCommit 的 HTTPS 连接的设置步骤 - AWS CodeCommit

使用 git-remote-codecommit 建立到 AWS CodeCommit 的 HTTPS 连接的设置步骤

如果要使用根账户、联合访问或临时凭证连接到 CodeCommit,则应使用 git-remote-codecommit 设置访问权限。此实用程序提供一种通过扩展 Git 从 CodeCommit 存储库中推送和拉取代码的简单方法。这是支持使用联合访问、身份提供程序和临时凭证建立连接的推荐方法。您也可以不创建 IAM 用户,而是使用来自 AWS Directory Service、您的企业用户目录或 Web 身份提供商的现有身份。这些用户被称为联合身份用户。在通过身份提供商请求访问权限时,AWS 将为联合身份用户分配角色。有关联合身份用户的更多信息,请参阅 IAM 用户指南 中的联合身份用户和角色

您还可以将 git-remote-codecommit 与 IAM 用户结合使用。与其他 HTTPS 连接方法不同,git-remote-codecommit 不要求为用户设置 Git 凭证。

注意

某些 IDE 不支持 git-remote-codecommit 使用的克隆 URL 格式。您可能需要手动将存储库克隆到本地计算机,然后才能在您首选的 IDE 中使用它们。有关更多信息,请参阅git-remote-codecommit 和 AWS CodeCommit 疑难解答

编写这些过程时,假设您有一个 AWS 账户,在 CodeCommit 中创建了至少一个存储库,并在连接到 CodeCommit 存储库时使用具有托管策略的 IAM 用户。有关如何为联合身份用户和其他轮换凭证类型配置访问权限的信息,请参阅使用轮换凭证连接到 AWS CodeCommit 存储库

步骤 0:安装 git-remote-codecommit 的先决条件

您必须在本地计算机上安装一些先决条件,然后才能使用 git-remote-codecommit。包括:

  • Python(版本 3 或更高版本)及其程序包管理器 pip(如果尚未安装)。要下载并安装 Python 的最新版本,请访问 Python 网站

  • Git

注意

在 Windows 上安装 Python 时,请确保选择了将 Python 添加到路径的选项。

git-remote-codecommit 需要 pip 版本 9.0.3 或更高版本。要检查您的 pip 版本,请打开终端或命令行并运行以下命令:

pip --version

您可以运行以下两个命令将您的 pip 版本更新到最新版本:

curl -O https://bootstrap.pypa.io/get-pip.py python3 get-pip.py --user

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

要安装 Git,建议您访问 Git 下载等网站。

注意

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

步骤 1:CodeCommit 初始配置

请按照以下步骤创建 IAM 用户、使用适当的策略对其进行配置、获取访问密钥和秘密密钥,以及安装和配置 AWS CLI。

创建和配置用于访问 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. 从策略列表中选择 AWSCodeCommitPowerUser 或用于 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 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 CLI 配合使用的详细信息,请参阅以下内容:

    要连接到另一个 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

    • ap-east-1

    • me-south-1

    • cn-north-1

    • cn-northwest-1

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

步骤 2:安装 git-remote-codecommit

请按照以下步骤安装 git-remote-codecommit

安装 git-remote-codecommit

  1. 在终端或命令行中,运行以下命令:

    pip install git-remote-codecommit
    注意

    根据您的操作系统和配置,您可能需要使用提升的权限运行此命令,例如 sudo:

    sudo pip install git-remote-codecommit
  2. 监控安装过程,直到您看到类似于以下内容的成功消息:

    Successfully built git-remote-codecommit

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

如果管理员已经向您发送了用于 CodeCommit 存储库的要与 git-remote-codecommit 结合使用的克隆 URL,则可以跳过连接到控制台的操作,而直接克隆存储库。

连接 CodeCommit 存储库

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

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

  3. 从列表中找到您要连接的存储库并选择此存储库。选择 Clone URL (克隆 URL),然后选择克隆或连接到存储库时要使用的协议。此时将复制克隆 URL。

    • 如果您对 IAM 用户使用 Git 凭证或使用 AWS CLI 随附的凭证辅助程序,请复制 HTTPS URL。

    • 如果您在本地计算机上使用 git-remote-codecommit 命令,请复制 HTTPS (GRC) URL。

    • 如果您对 IAM 用户使用 SSH 公有密钥/私有密钥对,请复制 SSH URL。

    注意

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

  4. 在终端或命令提示符处,使用 git clone 命令克隆存储库。请使用您复制的 HTTPS git-remote-codecommit URL 以及 AWS CLI 配置文件的名称(如果您创建了命名配置文件)。如果未指定配置文件,则该命令将采用默认配置文件。这将在运行命令的目录的子目录中创建本地存储库。例如,要将名为 MyDemoRepo 的存储库克隆成名为 my-demo-repo 的本地存储库,请运行以下命令:

    git clone codecommit://MyDemoRepo my-demo-repo

    要使用名为 CodeCommitProfile 的配置文件来克隆相同的存储库:

    git clone codecommit://CodeCommitProfile@MyDemoRepo my-demo-repo

    要在与在配置文件中配置的 AWS 区域不同的 AWS 区域中克隆存储库,请包含 AWS 区域名称。例如:

    git clone codecommit::ap-northeast-1://MyDemoRepo my-demo-repo

后续步骤

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

如果您刚刚接触 Git,您可能还需要查看哪里可以找到有关 Git 的更多信息?Git 和 AWS CodeCommit 入门中的信息。