從 GitHub 執行 Ansible Playbook - AWS Systems Manager

從 GitHub 執行 Ansible Playbook

本節所涵蓋的程序能協助您使用主控台或 AWS Command Line Interface (AWS CLI) 從 GitHub 執行 Ansible Playbook。

開始之前

如果您打算執行存放在私有 GitHub 儲存庫中的指令碼,則要為 GitHub 安全存取權杖建立 AWS Systems Manager SecureString 參數。若透過 SSH 手動傳遞權杖,則無法存取私有 GitHub 儲存庫中的指令碼。您必須將存取字符做為 Systems Manager SecureString 參數傳遞。如需建立 SecureString 參數的詳細資訊,請參閱 在 Systems Manager 中建立 Parameter Store 參數

從 GitHub 執行 Ansible Playbook (主控台)

從 GitHub 執行 Ansible Playbook
  1. 開啟位於 https://console.aws.amazon.com/systems-manager/ 的 AWS Systems Manager 主控台。

  2. 在導覽窗格中,選擇 Run Command

  3. 選擇執行命令

  4. Command document (命令文件) 清單,請選擇 AWS-RunRemoteScript

  5. 命令參數中,執行以下操作:

    • 來源類型中,選取 GitHub

    • Source Info (來源資訊) 方塊中,按照以下格式輸入所需資訊,藉此存取來源。

      { "owner": "owner_name", "repository": "repository_name", "getOptions": "branch:branch_name", "path": "path_to_scripts_or_directory", "tokenInfo": "{{ssm-secure:SecureString_parameter_name}}" }

      此範例會下載名為 webserver.yml 的檔案。

      { "owner": "TestUser1", "repository": "GitHubPrivateTest", "getOptions": "branch:myBranch", "path": "scripts/webserver.yml", "tokenInfo": "{{ssm-secure:mySecureStringParameter}}" }
      注意

      只有當 SSM 文件存放於 master 以外的分支時,才需要 "branch"

      若要使用存放庫中特定「遞交」中的指令碼版本,請使用 commitIDgetOptions 來代替 branch。例如:

      "getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",

    • Command Line (命令列) 欄位中,輸入指令碼執行參數。請見此處範例。

      ansible-playbook -i “localhost,” --check -c local webserver.yml

    • (選用) 在 Working Directory (工作目錄) 欄位中,輸入節點上的目錄名稱;您將下載指令碼至該目錄並予以執行。

    • (選用) 在執行逾時中,指定指令碼命令執行失敗前,系統的等待時間 (秒)。

  6. Targets (目標) 區段中,透過手動指定標籤、選取執行個體或邊緣裝置,或指定資源群組,選擇您要執行這項操作的受管節點。

    提示

    如果您預期看到的受管節點未列出,請參閱 疑難排解受管節點的可用性 以取得疑難排解秘訣。

  7. 對於其他參數

    • Comment (註解) 中,輸入此命令的相關資訊。

    • 逾時 (秒) 中,指定在命令執行全面失敗之前,系統要等候的秒數。

  8. 對於 Rate control (速率控制):

    • 並行中,指定可同時執行命令的受管節點數目或百分比。

      注意

      如果透過指定套用至受管節點的標籤或指定 AWS 資源群組選取了目標,且您不確定會以多少個受管節點為目標,則透過指定百分比限制可以同時執行文件之目標的數量。

    • Error threshold (錯誤閾值) 中,指定在特定數目或百分比之節點上的命令失敗之後,停止在其他受管節點上執行命令。例如,如果您指定三個錯誤,則 Systems Manager 會在收到第四個錯誤時停止傳送命令。仍在處理命令的受管節點也可能會傳送錯誤。

  9. (選用) 針對輸出選項,若要將命令輸出儲存至檔案,請選取將命令輸出寫入至 S3 儲存貯體方塊。在方塊中輸入儲存貯體和字首 (資料夾) 名稱。

    注意

    授予能力以將資料寫入至 S3 儲存貯體的 S3 許可,會是指派給執行個體之執行個體設定檔 (適用於 EC2 執行個體) 或 IAM 服務角色 (啟用混合模式的機器) 的許可,而不是執行此任務之 IAM 使用者的許可。如需詳細資訊,請參閱設定 Systems Manager 所需的執行個體許可建立混合環境的 IAM 服務角色。此外,若指定的 S3 儲存貯體位於不同的 AWS 帳戶 內,請確保與受管節點相關聯的執行個體設定檔或 IAM 服務角色是否具有寫入該儲存貯體的必要許可。

  10. SNS 通知區段中,如果您要傳送有關命令執行狀態的通知,請選取啟用 SNS 通知核取方塊。

    如需為 Run Command 設定 Amazon SNS 通知的詳細資訊,請參閱 使用 Amazon SNS 通知監控 Systems Manager 狀態變更

  11. 選擇執行

使用 AWS CLI 從 GitHub 執行 Ansible Playbook

  1. 如果您尚未安裝並設定 AWS Command Line Interface (AWS CLI),請進行相應的操作。

    如需相關資訊,請參閱安裝或更新最新版本的 AWS CLI

  2. 執行以下命令,即可從 GitHub 下載指令碼並予以執行。

    aws ssm send-command \ --document-name "AWS-RunRemoteScript" \ --instance-ids "instance-IDs"\ --parameters '{"sourceType":["GitHub"],"sourceInfo":["{\"owner\":\"owner_name\", \"repository\": \"repository_name\", \"path\": \"path_to_file_or_directory\", \"tokenInfo\":\"{{ssm-secure:name_of_your_SecureString_parameter}}\" }"],"commandLine":["commands_to_run"]}'

    以下是在本機 Linux 機器上執行的範例命令。

    aws ssm send-command \ --document-name "AWS-RunRemoteScript" \ --instance-ids "i-02573cafcfEXAMPLE" \ --parameters '{"sourceType":["GitHub"],"sourceInfo":["{\"owner\":\"TestUser1\", \"repository\": \"GitHubPrivateTest\", \"path\": \"scripts/webserver.yml\", \"tokenInfo\":\"{{ssm-secure:mySecureStringParameter}}\" }"],"commandLine":["ansible-playbook -i “localhost,” --check -c local webserver.yml"]}'