# Amazon CodeCatalyst for JetBrains
<a name="codecatalyst-service"></a>

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

Amazon CodeCatalyst 是提供給軟體開發團隊的雲端協作空間。使用 AWS Toolkit for JetBrains Gateway，您可以直接從 JetBrains Gateway 檢視和管理您的 CodeCatalyst 資源。您也可以使用 Toolkit 來啟動、管理和編輯開發環境虛擬運算環境。如需 CodeCatalyst 的詳細資訊，請參閱《Amazon CodeCatalyst 指南》[https://docs.aws.amazon.com/codecatalyst/latest/userguide/welcome.html](https://docs.aws.amazon.com/codecatalyst/latest/userguide/welcome.html)。

下列主題說明如何連接 AWS Toolkit for JetBrains Gateway 與 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)
+ [安裝 AWS Toolkit for JetBrains Gateway](#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 發行版本：
+ [JetBrains Gateway for Linux](https://download.jetbrains.com/product?code=GW&latest&distribution=linux)
+ [JetBrains Gateway for Windows]( https://download.jetbrains.com/product?code=GW&latest&distribution=windows)
+ [JetBrains Gateway for macOS](https://download.jetbrains.com/product?code=GW&latest&distribution=mac)
+ [JetBrains Gateway for macOS Apple Silicon](https://download.jetbrains.com/product?code=GW&latest&distribution=macM1)

## 安裝 AWS Toolkit for JetBrains Gateway
<a name="codecatalyst-setup-toolkit"></a>

若要連接 JetBrains 與您的 CodeCatalyst 帳戶，您必須安裝最新版的工具組擴充功能。您可以直接從 JetBrains **Plugins Marketplac** 找到最新版本並完成安裝工具組。

若要從 JetBrains **Plugins Marketplac** 安裝 AWS Toolkit 外掛程式，請完成下列步驟：

1. 在 JetBrains Gateway 主畫面中，選擇**設定/偏好設定**圖示 (位於應用程式左下角)。

1. 選擇**設定/偏好設定**來開啟**設定/偏好設定**檢視。

1. 在**設定/偏好設定**檢視中，選擇**外掛程式**來開啟**外掛程式**檢視。
**注意**  
**外掛程式**檢視可以在 **Marketplace** 檢視或**已安裝**檢視中開啟。  
如果這是您第一次安裝 AWS Toolkit for JetBrains Gateway，請選取 **Plugins Marketplac** 檢視以繼續。
如果您使用的是舊版 AWS Toolkit for JetBrains Gateway，請從**已安裝**檢視更新。

1. 在 **Marketplace** 檢視中，輸入 `AWS Toolkit` 文字並選擇顯示的 **AWS Toolkit** 外掛程式項目。

1. 選擇**安裝**下載並安裝 **AWS Toolkit for JetBrains Gateway**。
**注意**  
JetBrains Gateway 會顯示您的下載和安裝進度狀態。成功安裝工具組後，JetBrains Gateway **連線** Explorer 會更新以顯示 **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 使用者手冊》**中的[設定 CodeCatalyst](https://docs.aws.amazon.com/codecatalyst/latest/userguide/setting-up-topnode.html)一節。

**注意**  
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 和您的 CodeCatalyst 帳戶，請完成下列步驟。

1. 在 JetBrains Gateway **連線** Explorer 中，選擇 **Amazon CodeCatalyst** 外掛程式來打開 **Amazon CodeCatalyst** 外掛程式檢視。

1. 在 **CodeCatalyst** 外掛程式檢視中，選擇**以 AWS Builder ID 登入**來開啟**需登入 AWS** 提示訊息。

1. 在**需登入 AWS** 提示訊息中，選擇**開啟瀏覽器**，在您偏好的網頁瀏覽器中開啟 CodeCatalyst 主控台登入畫面。

1. 在提供的欄位中輸入您的 AWS Builder ID，然後按照說明繼續操作。

1. 出現提示訊息時，選擇**允許**以確認 JetBrains 和 CodeCatalyst 帳戶之間的連線。連線程序完成後，CodeCatalyst 會顯示確認訊息，說明您可以安全關閉瀏覽器。

1. 在 JetBrains Gateway 中，** CodeCatalyst** 外掛程式檢視會更新為**開發環境**檢視。

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

您可以從 JetBrains 啟動虛擬運算環境，稱為開發環境。開發環境是可自訂的雲端開發環境，您可以在 Space 中複製並與不同團隊成員共用。如需有關開發環境以及如何從 CodeCatalyst 存取這些環境的詳細資訊，請參閱**《Amazon CodeCatalyst 使用者指南》中的[開發環境](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. 在**連線** Explorer 中選擇 **Amazon CodeCatalyst** 外掛程式。

1. 在**遠端開發**精靈主體中，導覽到您要打開的開發環境父系 Space 和專案。

1. 選擇您想開啟的開發環境。

1. 確認開發環境的開啟程序以繼續。
**注意**  
JetBrains 會在新的狀態視窗中顯示進度，當開啟程序完成時，開發環境會在新視窗中開啟。

## 建立開發環境
<a name="codecatalyst-overview-creating"></a>

建立新的開發環境

1. 在**連線** Explorer 中選擇 **CodeCatalyst** 外掛程式。

1. 在**遠端開發**精靈標題區段，選擇**建立開發環境**連結來開啟**新增 CodeCatalyst 開發環境**檢視。

1. 在**新增 CodeCatalyst 開發環境**檢視中，使用下列欄位來設定開發環境偏好設定。
   + **IDE**：選取您要在開發環境中啟動的偏好 JetBrains IDE。
   + **CodeCatalyst 專案**：為開發環境選擇 CodeCatalyst Space 和專案。
   + **開發環境別名**：輸入開發環境的替代名稱。
   + **運算**：為開發環境選擇虛擬硬體組態。
   + **永久性儲存**：選擇開發環境的持久性儲存容量。
   + **閒置逾時**：選擇開發環境進入待命狀態之前經過的系統閒置時間。

1. 若要建立新的開發環境，選擇**建立開發環境**。
**注意**  
當您選擇**建立開發環境**時，**新增開發環境**檢視會關閉，並開始建立開發環境的程序。此程序可能需要幾分鐘的時間，而且在開發環境建立完成之前，您無法使用其他 JetBrains Gateway 功能。  
JetBrains 會在新的狀態視窗中顯示進度，當程序完成時，開發環境會在新視窗中開啟。

## 從第三方儲存庫建立開發環境
<a name="codecatalyst-overview-creating-source-repo"></a>

您可以透過連結至儲存庫做為來源，從第三方儲存庫建立開發環境。

連結到第三方存儲庫做為來源的作業，是在 CodeCatalyst 中的專案層級處理。如需如何將第三方存儲庫連線到開發環境的說明和其他詳細資訊，請參閱《Amazon CodeCatalyst 使用者指南》**中的[連結來源儲存庫](https://docs.aws.amazon.com/codecatalyst/latest/userguide/source-repositories-link.html)主題。

## 配置開發環境設定
<a name="codecatalyst-overview-configure"></a>

若要從 JetBrains Gateway 變更現有開發環境的設定，請完成以下步驟。

**注意**  
一旦建立之後，開發環境的儲存空間就無法修改。

1. 在**連線** Explorer 中選擇 **Amazon CodeCatalyst** 外掛程式。

1. 在**遠端開發**精靈主體中，導覽到您要設定的開發環境父系 Space 和專案。

1. 在您要配置的開發環境旁邊選擇**設定**圖示，打開**設定開發環境:** 設定

1. 在**設定開發環境:** 設定選單中，透過變更下列選項來設定您的開發環境：
   + **開發環境別名**：用於指定開發環境替代名稱的選用欄位。
   + **IDE**：選擇您要在開發環境中啟動的 JetBrains IDE。
   + **運算**：為開發環境選擇虛擬硬體組態。
   + **閒置逾時**：選擇開發環境進入待命狀態之前經過的系統閒置時間。

## 暫停開發環境
<a name="codecatalyst-overview-pause"></a>

開發環境中的活動會永久儲存。這表示您可以暫停和繼續開發環境，而不會遺失工作進度。

若要暫停開發環境，請完成以下幾個步驟。

1. 在**連線** Explorer 中選擇 **Amazon CodeCatalyst** 外掛程式。

1. 在**遠端開發**精靈主體中，導覽到您要暫停的開發環境父系 Space 和專案。

1. 選擇使用中開發環境旁邊的**暫停**圖示，開啟**確認暫停**對話方塊。

1. 選擇**是**來關閉**確認暫停**對話方塊並初始化暫停程序。
**注意**  
JetBrains 會在新的狀態視窗中顯示暫停程序的進度。當開發環境停止時，**暫停**圖示會從使用者介面中移除。

## 恢復開發環境
<a name="codecatalyst-overview-resume"></a>

開發環境中的活動會永久儲存。這表示您可以繼續暫停的開發環境，而不會遺失之前的工作進度。

若要繼續暫停的開發環境，請完成以下幾個步驟。

1. 在**連線** Explorer 中選擇 **Amazon CodeCatalyst** 外掛程式。

1. 在**遠端開發**精靈主體中，導覽到您要繼續的開發環境父系 Space 和專案。

1. 選擇您想繼續的開發環境。
**注意**  
JetBrains 會在新的狀態視窗中顯示繼續程序的進度。當開發環境繼續時，開發環境**設定**圖示的旁邊會新增**暫停**圖示。

## 刪除開發環境
<a name="codecatalyst-overview-delete"></a>

若要刪除開發環境，請完成以下幾個步驟：

1. 在**連線** Explorer 中選擇 **Amazon CodeCatalyst** 外掛程式。

1. 在**遠端開發**精靈主體中，導覽到您要刪除的開發環境父系 Space 和專案。

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. 選擇**設定開發環境**索引標籤，然後選擇**開啟**，在 JetBrains **Editor** 中打開 `devfile`。

1. 在 **Editor** 中變更您的 `devfile` 並儲存內容。

1. 儲存變更時，**Amazon CodeCatalyst 開發環境**節點會顯示警示，指出您的開發環境需要重建。

1. 展開 **Amazon CodeCatalyst 開發環境**節點，並在**設定開發環境**索引標籤中選擇**重建開發環境**節點。