AWS CodeStar 入門 - AWS CodeStar

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

AWS CodeStar 入門

在此教學課程中,您使用 AWS CodeStar 建立 Web 應用程式。在來源儲存庫中,此專案包含範本程式碼、持續部署工具鏈和專案儀表板,其中可以讓您檢視和監控您的專案。

遵循以下步驟:

  • 在 AWS CodeStar 中建立專案。

  • 探索專案。

  • 遞交程式碼變更。

  • 查看您自動部署的程式碼變更。

  • 新增其他使用者來處理您的專案。

  • 清理不再需要的專案資源。

注意

如果尚未完成,首先完成 設定 AWS CodeStar 中的步驟,包括步驟 2:建立 AWS CodeStar 服務角色。您必須使用 IAM 中的管理使用者賬户登入。若要建立專案,您必須登入AWS Management Console使用具有AWSCodeStarFullAccess策略。

步驟 1:創建 AWS CodeStar 項目

在此步驟中,您建立適用於 Web 應用程式的 JavaScript (Node.js) 軟體開發專案。您使用 AWS CodeStar 專案模板建立專案。

注意

此教學課程中使用的 AWS CodeStar 專案模板使用以下選項:

  • 應用程式類別:Web 應用程式

  • 程式設計語言:Node.js

  • AWSService (服務):Amazon EC2

如果您選擇其他選項,您的體驗可能不會符合此教學課程中的記錄。

