开始使用 AWS CodeStar - AWS CodeStar

2024 年 7 月 31 日,亚马逊 Web Services (AWS) 将停止支持创建和查看 AWS CodeStar 项目。2024 年 7 月 31 日之后,您将无法再访问 AWS CodeStar 控制台或创建新项目。但是,由 AWS CodeStar创建的 AWS 资源(包括您的源存储库、管道和构建)将不受此更改的影响,并将继续运行。 AWS CodeStar 此次停用不会影响连接和 AWS CodeStar 通知。

 

如果您想跟踪工作、开发代码以及构建、测试和部署应用程序,Amazon CodeCatalyst 提供了简化的入门流程和其他功能来管理您的软件项目。详细了解 Amazon 的功能定价 CodeCatalyst。

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

开始使用 AWS CodeStar

在本教程中,您使用 AWS CodeStar 创建 Web 应用程序。此项目包括源存储库中的示例代码、一个持续部署工具链以及一个您可在其中查看和监控项目的项目控制面板。

通过执行这些步骤,您将:

  • 在 AWS CodeStar 中创建项目。

  • 浏览项目。

  • 提交代码更改。

  • 查看自动部署的代码更改。

  • 添加处理项目的其他人员。

  • 在不再需要项目资源时将其清除。

注意

如果您尚未这样做,请首先完成设置 AWS CodeStar 中的步骤,包括步骤 2:创建 AWS CodeStar 服务角色。您必须使用 IAM 中管理用户的账户登录。要创建项目,您必须使用具有 AWSCodeStarFullAccess 策略的 IAM 用户登录 AWS Management Console。

步骤 1:创建 AWS CodeStar 项目

在此步骤中,您将为 Web 应用程序创建一个 JavaScript (Node.js) 软件开发项目。您将使用 AWS CodeStar 项目模板创建项目。

注意

本教程中使用的 AWS CodeStar 项目模板使用以下选项:

  • Application category:Web 应用程序

  • Programming language:Node.js

  • AWS 服务:Amazon EC2

如果您选择其他选项,则您的体验可能与本教程中记录的体验不匹配。

