Executar manuais do Ansible via GitHub - AWS Systems Manager

Executar manuais do Ansible via GitHub

Esta seção inclui procedimentos para ajudar você a executar manuais do Ansible via GitHub usando o console ou a AWS Command Line Interface (AWS CLI).

Antes de começar

Se você planeja executar um script armazenado em um repositório privado do GitHub, crie um parâmetro SecureString do AWS Systems Manager para o token de acesso de segurança do GitHub. Você não pode acessar um script em um repositório privado do GitHub transmitindo manualmente o token via SSH. O token de acesso deve ser passado como um parâmetro SecureString do Systems Manager. Para obter mais informações sobre como criar um parâmetro SecureString, consulte Crie um parâmetro do Systems Manager.

Executar um manual do Ansible via GitHub (console)

Executar um manual do Ansible via GitHub
  1. Abra o console AWS Systems Manager em https://console.aws.amazon.com/systems-manager/.

  2. No painel de navegação, escolha Run Command.

  3. Selecione Run command.

  4. Na lista Command document (Documento do comando), escolha AWS-RunRemoteScript.

  5. Em Command parameters, faça o seguinte:

    • Em Tipo de origem, selecione GitHub.

    • Na caixa de texto Source Info (Informações da origem) insira as informações necessárias para acessar a origem no seguinte formato:

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

      Este exemplo faz download de um arquivo chamado webserver.yml.

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

      "branch" é necessário somente se o documento do SSM estiver armazenado em uma ramificação diferente de master.

      Para usar a versão de seus scripts que estão em uma confirmação específica no repositório, use commitID com getOptions em vez de branch. Por exemplo:

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

    • No campo Command Line (Linha de comando), digite os parâmetros para a execução do script. Aqui está um exemplo.

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

    • (Opcional) No campo Working Directory (Diretório de trabalho), insira o nome de um diretório do nó em que você deseja baixar e executar o script.

    • (Opcional) Em Execution Timeout, especifique o número de segundos para o sistema aguardar antes de a execução do comando de script falhar.

  6. Na seção Targets (Destinos), escolha os nós gerenciados nos quais você quer executar essa operação, especificando as etiquetas, selecionando as instâncias ou dispositivos de borda manualmente ou especificando um grupo de recursos.

    dica

    Se um nó gerenciado que você espera ver não estiver listado, consulte Solução de problemas de disponibilidade do nó gerenciado para obter dicas de solução de problemas.

  7. Para Other parameters (Outros parâmetros):

    • Em Comment (Comentário), digite as informações sobre esse comando.

    • Em Timeout (seconds) (Tempo limite [segundos]), especifique o número de segundos para o sistema aguardar até a falha de execução do comando total.

  8. Para Rate control (Controle de taxa):

    • Em Concurrency (Concorrência), especifique um número ou uma porcentagem de nós gerenciados nos quais executar o comando ao mesmo tempo.

      nota

      Se você selecionou destinos especificando tags aplicadas a instâncias a nós gerenciados ou especificando grupos de recursos da AWS, e não tiver certeza de quantas instâncias são direcionadas, restrinja o número de instâncias que poderão executar o documento ao mesmo tempo, especificando uma porcentagem.

    • Em Error threshold (Limite de erro), especifique quando parar de executar o comando em outros nós depois de falhar em alguns ou em uma porcentagem de nós. Por exemplo, se você especificar três erros, o Systems Manager deixará de enviar o comando quando o 4° erro for recebido. Os nós gerenciados que continuam processando o comando também podem enviar erros.

  9. (Opcional) Em Output options (Opções de saída), para salvar a saída do comando em um arquivo, selecione a caixa Write command output to an S3 bucket (Gravar saída do comando em um bucket do S3). Digite os nomes de bucket e prefixo (pastas) nas caixas de texto.

    nota

    As permissões do S3 que concedem a possibilidade de gravar os dados em um bucket do S3 são as do perfil de instância (para instâncias do EC2) ou perfil de serviço do IAM (máquinas ativadas para ambientes híbridos) atribuído à instância, e não as do usuário do IAM que realiza essa tarefa. Para obter mais informações, consulte Configurar permissões de instância obrigatórias para o Systems Manager ou Criar um perfil de serviço do IAM para um ambiente híbrido. Além disso, se o bucket do S3 especificado estiver em uma conta da Conta da AWS diferente, verifique se o perfil da instância ou a função de serviço do IAM associado ao nó gerenciado tenha as permissões necessárias para gravar nesse bucket.

  10. Na seção SNS notifications (Notificações do SNS), se quiser enviar notificações sobre o status da execução do comando, marque a caixa de seleção Enable SNS notifications (Habilitar notificações do SNS).

    Para obter mais informações sobre a configuração de notificações do Amazon SNS para o Run Command, consulte Monitorar alterações de status do Systems Manager usando as notificações do Amazon SNS.

  11. Escolha Executar.

Executar um manual do Ansible no GitHub usando a AWS CLI

  1. Instale e configure a AWS Command Line Interface (AWS CLI), caso ainda não o tenha feito.

    Para obter informações, consulte Instalar ou atualizar a versão mais recente da AWS CLI.

  2. Execute o comando a seguir para baixar e executar um script do 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"]}'

    Veja a seguir um comando de exemplo a ser executado em uma máquina Linux local.

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