Глибинний аналіз: створення цілей Event Bridge в AWS за допомогою Terraform

8 Березня 2024 в 00:09 28

Робота з інфраструктурою як код (Infrastructure as Code, IaC) є фундаментальним аспектом сучасних обчислювальних середовищ, особливо при використанні хмарних технологій. Terraform від HashiCorp став ключовим інструментом в цій області, дозволяючи розробникам та системним адміністраторам ефективно управляти ресурсами AWS, включно зі створенням і конфігурацією Event Bridge.

Event Bridge – це масштабований серверний обробник подій, що дозволяє автоматизувати взаємодію між різними AWS сервісами та зовнішніми додатками за допомогою подій. Він є потужним інструментом для створення зв’язаних систем, що реагують на стан вашого додатку чи інфраструктури в реальному часі.

Вступ до проблеми

Під час роботи з Event Bridge через Terraform, користувачі можуть зіткнутися з помилками при спробі створити ціль для правила Event Bridge. Це особливо актуально, коли ціль пов’язана зі скриптом Python, що виконується на EC2 екземплярі через документ SSM з допомогою запланованого правила, яке має спрацьовувати кожні 20 хвилин.

Аналіз проблеми

Помилка, з якою стикаються користувачі, пов’язана з неправильним форматуванням JSON в конфігурації цілі Event Bridge в Terraform скрипті. AWS очікує специфічну структуру даних, і будь-яке відхилення може призвести до відмови у створенні цілі з видачею помилки валідації.

Розгортання рішення

Основою рішення є коректне використання параметрів у Terraform скрипті. Наведемо детальний приклад оновленого коду, який вирішує проблему валідації:

resource "aws_cloudwatch_event_target" "batch_job_2_target" {
    rule      = aws_cloudwatch_event_rule.hw_eb_rule.name
    arn       = aws_ssm_document.batch_job_script_2.arn
    role_arn  = "arn:aws:iam::1234567898:role/service-role/Amazon_EventBridge_Invoke_Run_Command_123456"
    target_id = "batch-job-script-2"
    input = jsonencode({
      "DocumentName" : "batch-job-script-2",
      "Targets": [{
        "Key": "InstanceIds",
        "Values": ["id-12345"]
      }],
      "Parameters": {
        "commands": [
          "python3 ./scheduler_script.py"
        ]
      }
    })
}

resource "aws_cloudwatch_event_target" "batch_job_2_target" {

rule = aws_cloudwatch_event_rule.hw_eb_rule.name

arn = aws_ssm_document.batch_job_script_2.arn

role_arn = "arn:aws:iam::1234567898:role/service-role/Amazon_EventBridge_Invoke_Run_Command_123456"

target_id = "batch-job-script-2"

input = jsonencode({

"DocumentName" : "batch-job-script-2",

"Targets": [{

"Key": "InstanceIds",

"Values": ["id-12345"]

}],

"Parameters": {

"commands": [

"python3 ./scheduler_script.py"

]

}

})

}

Цей приклад показує, як правильно структурувати JSON вхідні дані для цілі Event Bridge, що дозволяє безпроблемне створення за допомогою Terraform. Особливу увагу слід звернути на параметри DocumentName, Targets і Parameters, які повинні бути точно вказані згідно з вимогами AWS.

Поглиблений аналіз

Для кращого розуміння, чому саме така структура JSON є важливою, розглянемо ключові елементи, на які AWS звертає увагу при обробці запитів на створення цілей для Event Bridge:

DocumentName: Ідентифікує SSM документ, що має бути використаний як ціль.
Targets: Визначає цілі, до яких застосовується документ. У цьому контексті, це EC2 екземпляри, ідентифіковані через їх ID.
Parameters: Містить параметри, що передаються документу SSM при виклику, включаючи команди, які необхідно виконати.

Правильне розуміння і використання цих параметрів є ключовим для успішної інтеграції Terraform із сервісами AWS і, зокрема, з Event Bridge. Неправильне використання або відсутність необхідних параметрів призведе до помилок, що ускладнюють деплоймент і управління ресурсами.

Висновок

Інтеграція Terraform із AWS Event Bridge вимагає детального розуміння обох технологій та уваги до деталей при конфігурації ресурсів. Помилки, подібні до описаної, часто виникають через невідповідність між очікуваною структурою даних AWS і вхідними даними, наданими через Terraform. Виправлення цих помилок зазвичай вимагає ретельного перегляду конфігурації та забезпечення відповідності всіх необхідних параметрів. Сподіваємося, що цей аналіз допоможе уникнути подібних помилок у майбутньому та забезпечить більш ефективне використання Terraform для управління AWS ресурсами.