在 AWS CodeStar 中创建项目
  1. 登录 AWS Management Console,然后通过以下网址打开 AWS CodeStar 控制台:https://console.aws.amazon.com/codestar/

    确保您已登录要在其中创建项目及其资源的 AWS 区域。例如,要在美国东部(俄亥俄州)中创建项目,请确保您已选择 AWS 区域。有关 AWS CodeStar 在其中可用的 AWS 区域的信息,请参阅 AWS 一般参考中的区域和端点

  2. AWS CodeStar 页面上,选择创建项目

  3. 创建项目模板页面上,从 AWS CodeStar 项目模板的列表中选择项目类型。您可使用筛选栏缩小所选内容的范围。例如,对于要部署到 Amazon EC2 实例、用 Node.js 编写的 Web 应用程序项目,请选中 Web 应用程序Node.jsAmazon EC2 复选框。随后,从可用于此选项集的模板中进行选择。

    有关更多信息,请参阅AWS CodeStar 项目模板

  4. 选择下一步

  5. 项目名称文本输入字段中,输入项目的名称,例如我的第一个项目。在项目 ID 中,项目的 ID 派生自此项目名称,但限制为 15 个字符。

    例如,名为我的第一个项目的项目的默认 ID 是 my-first-projec。此项目 ID 是与项目关联的所有资源的名称的基础。AWS CodeStar 使用此项目 ID 作为代码存储库 URL 的一部分,以及 IAM 中相关安全访问角色和策略的名称的一部分。创建项目后,项目 ID 便无法更改。要在创建项目之前编辑项目 ID,请在项目 ID 中输入要使用的 ID。

    有关项目名称和项目 ID 的限制的信息,请参阅 AWS CodeStar 中的限制

    注意

    对于您的 AWS 账户来说,项目 ID 在某个 AWS 区域必须唯一。

  6. 选择存储库提供商 AWS CodeCommitGitHub

  7. 如果您选择了 AWS CodeCommit,则对于存储库名称,请接受默认的 AWS CodeCommit 存储库名称,或输入其他名称。然后跳至步骤 9。

  8. 如果您选择 GitHub,则需要选择或创建连接资源。如果您已有连接,请在搜索栏中选择该连接。否则,立即创建新连接。选择连接到 GitHub

    创建连接页面随即显示。

    注意

    要创建连接,您必须拥有 GitHub 账户。您必须是组织所有者才能为组织创建连接。

    Form to create a GitHub App connection with a field for connection name and a connect button.
    1. 创建 GitHub 应用程序连接连接名称的输入文本字段中,输入连接的名称。选择连接到 GitHub

      连接到 GitHub 页面将出现,并显示 GitHub 应用程序字段。

    2. GitHub 应用程序下,选择一个应用程序安装或选择安装新应用程序来创建一个应用程序安装。

      注意

      您可以为与特定提供程序的所有连接安装一个应用程序。如果您已经安装了 AWS Connector for GitHub 应用程序,选择它并跳过此步骤。

    3. 安装 AWS Connector for GitHub 页面中,选择要在其中安装应用程序的账户。

      注意

      如果您之前已安装了应用程序,则可以选择配置,继续进入应用程序安装的修改页面,也可以使用后退按钮返回到控制台。

    4. 如果显示确认密码以继续页面,请输入您的 GitHub 密码,然后选择登录

    5. 安装 AWS Connector for GitHub 页面中,保留所有默认设置,然后选择安装

    6. 连接到 GitHub 页面上,新安装的连接 ID 将显示在 GitHub 应用程序文本输入字段中。

      创建连接后,在 CodeStar“创建项目”页面中,将显示准备连接消息。

      注意

      您可以在开发人员工具控制台的设置下查看您的连接。有关更多信息,请参阅开始使用连接

      显示已完成的 GitHub 存储库连接设置的控制台屏幕截图。
    7. 对于存储库所有者,请选择 GitHub 组织或您的个人 GitHub 账户。

    8. 对于存储库名称,请接受默认的 GitHub 存储库名称,或输入其他名称。

    9. 选择 公共私有

      注意

      此外,如果您想使用 AWS Cloud9 作为开发环境,则必须选择公共

    10. (可选)对于存储库描述,请为 GitHub 存储库输入描述。

    注意

    如果您选择 Alexa Skill 项目模板,则需要关联 Amazon 开发人员账户。有关如何使用 Alexa Skill 项目的更多信息,请参阅 教程:在 AWS CodeStar 中创建 Alexa 技能项目

  9. 如果您的项目已部署到 Amazon EC2 实例,并且您想进行更改,请在 Amazon EC2 配置中配置您的 Amazon EC2 实例。例如,您可以从项目的可用实例类型中进行选择。

    注意

    不同的 Amazon EC2 实例类型将提供不同级别的计算能力,并且可能具有不同的关联成本。有关更多信息,请参阅 Amazon EC2 实例类型Amazon EC2 定价

    如果您在 Amazon Virtual Private Cloud 中创建了多个虚拟私有云 (VPC) 或多个子网,则还可选择要使用的 VPC 和子网。但是,如果您选择专用实例上不支持的 Amazon EC2 实例类型,则无法选择其实例租赁设置为专用的 VPC。

    有关更多信息,请参阅什么是 Amazon VPC?专用实例基本信息

    密钥对中,选择在 步骤 4:为 AWS CodeStar 项目创建 Amazon EC2 密钥对 创建的 Amazon EC2 密钥对。选择我确认我有权访问私钥文件

  10. 选择下一步

  11. 查看资源和配置详细信息。

  12. 选择 NextCreate project。(显示的选择取决于您的项目模板。)

    创建项目(包括存储库)可能需要几分钟时间。

  13. 在项目拥有存储库后,您可以使用存储库页面来配置对它的访问权限。使用后续步骤中的链接来配置 IDE,设置问题跟踪或向项目中添加团队成员。

步骤 2:为您的 AWS CodeStar 用户配置文件添加显示信息

