AMI 和容器產品使用說明 - AWS Marketplace

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

AMI 和容器產品使用說明

為產品建立使用說明時,您必須包含下列資訊:

  • 客戶儲存的所有敏感資訊的位置

  • 說明所有資料加密組態

  • 輪換程式設計系統憑證和密碼編譯金鑰的 S tep-by-step 指示。基於 AMI 的產品要求 說明使用憑證和密碼編譯金鑰之清單的基本需求。

  • 如果應用程式使用任何加密技術,請提供使用者如何與您的應用程式互動以解密必要資料的詳細說明

  • S 有關如何評估和監控應用程式運作狀態和適當功能tep-by-step 的指示。例如:

    • 導覽至 Amazon EC2主控台,並驗證您位於正確的區域。

    • 選擇執行個體,然後選擇啟動的執行個體。

    • 選取要顯示中繼資料頁面的伺服器,然後選擇頁面底部的狀態檢查索引標籤,以檢閱您的狀態檢查是否通過或失敗。

撰寫版本備註

每次更新產品時,您必須提供版本備註中變更的說明。版本備註應包含特定資訊,以協助使用者決定是否安裝更新。使用清晰的標籤進行更新,例如「重要」進行安全更新,或「重要」或「選用」進行其他類型的更新。

撰寫使用說明

提供使用指示,協助確保買方能夠成功設定和執行軟體。您提供的使用說明會在組態程序中顯示。

若要撰寫有效的使用說明,請遵循下列準則:

  • 假設使用者感興趣,但沒有資訊。

  • 提供使用者啟動和使用產品所需的所有資訊,包括任何組態設定和特殊步驟。

範例使用說明:

  1. 透過 1-Click 啟動產品。

  2. 使用 Web 瀏覽器存取應用程式,網址為 https://<EC2_Instance_Public_DNS>/index.html。

  3. 使用下列憑證登入:

    • 使用者名稱:使用者

    • 密碼:執行個體的 instance_id

撰寫升級指示

提供買方如何從舊版產品升級的詳細資訊。包含有關如何在建立另一個執行個體時保留資料和設定的資訊。如果沒有升級路徑,請編輯此欄位以特別提及。

升級指示範例:

  1. 執行 ****,然後執行 ****。

  2. 透過執行 ***,檢查專案使用的所有外掛程式是否與版本 *.* 相容。如果不相容,請執行 ***。

  3. 透過執行 *** 來備份您的資料。

撰寫 CloudFormation 交付指示

使用 CloudFormation 交付時,您還必須包含下列項目:

  • 範本建立的每個 AWS Identity and Access Management (IAM) AWS CloudFormation 角色和IAM政策的目的

  • 範本建立的每個金鑰的目的和位置 AWS CloudFormation

  • 部署中涉及多個元素的網路組態詳細資訊

  • 有關如何啟動應用程式的詳細指南,以及部署是否包含多個 AWS 資源時如何設定它們進行通訊的詳細指南

  • 定價明細,包含執行超過標準限制之新增 AWS 資源的成本。提供有關管理 AWS 服務限制的規範性指引。

  • 所有資料加密組態。例如:Amazon S3 伺服器端加密、Amazon Elastic Block Store (Amazon EBS) 加密、Linux Unified Key Setup (LUKS) 等)

監控和評估應用程式函數

監控和評估應用程式函數
  1. 導覽至 Amazon EC2主控台,並驗證您位於正確的區域。

  2. 選擇執行個體,然後選擇啟動的執行個體。

  3. 選取要顯示中繼資料頁面的伺服器,然後選擇頁面底部的狀態檢查索引標籤,以檢閱您的狀態檢查是否通過或失敗。

注意

如果任何資料存放區為專屬,請提供組態、備份和復原 step-by-step 的指示。

輪換程式設計系統憑證和密碼編譯金鑰

基於 AMI 的產品要求 說明使用憑證和密碼編譯金鑰之清單的基本需求。

包括下列輪換程式設計系統憑證和密碼編譯金鑰:
  • 管理 AWS 服務配額的規範性指引。如需詳細資訊,請參閱 AWS 一般參考指南

  • 定價明細,包括高於標準配額的執行 AWS 資源成本。這可以包含在產品使用說明中,或連結至包含有關管理和請求增加服務配額的詳細資訊的文件