S3 Logging

5 min

Resumo

Gerenciar o recurso de registro de um bucket s3 na AWS

Requisitos

Os requisitos abaixo são necessários no host que executa este módulo.

bot3 >= 1.15.0
botocore >= 1.18.0

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
aws_access_key	string		AWS access key. Se não for definido, o valor da variável AWS_ACCESS_KEY_ID de ambiente AWS_ACCESS_KEY ou EC2_ACCESS_KEY será usado. Se o profile for definido, este parâmetro será ignorado.
aws_ca_bundle	path		A localização de um CA Bundle a ser usado ao validar certificados SSL. Não usado por módulos baseados em boto 2. Observação: o CA Bundle é lido no lado do 'módulo' e pode precisar ser copiado explicitamente do controlador se não for executado localmente.
aws_config	dictionary		Um dicionário para modificar a configuração do botocore. Os parâmetros podem ser encontrados em https://botocore.amazonaws.com. Apenas a chave 'user_agent' é usada para módulos boto. Consulte http://boto.cloudhackers.com para obter mais configurações de boto.
aws_secret_key	string		AWS secret key. Se não for definido, o valor da variável de ambiente AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY ou EC2_SECRET_KEY será usado. Se o perfil for definido, este parâmetro será ignorado.
debug_botocore_endpoint_logs	boolean	Escolhas: - false - true	Use um registrador botocore.endpoint para analisar as chamadas de API "resource:action" exclusivas (em vez de totais) feitas durante uma tarefa, enviando o conjunto para a chave resource_actions nos resultados da tarefa. Use o retorno de chamada aws_resource_action para gerar a lista total feita durante um playbook. A variável de ambiente ANSIBLE_DEBUG_BOTOCORE_LOGS também pode ser usada.
ec2_url	string		URL a ser usada para conectar-se ao EC2 ou à sua nuvem Eucalyptus (por padrão, o módulo usará endpoints do EC2). Ignorado para módulos onde a região é necessária. Deve ser especificado para todos os outros módulos se a região não for usada. Se não for definido, o valor da variável de ambiente EC2_URL, se houver, será usado.
name - required	string		Nome do bucket s3.
profile	string		O uso do profile substituirá aws_access_key, aws_secret_key e security_token e o suporte para passá-los ao mesmo tempo em que o perfil foi descontinuado.
region	string		A região da AWS a ser usada. Se não for especificado, o valor da variável de ambiente AWS_REGION ou EC2_REGION, se houver, será usado. Consulte http://docs.aws.amazon.com
security_token	string		AWS STS security token. Se não for definido, o valor da variável de ambiente AWS_SECURITY_TOKENou EC2_SECURITY_TOKENserá usado. Se o perfil for definido, este parâmetro será ignorado.
state	string	Escolhas: - present (default) - absent	Ative ou desative o registro.
target_bucket	string		O bucket no qual efetuar login. Necessário quando state = present.
target_prefix	string	Default: - ""	O prefixo que deve ser anexado aos arquivos de log gerados gravados no target_bucket.
validate_certs	boolean	Escolhas: - false - true(default)	Quando definido como "false", os certificados SSL não serão validados para comunicação com as APIs da AWS.

Extende fragmentos da documentação do módulo aws e ec2.

Notas

Se os parâmetros não forem definidos no módulo, as seguintes variáveis de ambiente podem ser usadas em ordem decrescente de precedência:
- AWS_URL ou EC2_URL,
- AWS_PROFILE ou AWS_DEFAULT_PROFILE,
- AWS_ACCESS_KEY_ID ou AWS_ACCESS_KEY ou EC2_ACCESS_KEY,
- AWS_SECRET_ACCESS_KEY ou AWS_SECRET_KEY ou EC2_SECRET_KEY,
- AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN,
- AWS_REGION ou EC2_REGION,
- AWS_CA_BUNDLE
Quando nenhuma credencial é fornecida explicitamente, o AWS SDK (boto3) que o Ansible usa retornará aos seus arquivos de configuração (normalmente ~/.aws/credentials). Consulte https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html para obter mais informações.
Módulos baseados no AWS SDK original (boto) podem ler sua configuração padrão de arquivos diferentes. Consulte https://boto.readthedocs.io/en/latest/boto_config_tut.html para obter mais informações.
AWS_REGION ou EC2_REGION pode ser normalmente usado para especificar a região da AWS, quando necessário, mas isso também pode ser definido nos arquivos de configuração.

Exemplos

# Observação: esses exemplos não definem detalhes de autenticação, consulte o AWS Guide para obter detalhes.

- name: Habilitar o registro do s3 bucket mywebsite.com para s3 bucket mylogs
  s3_logging:
    name: mywebsite.com
    target_bucket: mylogs
    target_prefix: logs/mywebsite.com
    state: present

- name: Remover o registro em um bucket s3
  s3_logging:
    name: mywebsite.com
    state: absent