在创建项目时,您将作为所有者添加到项目团队。如果这是您首次使用 AWS CodeStar,系统会要求您提供:

  • 要显示给其他用户的显示名称。

  • 要显示给其他用户的电子邮件地址。

此信息将在您的 AWS CodeStar 用户配置文件中使用。用户配置文件不是特定于项目的,而是受限于 AWS 区域。您必须在您属于其中项目的每个 AWS 区域中创建一个用户配置文件。如果您愿意,每个配置文件可包含不同的信息。

输入用户名和电子邮件地址,然后选择下一步

注意

您的 AWS CodeStar 用户配置文件将使用此用户名和电子邮件地址。如果项目使用了 AWS 以外的资源(例如 GitHub 存储库或 Atlassian JIRA 中的问题),这些资源提供者可能具有自己的用户配置文件,这些配置文件具有不同的用户名和电子邮件地址。有关更多信息,请参阅资源提供者的文档。

步骤 3:查看您的项目

您的 AWS CodeStar 项目页面是可供您和您的团队查看项目资源的状态的位置,包括项目的最新提交、持续交付管道的状态以及实例的性能。要查看有关这些资源的更多信息,请从导航栏中选择相应的页面。

在新项目中,导航栏包含以下页面:

  • 概述页面包含有关您的项目活动、项目资源和项目 README 内容的信息。

  • IDE 页面用于将项目连接到集成式开发环境 (IDE) 以修改、测试和推送源代码更改。它包含为 GitHub 和 AWS CodeCommit 存储库配置 IDE 的说明以及有关您的 AWS Cloud9 环境的信息。

  • 存储库页面显示您的存储库详细信息,包括名称、提供商、上次修改时间和克隆 URL。您还可以查看有关最新提交的信息,并查看和创建拉取请求。

  • 管道页面显示有关您管道的 CI/CD 信息。您可以查看管道详细信息,例如名称、最近的操作和状态。您可以查看管道历史记录并发布更改。您还可以查看管道中各个步骤的状态。

  • 监控页面根据您的项目配置显示 Amazon EC2 或 AWS Lambda 指标。例如,它显示由您管道中的 AWS Elastic Beanstalk 或 CodeDeploy 资源部署到的任何 Amazon EC2 实例的 CPU 利用率。在使用 AWS Lambda 的项目中,它会显示 Lambda 函数的调用和错误指标。此信息按小时显示。如果您使用了本教程中建议的 AWS CodeStar 项目模板,则您在将应用程序首次部署到这些实例时应看到活动中出现明显的峰值。您可以刷新监控以查看您的实例运行状况的更改,这可帮助您确定问题或对更多资源的需求。

  • 问题页面用于将您的 AWS CodeStar 项目与 Atlassian JIRA 项目集成。配置此磁贴将使您和您的项目团队能够从项目控制面板跟踪 JIRA 问题。

在控制台左侧的导航窗格中,您可以在项目团队设置页面之间导航。

步骤 4:提交更改

首先,查看项目中包含的示例代码。在项目导航中的任意位置选择查看应用程序,即可查看应用程序的外观。您的示例 Web 应用程序将显示在新窗口或浏览器标签页中。这是 AWS CodeStar 构建并部署的项目示例。

如果您想查看代码,请在导航栏中选择存储库。选择存储库名称下的链接,您的项目存储库将在新的选项卡或窗口中打开。读取存储库的自述文件 (README.md) 的内容,然后浏览这些文件的内容。

