Как я могу быстро и эффективно отлаживать шаблоны CloudFormation?

Используйте команду aws cloudformation validate-template в инструменте AWS CLI. . Он только проверяет, является ли ваш шаблон допустимым JSON или YAML, а не правильность ваших ключей и значений (например, не проверяет опечатки в ключах).

Другой вариант, год спустя, - абстрагировать эти шаблоны в стороннюю библиотеку, такую ​​как troposphere. Эта библиотека создает для вас полезную нагрузку JSON и попутно выполняет множество проверок. Это также решает проблему «Вау, управлять файлом JSON с 1000 строками, конечно, очень печально».

Как я могу ускорить процесс отладки шаблона, или я застрял навсегда, замечая свои ошибки через полчаса после их совершения?

Вот несколько практических советов, специально посвященных повышению скорости итераций при разработке сложных шаблонов CloudFormation:

Используйте инструменты CloudFormation для проверки шаблонов и обновлений стека

AWS уже описал их в своем собственном документе Best Practices. , поэтому я не буду их повторять:

• Проверяйте шаблоны перед их использованием
• Создавайте наборы изменений перед обновлением ваших стеков

Цель этого шага - выявить очевидные синтаксические или логические ошибки перед фактическим выполнением создания / обновления стека.

Тестовые ресурсы изолированно

Прежде чем использовать какой-либо отдельный ресурс CloudFormation в сложном стеке, убедитесь, что вы полностью понимаете всю степень поведения этого ресурса при создании / обновлении / удалении, включая любые ограничения на использование и типичное время запуска / разрыва, путем тестирования их поведения в небольших автономных стеках. первый.

• Если вы разрабатываете или используете какие-либо сторонние пользовательские ресурсы, напишите модульные тесты с использованием соответствующих библиотек для языковой платформы, чтобы убедиться, что логика приложения ведет себя должным образом во всех случаях использования.
• Имейте в виду, что время, необходимое для создания / обновления / удаления отдельного ресурса, может сильно различаться для разных типов ресурсов в зависимости от поведения базовых вызовов API. Например, сложный AWS::CloudFront::Distribution ресурс. для создания / обновления / удаления иногда может потребоваться 30-60 минут, в то время как _ 2_ обновляется за секунды.
• Отдельные ресурсы могут иметь ошибки / проблемы / ограничения в их реализации, которые намного проще отлаживать и разрабатывать обходные пути при тестировании изолированно, а не в рамках гораздо большего стека. Помните об ограничениях, таких как AWS Service Limits, в зависимости от ваших индивидуальных предпочтений. Настройки учетной записи AWS или Доступность услуг в регионе в зависимости от в регионе, в котором вы создаете свой стек.

Создавайте сложные стопки небольшими приращениями

При выполнении создания / обновления стека сбой любого отдельного ресурса приведет к тому, что стек откатит весь набор изменений ресурсов, что может без необходимости уничтожить другие успешно созданные ресурсы и занять очень много времени при построении сложного стека с длинным график зависимостей связанных ресурсов.

Решением является постепенное создание стека небольшими пакетами обновлений, добавление ресурсов по одному (или нескольким) за раз. Таким образом, если / когда происходит сбой при создании / обновлении ресурса, откат не приводит к уничтожению всех ресурсов вашего стека, а только набор ресурсов, измененный в последнем обновлении.

Следите за ходом обновления стека

Обязательно Отслеживайте прогресс ваше обновление стека, просмотрев события стека во время создания / обновления. Это будет отправной точкой для устранения дальнейших проблем с отдельными ресурсами.

Вы знакомы с редактором шаблонов AWS CloudFormation, который включен в AWS Toolkit for Eclipse? Он имеет подсветку синтаксиса, завершение операторов и развертывание в AWS CloudFormation.

AWS CloudFormation linter обеспечивает дополнительный статический анализ помимо aws cloudformation validate-template

