Rola Ansible: christiangda.amazon_cloudwatch_agent

Ta rola instaluje agenta AWS CloudWatch.

Najlepszym sposobem na zainstalowanie tej roli jest używanie polecenia ansible-galaxy install christiangda.amazon_cloudwatch_agent, a repozytorium Ansible Galaxy to christiangda.amazon_cloudwatch_agent.

Kod repozytorium znajduje się pod adresem https://github.com/christiangda/ansible-role-amazon-cloudwatch-agent.

Cechy:

• Działa na instancjach AWS EC2/instancjach lokalnych.
• Wsparcie dla różnych wersji Pythona, Ansible i systemów operacyjnych (zobacz macierz integracji ciągłej dla szczegółów).
• Pobiera i instaluje agenta CloudWatch z pakietu dystrybucyjnego AWS.
• Przeładowuje usługę po zmianie konfiguracji.
• Oferuje domyślny plik konfiguracji agenta (minimalna konfiguracja, niezalecana).
• Rotuje plik dziennika agenta CloudWatch.
• Pozwala na załadowanie własnego pliku JSON / pliku YAML lub konfiguracji INLINE dla sekcji agenta, metryk i dzienników.
• Obsługuje architektury amd64 i arm64.

Uwagi:

• Wersja 2.x.y nie jest zgodna z wersją 1.x.y.
• Od wersji 2.x.y ta rola nie instaluje domyślnie repozytorium EPEL, teraz musisz to zrobić samodzielnie, polecam moją rolę Ansible christiangda.epel_repo.
• Od wersji 2.x.y ta rola nie tworzy profilów AWS CLI (konfiguracja i dane uwierzytelniające), teraz musisz to zrobić samodzielnie, polecam moje rolę Ansible christiangda.awscli oraz christiangda.awscli_configure. Zobacz przykłady poniżej (gdy cwa_agent_mode: "onPremise").
• Automatycznie instaluje pakiet collectd OS po wykryciu użycia Pobierania metryk niestandardowych z collectd w pliku konfiguracyjnym. W zależności od OS, pakiet collectd może wymagać repozytorium EPEL.
• Użytkownicy RedHat Muszą mieć ważną subskrypcję, aby uniknąć problemów z instalacją pakietów zależnych.

Więcej szczegółów w VERSION.md.

Wymagania

Ta rola działa na dystrybucjach RedHat, CentOS, Amazon Linux, Debian i Ubuntu.

• RedHat
  • 7
  • 8
• CentOS
  • 7
  • 8
  • stream8
• Rocky Linux
  • 8
  • 9
• Amazon Linux
  • 2
• Ubuntu
  • 14.04 (*)
  • 16.04 (*)
  • 18.*
  • 20.*
  • 21.*
  • 22.*
• Debian
  • Stretch (9)
  • buster (10)
  • bullseye (11)
  • Bookworm (12)

Aby zobaczyć macierz zgodności wersji Pythona i Ansible, zobacz macierz budowania Travis-CI.

Zmienne roli

Zmienna	Wartość domyślna
cwa_conf_json_file_content	"" --> Pusty
cwa_agent_mode	"ec2"
cwa_aws_region	""
cwa_use_credentials	false
cwa_profile	"AmazonCloudWatchAgent"
cwa_agent_profile_path	/root
cwa_http_proxy	"" --> Pusty
cwa_https_proxy	"" --> Pusty
cwa_no_proxy	"169.254.169.254"
cwa_logrotate_file_size	"10M"
cwa_logrotate_files	5
cwa_debug	false

Więcej szczegółów: Zobacz plik defaults/main.yaml.

Zależności

• W przypadku rodziny systemów operacyjnych RedHat/Centos może być konieczne użycie repozytorium EPEL.
• Jeśli ustawisz cwa_agent_mode: "onPremise", konieczna jest konfiguracja profilu AWS CLI.
• Jeśli pobierasz metryki niestandardowe z collectd, pakiet collectd zostanie zainstalowany automatycznie, a w zależności od OS, repozytorium EPEL może być konieczne.

Przykładowy Playbook

Gdy cwa_agent_mode: "onPremise"

# Powinieneś użyć ansible-vault do jego skonfigurowania
# Przykład:
# ansible-vault encrypt_string --ask-vault-pass --name 'cwa_access_key' 'AKIAIOSFODNN7EXAMPLE'
# ansible-vault encrypt_string --ask-vault-pass --name 'cwa_secret_key' 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'