在 AWS CodeStar 中建立專案
  1. 登入AWS Management Console,然後打開 AWS CodeStar 控制台,請訪問https://console.aws.amazon.com/codestar/

    請確認已登入至您想要建立專案及其資源的 AWS 區域。例如,若要在美國東部 (俄亥俄州) 建立專案,請確認已選取AWS區域。如需的相關資訊AWS提供 AWS CodeStar 的地區,請參閲區域與端點中的AWS一般參考

  2. AWS CodeStar頁面中,選擇create project

  3. 選擇專案模板頁面上,從 AWS CodeStar 專案模板清單中選擇專案類型。您可使用篩選條件搜尋列,以縮減選項。例如,欲將以 Node.js 撰寫而成的 Web 應用程式專案部署至 Amazon EC2 執行個體,請選擇Web 應用程式Node.js,和Amazon EC2核取方塊。然後從符合這組選項的範本中選擇。

    如需詳細資訊,請參閱 AWS CodeStar 專案範本

  4. 選擇 Next (下一步)。

  5. InProject name (專案名稱)中,輸入專案的名稱 (如我的第一個項目。In專案 ID,此專案的 ID 衍生自其名稱,但上限為 15 個字元。

    例如,專案名為我的第一個項目我的第一個過程。此專案 ID 是所有與之建立關聯的資源名稱的基礎。AWS CodeStar 會將此專案 ID 用在您的程式碼儲存庫 URL,也會用在 IAM 中相關安全存取角色和政策的名稱。專案建立之後,就無法再變更其 ID。要在建立專案前編輯專案 ID,請在專案 ID中,輸入您想要使用的 ID。

    如需專案名稱和專案 ID 限制的資訊,請參閱 AWS CodeStar 中的限制

    注意

    專案 ID 必須專屬於您在 AWS 區域中的 AWS 帳戶。

  6. 選擇儲存庫提供者、AWS CodeCommitGitHub (GitHub)

  7. 若您選擇 AWS CodeCommit,則在 Repository name (儲存庫名稱) 中,請接受預設 AWS CodeCommit 儲存庫名稱,或輸入另一個名稱。接著跳至步驟 9。

  8. 如果您選擇了GitHub,則需要選擇或創建連接資源。如果您有現有連接,請在搜索字段中選擇該連接。否則,請立即建立新的連線。選擇 ​Connect to GitHub (連線到 GitHub)

    所以此建立連線頁面顯示。

    注意

    若要建立連線,您必須擁有 GitHub 帳户。如果要為組織創建連接,則必須是組織所有者。

    1. 根據創建 GitHub 應用程序連接, 在連線名稱 (Connection name)中,輸入連線的名稱。選擇 ​Connect to GitHub (連線到 GitHub)

      所以此Connect 至 GitHub頁面顯示並顯示GitHub 應用程式欄位。

    2. GitHub Apps (GitHub 應用程式) 底下,選擇應用程式安裝,或選擇 Install a new app (安裝新應用程式) 以建立安裝。

      注意

      您可以為您連至特定供應商的所有連線安裝一個應用程式。如果您已安裝AWSGitHub 應用程序的連接器,請選擇它並跳過此步驟。

    3. 安裝AWSGitHub 連線器頁面上,選擇您想安裝應用程式的帳户。

      注意

      如果您先前已安裝應用程式,可以選擇 Configure (設定),繼續前往應用程式安裝的修改頁面,或者您可以使用上一步按鈕返回主控台。

    4. 如果確認密碼以繼續頁面上,輸入您的 GitHub 密碼,然後選擇登入

    5. 安裝AWSGitHub 連線器頁面中,保留默認值,然後選擇安裝

    6. Connect 至 GitHub頁面上,新安裝的安裝 ID 會出現在GitHub 應用程式

      創建連接後,在 CodeStar 創建項目頁面中,消息準備好連線顯示。

      注意

      您可以在設定中的開發人員工具主控台。如需詳細資訊,請參閱「」開始使用連線

      
                        主控台螢幕抓取畫面,其中顯示 GitHub 儲存庫的已填妥連線設定。
    7. 適用於儲存庫擁有者中,選擇 GitHub 組織或您個人的 GitHub 帳户。

    8. Repository name (儲存庫名稱) 中,請接受預設 GitHub 儲存庫名稱,或輸入另一個名稱。

    9. 選擇公有或者私有

      注意

      使用AWS Cloud9作為開發環境,則必須選擇公有

    10. (選用) 在 Repository description (儲存庫描述) 中,輸入此 GitHub 儲存庫的描述。

  9. 如果您的項目已部署到 Amazon EC2 實例並且您想要進行更改,請在Amazon EC2 組態。例如,您可為專案選擇可用的執行個體類型。

    注意

    不同的 Amazon EC2 執行個體類型提供不同層級的運算能力,而且相關聯的成本可能也有差異。如需詳細資訊,請參閱「」Amazon EC2 執行個體類型Amazon EC2 定價

    如果您在 Amazon 虛擬私有雲端中建立多個虛擬私有雲端 (VPC) 或多個子網路,您也可選擇使用 VPC 和子網路。不過,如果您選擇的 Amazon EC2 執行個體類型不受專用執行個體支援,則無法選擇執行個體租用設為專用型

    如需詳細資訊,請參閱「」什麼是 Amazon VPC?專用執行個體基本概念

    In金鑰對 (Key pair)中,選擇您剛才在步驟 4:建立適用於 AWS CodeStar 專案的 Amazon EC2 金鑰對。選擇我承認我有權訪問私鑰文件

  10. 選擇 Next (下一步)。

  11. 檢閱資源和組態詳細資訊。

  12. 選擇 Next (下一步)Create 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存儲庫和有關您的AWS Cloud9環境。

  • 所以此儲存庫頁面顯示存儲庫詳細信息,包括名稱、提供商、上次修改時間和克隆 URL。您還可以查看有關最近提交的信息,以及查看和創建拉取請求。

  • 所以此管道頁面顯示有關管道的 CI/CD 信息。您可以查看管道詳細信息,如名稱、最近的操作和狀態。您可以查看管道的歷史記錄並釋放更改。您也可以查看管道各個步驟的狀態。

  • 所以此監控頁面顯示 Amazon EC2 或AWS Lambda指標,具體取決於項目的配置。例如,它會顯示部署到的所有 Amazon EC2 執行個體的 CPU 使用率。AWS Elastic Beanstalk或 CodeDeploy 管道中的資源。在使用AWS Lambda,它會顯示 Lambda 函數的叫用和錯誤指標。按小時顯示此資訊。如果您在此教學課程中使用建議的 AWS CodeStar 專案模板,您應該會在活動看到明顯的跡象,因為您的應用程式會先部署到這些執行個體。您可以重新整理監控以查看您的執行個體運作狀態的變化,其可協助您找出問題或更多資源的需要。

  • 所以此問題頁面是用於整合您的 AWS CodeStar 專案與 Atlassian JIRA 專案。設定此圖磚可讓您和您的專案團隊從專案儀表板追蹤 JIRA 問題。

在主控台左側的導覽窗格中,您可以在專案團隊,和設定頁面。

步驟 4:提交變更

首先,查看您的專案所包含的範例應用程式。查看應用程序的外觀,方法是選擇檢視應用程式從您的項目導航中的任何位置。您的範例 Web 應用程式會顯示在新的視窗或瀏覽器標籤。這是 AWS CodeStar 建構和部署的專案範例。

如果您想查看程式碼,請在導覽列中選擇儲存庫。選擇儲存庫名稱並且您專案的儲存庫在新標籤或視窗開啟。閱讀儲存庫的 readme 檔案內容 (README.md),並瀏覽這些檔案的內容。

在此步驟中,您變更程式碼,然後推送變更至儲存庫。您可以數種不同方式的其中一種來執行:

  • 如果專案的程式碼存放於 CodeCommit 或 GitHub 儲存庫中,您可以使用AWS Cloud9直接處理來自 Web 瀏覽器的程式碼,無需安裝任何工具。如需詳細資訊,請參閱 建立專案的 AWS Cloud9 環境

  • 如果專案的程式碼儲存在 CodeCommit 儲存庫中,而且您已安裝 Visual Studio 或 Eclipse,您可以使用AWS Toolkit for Visual Studio或者AWS Toolkit for Eclipse以更輕鬆地連接到代碼。如需詳細資訊,請參閱 搭配使用 IDE 和 AWS CodeStar。如果您沒有 Visual Studio 或 Eclipse,請安裝 Git 用戶端,並依照此步驟稍後的說明操作。

  • 如果專案的程式碼是存放在 GitHub 儲存庫,您可以使用 IDE 的工具連接到 GitHub。

    • 對於 Visual Studio,您可以使用如 GitHub Extension for Visual Studio 之類的工具。如需詳細資訊,請參閱 GitHub Extension for Visual Studio 網站上的概觀頁面,以及 GitHub 網站上的 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,並開啟位於 https://console.aws.amazon.com/iam/ 的 IAM 主控台。

    登入為使用者,其使用 Git 登入資料連接到您在 CodeCommit 中 AWS CodeStar 專案儲存庫的 AWS CodeStar 專案儲存庫。

  3. 在 IAM 主控台的導覽窗格中,選擇使用者,然後從使用者清單中選擇 IAM 使用者。

  4. 在 Connection (用户詳細資訊) 頁面上,選擇安全登入資料選項卡,並在HTTPS Git 登入資料,選擇Generate

    注意

    您無法為 Git 憑證選擇自己的使用者名稱或密碼。如需詳細資訊,請參閱「」與程 CodeCommit 交一起使用 Git 登入資料和 HTTPS

  5. 複製 IAM 為您建立的使用者名稱和密碼。您可以選擇顯示,然後複製此資訊並貼至本機電腦的安全檔案,或者您可以選擇下載登入資料下載此資訊為 .CSV 檔案。您需要此資訊才能連接至 CodeCommit。

    儲存您的登入資料之後,選擇 Close (關閉)

    重要

    這是您儲存使用者名稱和密碼的唯一機會。如果不儲存,您可以從 IAM 主控台複製使用者名稱,但無法查詢密碼。您必須重設密碼,然後儲存密碼。

設定您的電腦以確認變更 (聯合身分使用者)

您可以使用主控台來上傳檔案到您的儲存庫,或者使用 Git 從您的本機電腦連線。如果您使用的是聯合身分存取權,請依照以下步驟以使用 Git 來連線,並從您的本機電腦複製儲存庫。

注意

在此步驟中,我們假設您專案的程式碼儲存在 CodeCommit 儲存庫中。關於其他類型的程式碼儲存庫的詳細資訊,請參閱儲存庫提供者的文件,然後請直接跳到下一個程序:複製專案儲存庫並做變更

  1. 安裝 Git 於您的本機電腦。

  2. 安裝 AWS CLI

  3. 針對聯合身分使用者設定臨時安全性登入資料。如需相關資訊,請參閱「」。臨時存取程式 CodeCommit 儲存庫。臨時登入資料包含:

    • AWSaccess_key

    • AWS私密金鑰

    • 工作階段字符

    如需臨時登入資料的詳細資訊,請參閱 GetFederationToken 的許可

  4. 使用 AWS CLI 登入資料協助程式連接到您的儲存庫。如需相關資訊,請參閱「」。在 Linux、macOS 或 Unix 上使用AWSCLI 登入資料協助程式或者在 Windows 上設定儲 CodeCommit HTTPS 連線的步驟AWSCLI 登入資料協助程式

  5. 以下範例説明如何連接到 CodeCommit 儲存庫和推送遞交。

範例:複製專案儲存庫並進行更改
注意

此程序說明如何複製專案的程式碼儲存庫到您的電腦、變更專案的 index.html 檔案,然後推送您的變更到遠端儲存庫。在此步驟中,我們假設您的專案的程式碼儲存在 CodeCommit 儲存庫,而且您使用命令列的 Git 用户端。如需其他類型的程式碼儲存庫或工具的詳細資訊,請參閱供應商的文件,以了解如何複製儲存庫、變更檔案,然後推送程式碼。

  1. 如果您使用 AWS CodeStar 控制台創建AWS Cloud9開發環境,請開啟開發環境,然後跳到此程序的步驟 3。若要開啟開發環境的詳細資訊,請參閱開啟專案的 AWS Cloud9 環境

    若在 AWS CodeStar 主控台開啟專案,請在導覽列中選擇儲存庫。InClone 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 (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 現有使用者清單。

      In項目角色中,選擇此使用者的 AWS CodeStar 角色(擁有者、作者或檢視者)。這是 AWS CodeStar 專案層級角色,唯有專案的擁有者能進行變更。當您將角色套用至 IAM 使用者時,其會提供存取 AWS CodeStar 專案資源所需的所有許可。它會針對在 IAM 中建立和管理儲存在 CodeCommit 的程式碼的 Git 登入資料,或是在 IAM 中上傳使用者的 Amazon EC2 SSH 密鑰創建和管理。

      重要

      除非您是以使用者的身分登入主控台,否則無法提供或變更該使用者的顯示名稱或電子郵件資訊。如需詳細資訊,請參閱 管理您的 AWS CodeStar 使用者設定檔的顯示資訊

      選擇新增團隊成員

    • 如果 IAM 使用者中沒有要新增至該專案的對象,請選擇建立新 IAM 使用者。您將被重定向到 IAM 控制台,您可以在其中創建新 IAM 用户,請參閲建立 IAM 使用者中的IAM 使用者指南以了解詳細資訊。創建 IAM 用户後,返回 AWS CodeStar 控制台,刷新用户列表,然後從下拉列表中選擇您創建的 IAM 用户。輸入您要套用至此新使用者的 AWS CodeStarDisplay 名稱、電子郵件地址和專案角色,然後選擇新增團隊成員

    注意

    為了方便管理,您應該將專案的 Owner (擁有者) 角色指派給至少一個使用者。

  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. 在 中刪除確認頁面中,輸入刪除。維持刪除資源如果要刪除項目資源,則選中此選項。選擇 Delete (刪除)。

    刪除專案可能需要幾分鐘的時間。在 AWS CodeStar 主控台中刪除專案後,該專案將不再顯示在專案列表中。

    重要

    如果專案是使用 AWS 外部的資源 (如 GitHub 儲存庫或 Atlassian JIRA 中的問題),則即使您勾選核取方塊,系統仍不會刪除這類資源。

    如果您將任何 AWS CodeStar 託管政策手動連接至非 IAM 使用者的角色,便無法刪除專案。在專案受管政策是連接至聯合身分使用者角色的情況下,您必須先分離該政策,才能刪除專案。如需詳細資訊,請參閱 將 AWS 受 CodeStar 管政策與聯合身分使用者的角色分離

步驟 7:讓您的專案做好適用於生產環境的就緒

在建立專案後,您可以隨時建立、測試和部署程式碼。檢閱下列有關維護生產環境中的專案考量:

  • 定期套用修補程式,並針對應用程式所使用的依存項目,檢閱其安全最佳實務。如需詳細資訊,請參閱 AWS CodeStar 資源的安全最佳實務

  • 定期監控您的專案程式設計語言所建議的環境。

後續步驟

以下一些其他資源可幫助您瞭解 AWS CodeStar: