# 适用于 JetBrains 的 Amazon CodeCatalyst
<a name="codecatalyst-service"></a>

## 什么是 Amazon CodeCatalyst？
<a name="codecatalyst-intro"></a>

Amazon CodeCatalyst 是面向软件开发团队的云端协作空间。借助适用于 JetBrains Gateway 的 AWS Toolkit，您可以直接从 JetBrains Gateway 查看和管理 CodeCatalyst 资源。您还可以使用 Toolkit 启动、管理和编辑开发环境虚拟计算环境。有关 CodeCatalyst 的更多信息，请参阅《[Amazon CodeCatalyst](https://docs.aws.amazon.com/codecatalyst/latest/userguide/welcome.html) User Guide》。

以下主题介绍如何将适用于 JetBrains Gateway 的 AWS Toolkit 与 CodeCatalyst 连接，以及如何通过 JetBrains Gateway 使用 CodeCatalyst。

**Topics**
+ [什么是 Amazon CodeCatalyst？](#codecatalyst-intro)
+ [开始使用 CodeCatalyst](codecatalyst-setup.md)
+ [使用 CodeCatalyst](codecatalyst-overview.md)

# 开始使用 CodeCatalyst 和 AWS Toolkit for JetBrains
<a name="codecatalyst-setup"></a>

要开始通过 JetBrains Gateway 使用 CodeCatalyst，请完成以下操作。

**Topics**
+ [安装 JetBrains Gateway](#codecatalyst-setup-jbgateway)
+ [安装适用于 JetBrains Gateway 的 AWS Toolkit](#codecatalyst-setup-toolkit)
+ [创建 CodeCatalyst 账户和 AWS Builder ID](#codecatalyst-setup-id)
+ [将 JetBrains Gateway 与 CodeCatalyst 连接](#codecatalyst-setup-connect)

## 安装 JetBrains Gateway
<a name="codecatalyst-setup-jbgateway"></a>

在将 AWS Toolkit 集成到您的 CodeCatalyst 账户之前，请确保您使用的是最新版本的 JetBrains Gateway。要下载最新版本的 JetBrains Gateway，请从以下链接中选择您想要的 JetBrains Gateway 分配：
+ [适用于 Linux 的 JetBrains Gateway](https://download.jetbrains.com/product?code=GW&latest&distribution=linux)
+ [适用于 Windows 的 JetBrains Gateway]( https://download.jetbrains.com/product?code=GW&latest&distribution=windows)
+ [适用于 macOS 的 JetBrains Gateway](https://download.jetbrains.com/product?code=GW&latest&distribution=mac)
+ [适用于 macOS Apple Silicon 的 JetBrains Gateway](https://download.jetbrains.com/product?code=GW&latest&distribution=macM1)

## 安装适用于 JetBrains Gateway 的 AWS Toolkit
<a name="codecatalyst-setup-toolkit"></a>

要将 JetBrains 与您的 CodeCatalyst 账户连接，必须安装最新版本的工具包扩展。您可以直接从 JetBrains **插件市场**中找到最新版本，并完成工具包的安装。

要通过 JetBrains **插件市场**安装 AWS Toolkit 插件，请完成以下步骤：

1. 在 JetBrains Gateway 主屏幕中，选择位于应用程序左下角的**设置/首选项**图标。

1. 选择**设置/首选项**，以打开**设置/首选项**视图。

1. 在**设置/首选项**视图中，选择**插件**以打开**插件**视图。
**注意**  
打开**插件**视图时，可能会显示**市场**视图或**已安装**视图。  
如果这是您第一次安装适用于 JetBrains Gateway 的 AWS Toolkit，请选择**插件市场**视图以继续。
如果您以前安装过适用于 JetBrains Gateway 的 AWS Toolkit 的某个版本，请从**已安装**视图对其进行更新。

1. 在**市场**视图中，输入文本 `AWS Toolkit`，然后选择显示的 **AWS Toolkit** 插件条目。

1. 选择**安装**，以下载并安装**适用于 JetBrains Gateway 的 AWS Toolkit**。
**注意**  
JetBrains Gateway 会显示下载状态和安装进度。成功安装工具包后，JetBrains Gateway **连接**资源管理器会更新为 **Amazon CodeCatalyst** 插件图标。

## 创建 CodeCatalyst 账户和 AWS Builder ID
<a name="codecatalyst-setup-id"></a>

除了安装 AWS Toolkit for JetBrains 的最新版本之外，您还必须拥有有效的 AWS Builder ID 和 CodeCatalyst 账户，用于与 JetBrains Gateway 连接。如果您没有有效的 AWS Builder ID 或 CodeCatalyst 账户，请参阅《CodeCatalyst[https://docs.aws.amazon.com/codecatalyst/latest/userguide/setting-up-topnode.html](https://docs.aws.amazon.com/codecatalyst/latest/userguide/setting-up-topnode.html) User Guide》中的 *Setting up CodeCatalyst* 部分。

**注意**  
AWS Builder ID 与您的 AWS 凭证不同。AWS大多数可通过 AWS Toolkit 访问的 AWS 服务 都需要使用凭证。而创建新的 CodeCatalyst 账户和使用现有的 CodeCatalyst 账户进行操作时需要用到 AWS Builder ID。这包括使用 AWS Toolkit 中提供的所有 CodeCatalyst 功能。

## 将 JetBrains Gateway 与 CodeCatalyst 连接
<a name="codecatalyst-setup-connect"></a>

要将 JetBrains Gateway 与您的 CodeCatalys 账户连接，请完成以下步骤。

1. 在 JetBrains Gateway **连接**资源管理器中，选择 **Amazon CodeCatalyst** 插件，以打开 **Amazon CodeCatalyst** 插件视图。

1. 在 **CodeCatalyst** 插件视图中，选择**使用 AWS Builder ID 登录**，以打开**需要 AWS 登录**提示。

1. 在**需要 AWS 登录**提示中，选择**打开浏览器**，以在您的首选 Web 浏览器中打开 CodeCatalyst 控制台登录屏幕。

1. 将 AWS Builder ID 输入到提供的字段中，然后按照说明继续操作。

1. 出现提示时，选择**允许**以确认 JetBrains 和 CodeCatalyst 账户之间的连接。连接过程完成时，CodeCatalyst 会显示一条确认信息，表明可以安全地关闭浏览器。

1. 在 JetBrains Gateway 中，**CodeCatalyst** 插件视图已更新为**开发环境**视图。

# 在 JetBrains Gateway 中使用 Amazon CodeCatalyst
<a name="codecatalyst-overview"></a>

您可以从 JetBrains 启动虚拟计算环境，即开发环境。开发环境是可自定义的云开发环境，可供您在空间中的不同团队成员之间复制和共享。有关开发环境以及如何从 CodeCatalyst 访问此类环境的更多信息，请参阅《Amazon CodeCatalyst** User Guide》中的 [Dev Environments](https://docs.aws.amazon.com/codecatalyst/latest/userguide/codecatalyst/latest/userguide/devenvironment.html) 部分。

以下部分介绍如何从 JetBrains Gateway 创建、打开和使用开发环境。

**Topics**
+ [打开开发环境](#codecatalyst-overview-open)
+ [创建开发环境](#codecatalyst-overview-creating)
+ [从第三方存储库创建开发环境](#codecatalyst-overview-creating-source-repo)
+ [配置开发环境设置](#codecatalyst-overview-configure)
+ [暂停开发环境](#codecatalyst-overview-pause)
+ [恢复开发环境](#codecatalyst-overview-resume)
+ [删除开发环境](#codecatalyst-overview-delete)
+ [配置开发环境默认设置](#codecatalyst-overview-default)

## 打开开发环境
<a name="codecatalyst-overview-open"></a>

要从 JetBrains Gateway 打开现有开发环境，请完成以下步骤。

1. 在**连接**资源管理器中，选择 **Amazon CodeCatalyst** 插件。

1. 在**远程开发**向导正文中，导航到要打开的开发环境的父空间和项目。

1. 选择要打开的开发环境。

1. 确认您的开发环境的打开过程以继续。
**注意**  
JetBrains 会在新的状态窗口中显示进度，打开过程完成时，您的开发环境将在新窗口中打开。

## 创建开发环境
<a name="codecatalyst-overview-creating"></a>

要创建新的开发环境：

1. 在**连接**资源管理器中，选择 **CodeCatalyst** 插件。

1. 在**远程开发**向导标题部分中，选择**创建开发环境**链接，以打开**新建 CodeCatalyst 开发环境**视图。

1. 在**新建 CodeCatalyst 开发环境**视图中，使用以下字段配置您的开发环境首选项。
   + **IDE**：选择要在开发环境中启动的首选 JetBrains IDE。
   + **CodeCatalyst 项目**：为您的开发环境选择 CodeCatalyst 空间和项目。
   + **开发环境别名**：输入开发环境的备用名称。
   + **计算**：为您的开发环境选择虚拟硬件配置。
   + **持久性存储**：为您的开发环境选择持久性存储空间量。
   + **空闲超时**：选择开发环境进入待机状态之前要经过的系统空闲时间。

1. 要创建开发环境，请选择**创建开发环境**。
**注意**  
当您选择**创建开发环境**后，**新建开发环境**视图将关闭，创建开发环境的过程将开始。该过程可能需要几分钟，在完成创建开发环境之前，您无法使用其他 JetBrains Gateway 功能。  
JetBrains 会在新的状态窗口中显示进度，过程完成时，您的开发环境将在新窗口中打开。

## 从第三方存储库创建开发环境
<a name="codecatalyst-overview-creating-source-repo"></a>

您可以通过链接到作为源的存储库来创建开发环境。

链接到作为源的第三方存储库是在 CodeCatalyst 中项目级别处理的操作。有关如何将第三方存储库连接到开发环境的说明和其他详细信息，请参阅《Amazon CodeCatalyst** User Guide》中的 [Linking a source repository](https://docs.aws.amazon.com/codecatalyst/latest/userguide/source-repositories-link.html) 主题。

## 配置开发环境设置
<a name="codecatalyst-overview-configure"></a>

要从 JetBrains Gateway 更改现有开发环境的设置，请完成以下步骤。

**注意**  
创建开发环境后，无法修改分配到开发环境的存储空间量。

1. 在**连接**资源管理器中，选择 **Amazon CodeCatalyst** 插件。

1. 在**远程开发**向导正文中，导航到要配置的开发环境的父空间和项目。

1. 在要配置的开发环境旁边，选择**设置**图标，以打开**配置开发环境：**设置。

1. 在**配置开发环境：**设置菜单中，通过更改以下选项来配置您的开发环境：
   + **开发环境别名**：用于为开发环境指定和替换名称的可选字段。
   + **IDE：**选择要在开发环境中启动的 JetBrains IDE。
   + **计算**：为您的开发环境选择虚拟硬件配置。
   + **空闲超时**：选择开发环境进入待机状态之前要经过的系统空闲时间。

## 暂停开发环境
<a name="codecatalyst-overview-pause"></a>

开发环境中的活动会持久存储。这意味着您可以暂停和恢复开发环境，而不会丢失已完成的工作。

要暂停开发环境，请完成以下步骤。

1. 在**连接**资源管理器中，选择 **Amazon CodeCatalyst** 插件。

1. 在**远程开发**向导正文中，导航到要暂停的开发环境的父空间和项目。

1. 选择活动开发环境旁边的**暂停**图标，以打开**确认暂停**对话框。

1. 选择**是**以关闭**确认暂停**对话框，并初始化暂停过程。
**注意**  
JetBrains 会在新的状态窗口中显示暂停过程的进度。当开发环境停止时，**暂停**图标会从用户界面中删除。

## 恢复开发环境
<a name="codecatalyst-overview-resume"></a>

开发环境中的活动会持久存储。这意味着您可以恢复已暂停的开发环境，而不会丢失先前的工作。

要恢复已暂停的开发环境，请完成以下步骤。

1. 在**连接**资源管理器中，选择 **Amazon CodeCatalyst** 插件。

1. 在**远程开发**向导正文中，导航到要恢复的开发环境的父空间和项目。

1. 选择要恢复的开发环境。
**注意**  
JetBrains 会在新的状态窗口中显示恢复过程的进度。当开发环境恢复时，**暂停**图标会添加到开发环境**设置**图标旁边。

## 删除开发环境
<a name="codecatalyst-overview-delete"></a>

要暂停开发环境，请完成以下步骤：

1. 在**连接**资源管理器中，选择 **Amazon CodeCatalyst** 插件。

1. 在**远程开发**向导正文中，导航到要删除的开发环境的父空间和项目。

1. 选择开发环境旁边的 **X** 图标，以打开**确认删除**对话框。

1. 选择**是**以关闭对话框，并删除您的开发环境。
**重要**  
选择**是**后，您的开发环境将删除且无法检索到。在删除开发环境之前，请确保提交并推送代码更改到原始源存储库。否则，未保存的更改将永久丢失。  
删除开发环境后，**远程开发**向导将更新，开发环境将不再列于资源中。

## 配置开发环境默认设置
<a name="codecatalyst-overview-default"></a>

您可以在开发环境的 `devfile` 中配置开发环境的默认设置。`devfile` 规范是一种开放标准，您可以在 YAML 文档中对其进行更新。

有关如何定义和配置 `devfile` 的更多信息，请参阅 [devfile.io](https://devfile.io/)。

要从 JetBrains Gateway 开发环境实例打开并编辑您的 `devfile`，请完成以下步骤。

1. 在活动 JetBrains 开发环境的**导航栏**中，展开 **Amazon CodeCatalyst 开发环境**节点，以打开**后端状态详情**菜单。

1. 选择**配置开发环境**选项卡，然后选择**打开 Devfile**，以在 JetBrains **编辑器**中打开您的 `devfile`。

1. 在**编辑器**中，对您的 `devfile` 进行更改并保存工作。

1. 保存更改后，**Amazon CodeCatalyst 开发环境**节点会显示一条提醒，指示您的开发环境需要重建。

1. 展开 **Amazon CodeCatalyst 开发环境**节点，并从**配置开发环境**选项卡中选择**重建开发环境**节点。