在这个步骤中,您将更改代码,然后将更改推送到存储库。可以通过以下方式之一执行此操作:

  • 如果项目的代码存储在 CodeCommit 或 GitHub 存储库中,则您可以使用 AWS Cloud9 直接从 Web 浏览器处理代码,而无需安装任何工具。有关更多信息,请参阅为项目创建 AWS Cloud9 环境

  • 如果项目的代码存储在 CodeCommit 存储库中,并且安装了 Visual Studio 或 Eclipse,则使用 AWS Toolkit for Visual Studio 或 AWS Toolkit for Eclipse 可更方便地连接代码。有关更多信息,请参阅将 AWS CodeStar 与 IDE 配合使用。如果没有 Visual Studio 或 Eclipse,请安装 Git 客户端,然后按照本步骤后面的说明进行操作。

  • 如果项目代码存储在 GitHub 存储库中,可以使用 IDE 中的工具连接 GitHub。

    • 对于 Visual Studio,可以使用 GitHub Extension for Visual Studio 等工具。有关更多信息,请参阅 GitHub Extension for Visual Studio 网站上的 Overview 页面及 GitHub 网站上的 Getting Started with GitHub for Visual Studio

    • 对于 Eclipse,可以使用 EGit for Eclipse 等工具。有关更多信息,请参阅 EGit 网站上的 EGit 文档

    • 对于其他 IDE,请参阅相应 IDE 文档。

  • 对于其他类型的代码存储库,请参阅存储库提供商的文档。

以下说明介绍如何对示例进行次要更改。

设置您的计算机以提交更改(IAM 用户)
注意

在此过程中,我们假定项目的代码存储在 CodeCommit 存储库中。对于其他类型的代码存储库,请参阅存储库提供商的文档,然后向前跳到下一个过程克隆项目存储库并进行更改

如果代码存储在 CodeCommit 中并且您已在使用 CodeCommit,或者您已使用 AWS CodeStar 控制台为项目创建了 AWS Cloud9 开发环境,则无需其他配置。请向前跳到下一个过程克隆项目存储库并进行更改

  1. 在您的本地计算机上安装 Git

  2. 登录AWS Management Console,然后通过以下网址打开 IAM 控制台:https://console.aws.amazon.com/iam/

    以将使用 Git 凭证来连接您在 CodeCommit 中的 AWS CodeStar 项目存储库的 IAM 用户身份登录。

  3. 在 IAM 控制台的导航窗格中,选择 用户,然后从用户列表中选择您的 IAM 用户。

  4. 在用户详细信息页上,选择安全凭证选项卡,然后在 CodeCommit 的 HTTPS Git 凭证中,选择生成

    注意

    您不能为 Git 凭证选择自己的登录凭证。有关更多信息,请参阅将 Git 凭证和 HTTPS 与 CodeCommit 配合使用

  5. 复制 IAM 为您生成的登录凭证。您可以选择 Show,然后将此信息复制并粘贴到本地计算机上的安全文件中,也可以选择 Download credentials 来以 .CSV 文件格式下载此信息。您需要这些信息才能连接到 CodeCommit。

    保存您的凭证后,选择 Close

    重要

    这是您保存登录凭证的唯一机会。如果您未保存,可以从 IAM 控制台复制用户名,但无法查找密码。此时,您必须重置密码,然后保存它。

设置您的计算机以提交更改(联合身份用户)

您可以使用控制台将文件上传到存储库,也可以使用 Git 从您的本地计算机进行连接。如果您使用的是联合访问,请按照以下步骤使用 Git 从您的本地计算机连接到存储库并进行克隆。

注意

在此过程中,我们假定项目的代码存储在 CodeCommit 存储库中。对于其他类型的代码存储库,请参阅存储库提供商的文档,然后向前跳到下一个过程克隆项目存储库并进行更改

  1. 在您的本地计算机上安装 Git

  2. 安装 AWS CLI

  3. 为联合身份用户配置临时安全凭证。有关信息,请参阅临时访问 CodeCommit 存储库。临时凭证包括:

    • AWS 访问密钥

    • AWS 私有密钥

    • 会话令牌

    有关临时凭证的更多信息,请参阅 GetFederationToken 的权限

  4. 使用 AWS CLI 凭证辅助程序连接到您的存储库。有关信息,请参阅在 Linux、macOS 或 Unix 上使用 AWS CLI 凭证助手设置到 CodeCommit 存储库的 HTTPS 连接的步骤在 Windows 上使用 AWS CLI 凭证助手设置到 CodeCommit 存储库的 HTTPS 连接的步骤

  5. 以下示例演示如何连接到 CodeCommit 存储库并向其推送提交。