- hosts: servers
    gather_facts: True
    roles:
      - role: christiangda.epel_repo # Jeśli nie masz zainstalowanego repozytorium EPEL
        when: >
          ansible_os_family == 'RedHat' and (
            ansible_distribution == 'CentOS' or
            ansible_distribution == 'RedHat' or
            ansible_distribution == 'Amazon'
          )
      - role: christiangda.awscli_configure # Jeśli nie masz skonfigurowanych profili AWS CLI
        vars:
          awscliconf_path: '/root'
          awscliconf_files:
            credentials:
              - AmazonCloudWatchAgent:
                  aws_access_key_id: !vault |
                    $ANSIBLE_VAULT;1.1;AES256
                    30376338613338326663373366303234623665633339303338613463313564633832363237306137
                    3362643039616631323339383332306536333962346133310a383265376665316235653261616136
                    61306566623531356263346439633761633830323636646236373736353530396134636536666532
                    3939636433636364310a316639366139366566623337623536346661633339343766323936346336
                    65333035366635396138656132643262626438333961326266396466626464643766
                  aws_secret_access_key: !vault |
                    $ANSIBLE_VAULT;1.1;AES256
                    65643230613939303737336632346432393234616437383532386139616364316233333933643735
                    6633636261383163323362623562323333323533336564310a323030343431366135343035326635
                    33623161376634643939636464306139386662303034616531346632303039643238373834616266
                    3064623232373233610a346432646565396235316631626137653731376365333531323866626665
                    62656638623330643539653763636364363738653932653831316238633939356462653636633463
                    6130613761633565616533633332376565373062396565396261
            config:
              - profile AmazonCloudWatchAgent:
                  region: "eu-west-1"
      - role: christiangda.amazon_cloudwatch_agent # Używając minimalnej konfiguracji agenta dostarczonej przez rolę
          vars:
              cwa_agent_mode: "onPremise"
              cwa_aws_region: "eu-west-1"
              cwa_profile: "AmazonCloudWatchAgent"

Gdy cwa_agent_mode: "ec2"

Odczytując plik konfiguracyjny z pliku konfiguracyjnego JSON

---
- hosts: servers
    gather_facts: True
    roles:
      - role: christiangda.amazon_cloudwatch_agent # Używając pliku JSON dostarczonego przez Ciebie w lokalizacji `files/CloudWatch.json` w odniesieniu do tego playbooka
          vars:
              cwa_agent_mode: "ec2"
              cwa_conf_json_file_content: "{{ lookup('file', 'files/CloudWatch.json') | from_json }}"

Odczytując plik konfiguracyjny z pliku konfiguracyjnego YAML

---
- hosts: servers
    gather_facts: True
    roles:
      - role: christiangda.amazon_cloudwatch_agent # Używając pliku YAML dostarczonego przez Ciebie w lokalizacji `files/CloudWatch.yaml` w odniesieniu do tego playbooka
          vars:
              cwa_agent_mode: "ec2"
              cwa_conf_json_file_content: "{{ lookup('file', 'files/CloudWatch.yaml') | from_yaml }}"

Używając konfiguracji INLINE YAML

---
- hosts: centos7, centos6, ubuntu1804, ubuntu1810, debian8, debian9, amzn2
  become: True
  roles:
    - role: christiangda.epel_repo # Jeśli nie masz zainstalowanego repozytorium EPEL
        when: >
          ansible_os_family == 'RedHat' and (
            ansible_distribution == 'CentOS' or
            ansible_distribution == 'RedHat' or
            ansible_distribution == 'Amazon'
          )
      - role: christiangda.awscli_configure # Jeśli nie masz skonfigurowanych profili AWS CLI
        vars:
          awscliconf_path: '/root'
          awscliconf_files:
            credentials:
              - AmazonCloudWatchAgent:
                  aws_access_key_id: !vault |
                    $ANSIBLE_VAULT;1.1;AES256
                    30376338613338326663373366303234623665633339303338613463313564633832363237306137
                    3362643039616631323339383332306536333962346133310a383265376665316235653261616136
                    61306566623531356263346439633761633830323636646236373736353530396134636536666532
                    3939636433636364310a316639366139366566623337623536346661633339343766323936346336
                    65333035366635396138656132643262626438333961326266396466626464643766
                  aws_secret_access_key: !vault |
                    $ANSIBLE_VAULT;1.1;AES256
                    65643230613939303737336632346432393234616437383532386139616364316233333933643735
                    6633636261383163323362623562323333323533336564310a323030343431366135343035326635
                    33623161376634643939636464306139386662303034616531346632303039643238373834616266
                    3064623232373233610a346432646565396235316631626137653731376365333531323866626665
                    62656638623330643539653763636364363738653932653831316238633939356462653636633463
                    6130613761633565616533633332376565373062396565396261
            config:
              - profile AmazonCloudWatchAgent:
                  region: "eu-west-1"
    - role: christiangda.amazon_cloudwatch_agent # Używając ONLINE konfiguracji YAML dla Twojego agenta
      vars:
        cwa_agent_mode: onPremise
        cwa_aws_region: "eu-west-1"
        cwa_profile: "AmazonCloudWatchAgent"
        cwa_conf_json_file_content:
          agent:
            metrics_collection_interval: 60
            region: es-west-1
            logfile: "/opt/aws/amazon-cloudwatch-agent/logs/amazon-cloudwatch-agent.log"
            debug: false
          metrics:
            metrics_collected:
              cpu:
                resources:
                  - "*"
                measurement:
                  - name: cpu_usage_idle
                    rename: CPU_USAGE_IDLE
                    unit: Percent
                  - name: cpu_usage_nice
                    unit: Percent
                  - cpu_usage_guest
                totalcpu: false
                metrics_collection_interval: 10
                append_dimensions:
                  test: test1
                  date: "2017-10-01"
              netstat:
                measurement:
                  - tcp_established
                  - tcp_syn_sent
                  - tcp_close
                metrics_collection_interval: 60
              processes:
                measurement:
                  - running
                  - sleeping
                  - dead
            append_dimensions:
              ImageId: "${aws:ImageId}"
              InstanceId: "${aws:InstanceId}"
              InstanceType: "${aws:InstanceType}"
              AutoScalingGroupName: "${aws:AutoScalingGroupName}"
            aggregation_dimensions:
              - - AutoScalingGroupName
              - - InstanceId
                - InstanceType
              - []
          logs:
            logs_collected:
              files:
                collect_list:
                  - file_path: "/opt/aws/amazon-cloudwatch-agent/logs/amazon-cloudwatch-agent.log"
                    log_group_name: amazon-cloudwatch-agent.log
                    log_stream_name: amazon-cloudwatch-agent.log
                    timezone: UTC
                  - file_path: "/opt/aws/amazon-cloudwatch-agent/logs/test.log"
                    log_group_name: test.log
                    log_stream_name: test.log
                    timezone: Local
            log_stream_name: my_log_stream_name
            force_flush_interval: 15