Он проинформирует вас, какие типы ресурсов и типы экземпляров недоступны в определенных регионах, проверит значения свойств на предмет допустимых значений, выловит циклические зависимости ресурсов, синтаксические ошибки, ограничения шаблонов и многое другое.

Помимо интерфейса командной строки, одним из самых популярных механизмов запуска линтера является установка плагина редактора, такого как расширение Visual Studio Code, которое запускается при каждом сохранении файла.

Другие механизмы, например хуки Git перед фиксацией описаны здесь

Поздно к вечеринке, но я также могу добавить, что стоит потратить немного времени на настройку и изучение вашего редактора. Я знаю, что это звучит смехотворно просто в качестве ответа, но попробуйте.

В моем случае с vim я работал намного лучше, когда я потратил некоторое время на установку плагинов синтаксиса json, а также (наконец) понял методы сворачивания для легкой навигации по большим файлам CF. Моя теперь предлагает опечатки (запятые там, где их не должно быть и т. Д.), А цветное выделение экономит много времени, давая четкие визуальные подсказки.

Это может помочь уменьшить синтаксические ошибки, но логические ошибки в шаблоне лучше исправлять другими инструментами. Надеюсь, однажды на CF появится режим «превью».

Для IDE JetBrains (IntelliJ IDEA PhpStorm WebStorm PyCharm RubyMine AppCode CLion Gogland DataGrip Rider Android Studio) есть по адресу Плагин AWS CloudFormation, который поддерживает глубокую проверку шаблонов JSON и YAML CFN.

Если вы имеете дело с машинами EC2, то я бы рекомендовал вам войти в систему на машине EC2 и следить за файлом boot.log (/var/log/boot.log в RHEL6 / Centos). Этот файл обновляется вместе со всеми вашими действиями в оболочке (такими как: установка, загрузка файлов, копирование файлов и т. Д.).

Кроме того, используйте редакторы, такие как http://www.jsoneditoronline.org/, чтобы получить представление JSON в виде ДЕРЕВА. Это поможет вам проверить порядок элементов JSON.

А при обновлении файлов всегда используйте такие инструменты, как http://www.git-tower.com/blog/diff-tools-mac/ или фактическую систему контроля версий, чтобы вы случайно не изменили что-то, что может нарушить работу вашего скрипта.

В дополнение к команде AWS CLI aws cloudformation validate-template существует инструмент cfn-check на основе узлов, который выполняет более глубокую проверку.

В прошлом декабре в Cloudformation недавно была добавлена ​​новая функция: дополнительные типы параметров. Эти новые типы позволяют вашим шаблонам выполнять более строгую проверку данных, а также могут работать без сбоев при создании ресурсов и вложенных стеков Cloudformation. У вас также есть возможность предоставлять более удобные для человека пользовательские сообщения об ошибках, когда передаются недопустимые значения, используя новый атрибут ConstraintDescription.

Новые типы особенно полезны при работе с различными ресурсами VPC. Вы можете убедиться, что параметры для ваших шаблонов имеют правильный тип и явно указывают на ожидание одного значения по сравнению со списком.

Например:

"Parameters" : {
  "SingleGroup": { "Type": "AWS::EC2::SecurityGroup::Id", ...},
  "GroupList": {"Type": "List<AWS::EC2::SecurityGroup::Id>", ...}
}

Пожалуйста, проверьте мой валидатор облачной информации по адресу https://pypi.org/project/cloudformation-validator/

Это проверит схему, а затем снова проверит список правил и разрешит настраиваемые правила. Я также допускаю простую интеграцию с инструментами развертывания.

Вы также можете использовать CloudFormation Designer, доступный на Amazon здесь: https://console.aws.amazon.com/cloudformation/designer/home?region=us-east-1

Просто вставьте свой шаблон (JSON) в панель «Шаблон», а затем щелкните значок галочки, чтобы подтвердить свой шаблон. Любые ошибки будут отображаться на панели «Ошибка».

Надеюсь это поможет.