从 GitHub 运行 Ansible Playbook - Amazon Systems Manager
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

从 GitHub 运行 Ansible Playbook

本部分包含帮助您使用控制台或从 GitHub 运行 Ansible Playbook 的过程Amazon Command Line Interface(Amazon CLI)。

开始前的准备工作

如果打算运行私有 GitHub 存储库中存储的脚本,请创建Amazon Systems Manager SecureString参数作为 GitHub 安全访问令牌。通过 SSH 手动传递令牌无法访问私有 GitHub 存储库中的脚本。访问令牌必须作为 Systems Manager 传递SecureString参数。有关创建 SecureString 参数的更多信息,请参阅创建 Systems Manager 参数

从 GitHub (控制台) 运行 Ansible Playbook

从 GitHub 中运行 Ansible Playbook

  1. 访问 https://console.aws.amazon.com/systems-manager/,打开 Amazon Systems Manager 控制台。

  2. 在导航窗格中,选择Run Command

    -或者-

    如果Amazon Systems Manager首先打开主页,选择菜单图标( )以打开导航窗格中的,然后选择Run Command

  3. 选择运行命令

  4. Command document (命令文档) 列表中,选择 AWS-RunRemoteScript

  5. 命令参数中,执行以下操作:

    • 源类型中,选择 GitHub

    • 源信息框中,按以下格式输入访问源所需的信息。

      { "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",

    • 命令行字段中,输入脚本执行的参数。以下是示例。

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

    • (可选)在工作目录字段中,输入实例上要在其中下载和运行脚本的目录的名称。

    • (可选) 在执行超时中,指定脚本命令执行失败之前系统要等待的秒数。

  6. 目标部分,通过手动指定标签、手动选择实例或指定资源组来标识您要对其运行该操作的实例。

    注意

    如果您希望看到的 Amazon EC2 实例未列出,请参阅Amazon EC2 托管实例可用性疑难解答了解故障排除提示。

  7. 对于其他参数

    • 适用于注释中,输入有关此命令的信息。

    • 对于超时 (秒),请指定在整个命令执行失败之前系统等待的秒数。

  8. 适用于速率控制

    • 对于并发,请指定要同时运行该命令的实例数或百分比。

      注意

      如果您通过指定应用于托管实例的标签或指定Amazon资源组,但不确定有多少个实例需要,则可以通过指定百分比来限制可同时运行此文档的实例的数量。

    • 对于错误阈值,请指定在一定数量或百分比的实例上失败后何时在其他实例上停止运行该命令。例如,如果您指定三个错误,Systems Manager 将在收到第四个错误时停止发送该命令。仍在处理命令的实例也可能发送错误。

  9. (可选)对于 Output options (输出选项),要将命令输出保存到文件,请选中 Write command output to an S3 bucket (将命令输出写入 S3 存储桶) 框。在框中输入存储桶和前缀(文件夹)名称。

    注意

    授予将数据写入 S3 存储桶的能力的 S3 权限是分配给实例的实例配置文件的权限,而不是执行此任务的 IAM 用户的权限。有关更多信息,请参阅 。为创建 IAM 实例配置文件。此外,如果指定 S3 存储桶位于不同的 Amazon Web Services 账户 ,请确保与该实例关联的实例配置文件具有写入该存储桶的必要权限。

  10. SNS 通知部分,如果需要发送有关命令执行状态的通知,请选中启用 SNS 通知”复选框。

    有关为 Run Command 配置 Amazon SNS 通知的更多信息,请参阅使用 Amazon SNS 通知监控 Systems Manager 状态更改

  11. 选择运行

使用 Amazon CLI 从 GitHub 运行 Ansible Playbook

  1. 安装和配置Amazon Command Line Interface(Amazon CLI),如果您尚未启动。

    想要了解有关信息,请参阅安装或升级Amazon命令行工具

  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"]}'