使用 register 命令（IAM 用户 ARN）注册本地实例 - AWS CodeDeploy
步骤 1：在本地实例 AWS CLI 上安装和配置步骤 2：调用 register 命令步骤 3：调用 install 命令步骤 4：将应用程序修订部署到本地实例步骤 5：跟踪对本地实例的部署

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

使用 register 命令（IAM 用户 ARN）注册本地实例

重要

不建议使用 IAM 用户注册实例，因为它使用静态（永久）凭证进行身份验证。为了提高安全性，我们建议使用临时凭证注册实例以进行身份验证。有关更多信息，请参阅 使用 register-on-premises-instance 命令（IAM 会话 ARN）注册本地实例。

重要

确保您制定了轮换 IAM 用户的访问密钥（永久凭证）的计划。有关更多信息，请参阅轮换访问密钥。

本节介绍如何配置本地实例，并以最少的工作量注册和标记该实例。 CodeDeploy 当您处理一个或少量的本地实例时，register 命令非常有用。仅当您使用 IAM 用户 ARN 对实例进行身份验证时，才能使用 register 命令。使用 IAM 会话 ARN 进行身份验证时，不能使用 register 命令。

使用该register命令时，可以执行以下 CodeDeploy 操作：

  • 如果您未使用命令指定 IAM 用户，请在中 AWS Identity and Access Management 为本地实例创建 IAM 用户。

  • 将该 IAM 用户的凭证保存到本地实例配置文件中。

  • 向注册本地实例 CodeDeploy。

  • 如果您在命令中指定了标签，则向本地实例添加标签。

注意

该register-on-premises-instance命令是寄存器命令的替代命令。如果您想配置本地实例，并 CodeDeploy主要由您自己注册和标记该实例，则可以使用该register-on-premises-instance命令。您也可以通过 register-on-premises-instance 命令来使用 IAM 会话 ARN 注册实例，而不是使用 IAM 用户 ARN 进行注册。如果您有大量本地实例，则此方法有很大的优势。具体来说，您可以使用一个 IAM 会话 ARN 对多个实例进行身份验证，而不必为每个本地实例都单独创建一个 IAM 用户。有关更多信息，请参阅 使用 register-on-premises-instance 命令（IAM 用户 ARN）注册本地实例 和 使用 register-on-premises-instance 命令（IAM 会话 ARN）注册本地实例。