示例:克隆项目存储库并进行更改
注意

此过程介绍如何将项目的代码存储库克隆到您的计算机,更改项目的 index.html 文件,然后将更改推送到远程存储库。在此过程中,我们假定项目的代码存储在 CodeCommit 存储库中,并且您从命令行使用 Git 客户端。对于其他类型的代码存储库或工具,请参阅提供商的文档,了解如何克隆存储库、更改文件,然后推送代码。

  1. 如果您已使用 AWS CodeStar 控制台为项目创建了 AWS Cloud9 开发环境,请打开该开发环境,然后跳到此过程中的步骤 3。要打开该开发环境,请参阅为项目打开 AWS Cloud9 环境

    在项目在 AWS CodeStar 控制台中打开的情况下,在导航栏上选择存储库。在克隆 URL 中,选择您为 CodeCommit 设置的连接类型的协议,然后复制该链接。例如,如果您执行前一个过程中的步骤为 CodeCommit 设置了 Git 凭证,请选择 HTTPS

  2. 在本地计算机上,打开终端或命令行窗口,然后将目录更改为临时目录。运行 git clone 命令以将存储库克隆到您的计算机。粘贴所复制的链接。例如,对于使用 HTTPS 的 CodeCommit:

    git clone https://git-codecommit.us-east-2.amazonaws.com/v1/repos/my-first-projec

    在第一次连接时,系统会提示您提供该存储库的登录凭证。对于 CodeCommit,请输入您在上一步下载的 Git 凭证登录凭证。

  3. 导航到计算机上的克隆目录,然后浏览相应内容。

  4. 打开 index.html 文件(在公共文件夹中),然后对该文件进行更改。例如,在 <H2> 标签后添加一个段落,如:

    <P>Hello, world!</P>

    保存该文件。

  5. 在终端或命令提示符下,添加更改后的文件,然后提交并推送您的更改:

    git add index.html git commit -m "Making my first change to the web app" git push
  6. 存储库页面上,查看正在进行的更改。您应看到,已使用您的提交更新了存储库的提交历史记录,包括提交消息。在管道页面上,您可以看到管道接受您对存储库进行的更改,并开始构建和部署它。部署 Web 应用程序后,您可以选择查看应用程序以查看您的更改。

    注意

    如果任何管道阶段显示失败,请参阅以下内容获取问题排查帮助:

步骤 5:添加更多团队成员

每个 AWS CodeStar 项目已配置了三个 AWS CodeStar 角色。每个角色提供对项目及其资源的自身级别的访问权限:

  • 所有者:可添加和删除团队成员、更改项目控制面板以及删除项目。

  • 贡献者:可更改项目控制面板和提供代码(如果代码存储在 CodeCommit 中),但不能添加或删除团队成员或者删除项目。这是您应在 AWS CodeStar 项目中为大多数团队成员选择的角色。

  • 查看者:可查看项目控制面板、项目代码(如果代码存储在 CodeCommit 中)以及项目的状态,但不能在项目控制面板中移动、添加或删除磁贴。

重要

如果项目使用了 AWS 以外的资源(例如 GitHub 存储库或 Atlassian JIRA 中的问题),对这些资源的访问由资源提供者而非 AWS CodeStar 控制。有关更多信息,请参阅资源提供者的文档。

有权访问 AWS CodeStar 项目的任何人都能使用 AWS CodeStar 控制台访问位于 AWS 以外但与此项目有关的资源。

AWS CodeStar 不会允许项目团队成员参与项目的任何相关 AWS Cloud9 开发环境。要允许团队成员参与共享环境,请参阅与项目团队成员共享 AWS Cloud9 环境

有关团队和项目角色的更多信息,请参阅与 AWS CodeStar 团队协作