Minimalna konfiguracja na instancji AWS EC2

---
- hosts: all
    gather_facts: True
    become: true
    become_user: root
    become_method: sudo
    remote_user: ec2-user
    roles:
    - role: christiangda.amazon_cloudwatch_agent # Zakładając, że jesteś na "instancji EC2" i używasz domyślnej konfiguracji agenta z roli

Przykład pliku inwentarza (inventory)

[all]
10.14.x.y
10.14.v.z

[amazon-1]
10.14.x.y

[amazon-2]
10.14.v.z

Jak to użyć

ansible-playbook my-playbook.yml \
    --inventory inventory \
    --private-key [~/lokalizacja mojego klucza.pem] \
    --become \
    --become-user=ec2-user \
    --user ec2-user

Rozwój / Wkład

Ta rola jest testowana za pomocą Molecule i była rozwijana przy użyciu Wirtualnych Środowisk Python.

Używamy również dwóch głównych gałęzi git:

• master
• develop

Jeżeli chcesz wnieść wkład w ten projekt, co powinieneś zrobić:

• Fork projektu
• Przygotuj swoje środowisko
• Napraw problem w gałęzi develop
• Wykonaj molecule test
• Stwórz Pull Request do oficjalnej gałęzi projektu develop.

Odniesienia:

• Fork repozytorium
• Tworzenie pull requesta z forka

Przygotuj swoje środowisko

• Python 3

mkdir ansible-roles
cd ansible-roles/

python3 -m venv venv
source venv/bin/activate
pip install pip --upgrade
pip install ansible
pip install molecule
pip install 'molecule[docker]'
pip install 'molecule[podman]'
pip install 'molecule[lint]'
pip install molecule-vagrant
pip install python-vagrant
pip install selinux
pip install docker
pip install pytest
pip install pytest-mock
pip install pylint
pip install rope
pip install autopep8
pip install yamllint
pip install flake8
pip install ansible-lint

Klonuj repozytorium roli (z twojego forka) i stwórz link symboliczny

UWAGA: Najpierw wykonaj fork głównego repozytorium.

git clone https://github.com/<twoje nazwa użytkownika na github>/ansible-role-amazon-cloudwatch-agent.git
ln -s ansible-role-amazon-cloudwatch-agent christiangda.amazon_cloudwatch_agent
cd christiangda.amazon_cloudwatch_agent

Wykonaj test molekuły

Dostępne scenariusze:

• default --> --driver-name docker
• podman --> --driver-name podman
• vagrant --> --driver-name vagrant

scenariusz default

Krok po kroku

molecule create [--scenario-name default]
molecule converge [--scenario-name default]
molecule verify [--scenario-name default]
molecule destroy [--scenario-name default]

lub

Wszystko w jednym

molecule test [--scenario-name default]

scenariusz podman

Krok po kroku

molecule create --scenario-name podman
molecule converge --scenario-name podman
molecule verify --scenario-name podman
molecule destroy --scenario-name podman

lub

Wszystko w jednym

molecule test --scenario-name podman

scenariusz vagrant

Krok po kroku

molecule create --scenario-name vagrant
molecule converge --scenario-name vagrant
molecule verify --scenario-name vagrant
molecule destroy --scenario-name vagrant

lub

Wszystko w jednym

molecule test --scenario-name vagrant

Dodatkowo, jeśli chcesz przetestować to używając VM, mam bardzo fajny projekt ansible-playground który używa Vagrant i VirtualBox, spróbuj!

Licencja

Ten moduł jest wydany na licencji GNU General Public License w wersji 3:

• http://www.gnu.org/licenses/gpl-3.0-standalone.html

Informacje o autorze

• Christian González Di Antonio