步骤 1：在本地实例 AWS CLI 上安装和配置

  1. 在本地实例 AWS CLI 上安装。请按照《AWS Command Line Interface 用户指南》的使用 AWS CLI进行设置中的说明操作。

    注意

    CodeDeploy 1.7.19 及更高 AWS CLI 版本中提供了用于使用本地实例的命令。如果您 AWS CLI 已经安装了，请aws --version致电查看其版本。

  2. 在本地实例 AWS CLI 上配置。按照《AWS Command Line Interface 用户指南》的配置 AWS CLI 中的说明进行操作。

    重要

    配置时 AWS CLI （例如，通过调用aws configure命令），请务必指定除中指定的权限之外还至少具有以下访问权限的 IAM 用户的私有密钥 ID 和私有 AWS 访问密钥配置本地实例的先决条件。这使得在本地实例上下载和安装 CodeDeploy 代理成为可能。访问权限应与以下示例类似：

    {
  "Version": "2012-10-17",
  "Statement" : [
    {
      "Effect" : "Allow",
      "Action" : [
        "codedeploy:*",
        "iam:CreateAccessKey",
        "iam:CreateUser",
        "iam:DeleteAccessKey",
        "iam:DeleteUser",
        "iam:DeleteUserPolicy",
        "iam:ListAccessKeys",
        "iam:ListUserPolicies",
        "iam:PutUserPolicy",
        "iam:GetUser",
        "tag:getTagKeys",
        "tag:getTagValues",
        "tag:GetResources"
      ],
      "Resource" : "*"
    },
    {
      "Effect" : "Allow",
      "Action" : [
        "s3:Get*",
        "s3:List*"
      ],
      "Resource" : [
        "arn:aws:s3:::aws-codedeploy-us-east-2/*",
        "arn:aws:s3:::aws-codedeploy-us-east-1/*",
        "arn:aws:s3:::aws-codedeploy-us-west-1/*",
        "arn:aws:s3:::aws-codedeploy-us-west-2/*",
        "arn:aws:s3:::aws-codedeploy-ca-central-1/*",
        "arn:aws:s3:::aws-codedeploy-eu-west-1/*",
        "arn:aws:s3:::aws-codedeploy-eu-west-2/*",
        "arn:aws:s3:::aws-codedeploy-eu-west-3/*",
        "arn:aws:s3:::aws-codedeploy-eu-central-1/*",
        "arn:aws:s3:::aws-codedeploy-il-central-1/*",
        "arn:aws:s3:::aws-codedeploy-ap-east-1/*",
        "arn:aws:s3:::aws-codedeploy-ap-northeast-1/*",
        "arn:aws:s3:::aws-codedeploy-ap-northeast-2/*",
        "arn:aws:s3:::aws-codedeploy-ap-southeast-1/*",
        "arn:aws:s3:::aws-codedeploy-ap-southeast-2/*",
        "arn:aws:s3:::aws-codedeploy-ap-southeast-4/*",
        "arn:aws:s3:::aws-codedeploy-ap-south-1/*",
        "arn:aws:s3:::aws-codedeploy-sa-east-1/*"
      ]
    }     
  ]
}
    注意

    如果您在尝试访问前面显示的 Amazon S3 存储桶时看到访问被拒绝错误，请尝试省略该存储桶的资源 ARN 的 /* 部分，例如，arn:aws:s3:::aws-codedeploy-sa-east-1。

步骤 2：调用 register 命令

在这一步中，我们假设您从本地实例本身注册该本地实例。您也可以从单独的设备或实例注册本地实例，该设备或实例已按上一步所述 AWS CLI 安装和配置了本地实例。

使用调用 AWS CLI regist er 命令，指定：

  • 用于唯一标识本地实例的名称 CodeDeploy （带--instance-name选项）。

    重要

    为了帮助在以后标识本地实例，特别是用于调试用途，我们强烈建议您使用的名称能够映射到本地实例的某种唯一特性（例如，在适用时可以使用序列号或唯一内部资产标识符）。如果您为名称指定 MAC 地址，请注意 MAC 地址包含 CodeDeploy 不允许使用的字符，例如冒号 (:)。有关允许字符的列表，请参阅CodeDeploy 配额。

  • （可选）您希望与此本地实例关联的现有 IAM 用户的 ARN（使用 --iam-user-arn 选项）。要获取 IAM 用户的 ARN，请调用 get-user 命令，或者在 IAM 控制台的用户部分中选择 IAM 用户名，然后在摘要部分找到用户 ARN 值。如果未指定此选项，则 CodeDeploy 将在您的 AWS 账户中代表您创建一个 IAM 用户，并将其与本地实例关联。

    重要

    如果您指定了 --iam-user-arn 选项，则还必须手动创建本地实例配置文件，如步骤 4：将配置文件添加到本地实例中所述。

    您只能将一个 IAM 用户与一个本地实例关联。尝试将一个 IAM 用户与多个本地实例关联会导致出错，对这些本地实例的部署将失败，或者对这些本地实例的部署会停滞在永久等待的状态。

  • （可选）一组本地实例标签（带--tags选项）， CodeDeploy 用于标识要部署到的 Amazon EC2 实例集。使用 Key=tag-key,Value=tag-value 指定各个标签（例如，Key=Name,Value=Beta Key=Name,Value=WestRegion）。如果未指定此选项，将不注册标签。要稍后注册标签，请调用-premises add-tags-to-on-instances 命令。

  • （可选）将在其中注册本地实例的 AWS 区域 CodeDeploy （带--region选项）。这必须是 AWS 一般参考的区域和终端节点中列出的受支持区域之一（例如 us-west-2）。如果未指定此选项，则将使用与调用 IAM 用户关联的默认 AWS 区域。

例如：

aws deploy register --instance-name AssetTag12010298EX --iam-user-arn arn:aws:iam::444455556666:user/CodeDeployUser-OnPrem --tags Key=Name,Value=CodeDeployDemo-OnPrem --region us-west-2

register 命令执行以下操作：

  1. 如果未指定现有 IAM 用户，则创建一个 IAM 用户，向该用户附加必需的权限，然后生成对应的私有密钥和私有访问密钥。本地实例将使用此 IAM 用户及其权限和凭证进行身份验证和交互 CodeDeploy。

  2. 向注册本地实例 CodeDeploy。

  3. 如果指定，则 CodeDeploy 将使用--tags选项指定的标签与注册的本地实例名称相关联。

  4. 如果创建了 IAM 用户，则还会在调用 register 命令的同一个目录中创建必需的配置文件。

如果此命令遇到错误，则将显示错误消息，说明您可以如何手动完成剩余步骤。否则，将显示成功消息，说明如何调用 install 命令，如接下来的步骤中所列。

步骤 3：调用 install 命令

在本地实例中，使用调 AWS CLI 用安装命令，指定：

  • 配置文件的路径（使用 --config-file 选项）。

  • （可选）是否替换本地实例上已存在的配置文件（使用 --override-config 选项）。如果未指定，则不替换现有配置文件。

  • （可选）将在其中注册本地实例的 AWS 区域 CodeDeploy （带--region选项）。这必须是 AWS 一般参考的区域和终端节点中列出的受支持区域之一（例如 us-west-2）。如果未指定此选项，则将使用与调用 IAM 用户关联的默认 AWS 区域。

  • （可选）安装 CodeDeploy 代理的自定义位置（带--agent-installer选项）。此选项对于安装 CodeDeploy 不正式支持的 CodeDeploy 代理的自定义版本（例如基于中CodeDeploy代理存储库的自定义版本 GitHub）很有用。该值必须是指向包含以下二者之一的 Amazon S3 存储桶的路径：

    • CodeDeploy 代理安装脚本（适用于基于 Linux 或 UNIX 的操作系统，类似于中CodeDeploy代理存储库中的 GitHub安装文件）。

    • CodeDeploy 代理安装程序包 (.msi) 文件（适用于基于 Windows 的操作系统）。

    如果未指定此选项，则 CodeDeploy 将尽最大努力从自己的位置安装与本地实例上的操作系统兼容的官方支持的 CodeDeploy 代理版本。

例如：

aws deploy install --override-config --config-file /tmp/codedeploy.onpremises.yml --region us-west-2 --agent-installer s3://aws-codedeploy-us-west-2/latest/codedeploy-agent.msi

install 命令执行以下操作：

  1. 检查本地实例是否为 Amazon EC2 实例。如果是，则将显示错误消息。

  2. 将本地实例配置文件从实例上的指定位置复制到 CodeDeploy 代理期望找到的位置，前提是该文件尚未位于该位置。

    对于 Ubuntu Server 和 Red Hat Enterprise Linux（RHEL），这是 /etc/codedeploy-agent/conf/codedeploy.onpremises.yml。

    对于 Windows Server，这是 C:\ProgramData\Amazon\CodeDeploy\conf.onpremises.yml。

    如果指定了 --override-config 选项，则创建或覆盖文件。

  3. 在本地实例上安装 CodeDeploy 代理，然后启动它。

步骤 4：将应用程序修订部署到本地实例

现在，您已准备好将应用程序修订部署到已注册和标记的本地实例。

将应用程序修订部署到本地实例的方法类似于将应用程序修订部署到 Amazon EC2 实例。有关说明，请参阅使用创建部署 CodeDeploy。这些说明链接到各种先决条件，包括创建应用程序、创建部署组和准备应用程序修订。如果您希望部署简单的示例应用程序修订，可以创建教程：使用 CodeDeploy （Windows 服务器、Ubuntu 服务器或红帽企业 Linux）将应用程序部署到本地实例的步骤 2：创建示例应用程序修订中所述的修订。

重要

如果您在创建以本地实例为目标的部署组时重复使用现有 CodeDeploy 服务角色，则必须在该服务角色的策略声明Action部分中包含Tag:get*该服务角色。有关更多信息，请参阅 步骤 2：为创建服务角色 CodeDeploy。

步骤 5：跟踪对本地实例的部署

将应用程序修订部署到已注册和标记的本地实例之后，您可以跟踪部署进度。

跟踪对本地实例的部署的方法与跟踪对 Amazon EC2 实例的部署的方法类似。有关说明，请参阅查看 CodeDeploy 部署详情 。

有关更多选项，请参阅在中管理本地实例的操作 CodeDeploy。