将团队成员添加到 AWS CodeStar 项目(控制台)
  1. 打开 AWS CodeStar 控制台,地址:https://console.aws.amazon.com/codestar/

  2. 从导航窗格中选择项目,然后选择您的项目。

  3. 在项目的侧导航栏中,选择团队

  4. Team members 页面上,选择 Add team member

  5. Choose user 中,执行下列操作之一:

    • 如果要添加的人员已有 IAM 用户,请从列表中选择该 IAM 用户名。

      注意

      已添加到另一个 AWS CodeStar 项目的用户将显示在现有 AWS CodeStar 用户列表中。

      项目角色中,选择要此用户的 AWS CodeStar 角色(所有者、贡献者或查看者)。这是只能由项目所有者更改的 AWS CodeStar 项目级角色。此角色在应用于 IAM 用户时将提供访问 AWS CodeStar 项目资源所需的所有权限。它会应用执行以下操作所需的策略:在 IAM 中为存储在 CodeCommit 中的代码创建和管理 Git 凭证,或在 IAM 中为用户上传 Amazon EC2 SSH 密钥。

      重要

      您无法提供或更改 IAM 用户的显示名称或电子邮件信息,除非您已经以该用户身份登录到控制台。有关更多信息,请参阅管理 AWS CodeStar 用户配置文件的显示信息

      选择添加团队成员

    • 如果要添加到项目的人员没有 IAM 用户,请选择创建新 IAM 用户。您将被重定向到 IAM 控制台,可以在其中创建新的 IAM 用户。有关更多信息,请参阅 IAM 用户指南中的创建 IAM 用户。创建 IAM 用户后,返回 AWS CodeStar 控制台,刷新用户列表,然后从下拉列表中选择您创建的 IAM 用户。输入要应用于此新用户的 AWS CodeStar 显示名称、电子邮件地址和项目角色,然后选择添加团队成员

    注意

    为了便于管理,应向至少一个用户分配了该项目的“所有者”角色。

  6. 向新团队成员发送以下信息:

    • 您的 AWS CodeStar 项目的连接信息。

    • 为了从本地计算机访问 CodeCommit 存储库而使用 Git 凭证设置访问权限的说明(如果源代码存储在 CodeCommit 中)。

    • 有关用户如何管理其显示名称、电子邮件地址和公有 Amazon EC2 SSH 密钥的信息,如 使用您的 AWS CodeStar 用户配置文件 中所述。

    • 一次性密码和连接信息,前提是用户是首次使用 AWS,并且您已为该人员创建 IAM 用户。此密码将在用户首次登录后过期。用户必须选择一个新密码。

步骤 6:清除

恭喜您!您已完成本教程。如果您不想继续使用此项目及其资源,则应将其删除,以避免对您的 AWS 账户持续产生可能的费用。

在 AWS CodeStar 中删除项目
  1. 打开 AWS CodeStar 控制台,地址:https://console.aws.amazon.com/codestar/

  2. 在导航窗格中,选择项目

  3. 选择要删除的项目,然后选择删除

    或者打开项目,并在控制台左侧的导航窗格中选择设置。在项目详细信息页上,选择 Delete project

  4. 删除确认页面中,选择删除。如果您要删除项目资源,请选中删除资源。选择删除

    可能需要花费几分钟的时间才能删除项目。删除项目后,项目将不再显示在 AWS CodeStar 控制台中的项目列表中。

    重要

    如果项目使用了 AWS 以外的资源(例如 GitHub 存储库或 Atlassian JIRA 中的问题),即使选中此复选框,也不会删除这些资源。

    如果任何 AWS CodeStar 托管策略已手动附加到非 IAM 用户的角色,则无法删除您的项目。如果您已将项目的托管策略附加到联合身份用户的角色,则必须先分离策略才能删除项目。有关更多信息,请参阅将 AWS CodeStar 托管策略与联合用户角色分离

步骤 7:为生产环境准备好您的项目

创建项目后,您随时可以创建、测试和部署代码。查看以下有关在生产环境中维护您的项目的注意事项:

  • 定期对应用程序所使用的依赖项应用补丁并审查安全最佳实践。有关更多信息,请参阅AWS CodeStar 资源的安全最佳实践

  • 定期监控项目的编程语言所推荐的环境设置。

后续步骤

下面是可帮助您了解 AWS CodeStar 的一些其他资源: