Настраиваем инфраструктуру как код: чек-лист для DevOps-инженеров на примере AWS CloudFormation

Решили попробовать силы в разработке под AWS CloudFormation? Или уже пишете код и хотите повысить эффективность работы? Вот исчерпывающий план, c которым вы не упустите ни одного важного аспекта разработки под AWS CloudFormation.

Примечание Все ресурсы, на которые ведут ссылки, англоязычные.

Перед началом работы

Используйте готовые шаблоны

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

• widdix/aws-cf-templates;
• awslabs/aws-cloudformation-templates;
• stelligent/cloudformation_templates;
•  AWS Quick Starts;
• Other templates on Github.

Разработка кода

Установите локальные DevOps-инструменты

Установив их на своей рабочей станции, вы повысите эффективность работы:

•  Плагин Typeformation для JetBrains IDE;
•  Плагин AWS CloudFormation для JetBrains IDE;
•  Поддержка CloudFormation для Visual Studio Code;
•  Cloudformation YAML сниппеты для VS Code;
• Сниппеты для других IDE;
•  Плагины cfn-python-lint IDE.

Выберите формат YAML, а не JSON

YAML лаконичнее, его проще читать и к тому же он поддерживает комментирование.

• Для миграции на YAML используйте aws-cfn-template-flip

Используйте готовые сниппеты

Постарайтесь отказаться от метода проб и ошибок, ведь сниппеты для CloudFormation доступны на AWS и GitHub.

•  Сниппеты шаблонов;
• Образцы сниппетов для CloudFormation.

Распределите стеки в соответствии с этапами разработки и принадлежностью

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

•  Как это сделать

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

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

• Как это сделать

Используйте шаблоны повторно при сходных задачах

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

•  Как это сделать

Применяйте при разработке кода типы параметров, специфичные для AWS

Пригодится для базовой проверки и обращения к определённым переменным.

• Как это сделать

Используйте ограничения параметров

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

• Как это сделать

Применяйте AWS::CloudFormation::Init для развёртывания приложений на базе Amazon EC2

Сделайте процесс развёртывания декларативным, вместо того чтобы прописывать его шаг за шагом.

• Как это сделать

Попробуйте поработать с консольными командами, прежде чем генерировать сниппеты и шаблоны

Для того чтобы получить верные определения ресурсов, потребуются соответствующие инструменты.

• AWS Console Recorder (Записывает действия, производимые в AWS Management Console и выводит эквивалент команд CLI/SDK и шаблонов CloudFormation/Terraform в браузер);
• Former2 (Создаёт шаблоны CloudFormation/Terraform/Troposphere из существующих ресурсов AWS в браузере).

Проверяйте политики управления жизненными циклами ресурсов

Будьте готовы к тому, что в определённый момент CFN может заменить ваши ресурсы.

• Справочник по типам свойств и ресурсам AWS

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

Возможно, AWS пока не сможет обработать всё необходимое с помощью CFN.

•  Как это сделать

Внедряйте в свой код макросы

Макросы позволят уменьшить повторы кода, кастомизировать поиск элементов, добавить произвольный код, изменяющий шаблоны, и многое другое.

• Как этот сделать

Безопасность

Ограничьте допуски в AIM

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

•  Как использовать управление доступом и идентификацией (IAM) для контроля доступа

Создавайте шаблоны без вшитых реквизитов

Не оставляйте в шаблонах потенциально опасную информацию, используйте для её передачи вводные параметры.

•  Как это сделать

Проводите статический анализ шаблонов с помощью cfn_nag

Этот инструмент содержит более 45 правил для обнаружения потенциально уязвимой инфраструктуры и настроек.

•  stelligent/cfn_nag;
•  Список правил.

Наработанные методики

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

• Повышение надёжности;
• Безопасность;
• Портабельность;
• Управляемые службы;
• Дополнительные ресурсы;
• Linux;
• Windows;
• Подходящие для всех платформ;
• Форматирование шаблонов.

Другие методики

Сообщество выработало некоторые полезные приёмы, которые стоит использовать.

•  alexgibs/cfnstyle;
•  toddm92/aws (Wiki: CloudFormation Best Practices).

Администрирование

Управляйте всеми ресурсами стека только через AWS CloudFormation

Если не соблюдать это правило, могут возникнуть ошибки. Их вызывает несовпадение шаблонов и реального состояния стека ресурсов.

•  Почему это происходит

Создавайте сеты изменений стека перед непосредственным внесением корректировок

Чтобы избежать проблем при обновлении стека, изучите, как предполагаемые изменения повлияют на содержащиеся в нём ресурсы.

•  Объяснение

Разрабатывайте наборы правил для стеков

Защитите важнейшие ресурсы в стеке от ненужного обновления.

•  Как это сделать

Используйте AWS CloudTrail для журналирования обращений к AWS CloudFormation

Поможет отслеживать и проверять вызовы API.

•  Как это сделать

Применяйте модули запуска CFN, такие как Sceptre

Sceptre позволяет масштабировать шаблоны для использования нескольких аккаунтов и в разных регионах.

• Документация по Sceptre

Используйте автоматическую диагностику смещения

Пригодится для определения инициированных извне неуправляемых изменений.

•  Определение неуправляемых изменений настроек стеков и ресурсов;
•  Автоматическая диагностика смещения с помощью AWS Config.

Команда

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

Поделитесь кодом с командой и выслушайте предложения.

Поделитесь с коллегами этим планом

Попросите коллег держать его под рукой.

Тестирование

Проверьте квоты для всех типов ресурсов

В противном случае вы можете столкнуться с ограничениями AWS API при развёртывании CFN.

Оцените работоспособность шаблонов перед их использованием

Устранение синтаксических и семантических ошибок сбережёт вам время.

Проверьте, соблюдаются ли стандарты стиля кода

Соблюдение стандартов стиля поможет быстро обнаружить опечатки, проконтролировать работоспособность, следование установившимся методикам и т. д.

Протестируйте работоспособность шаблонов в подходящих регионах с помощью TaskCat

TaskCat разворачивает ваши шаблоны CloudFormation в различных регионах AWS и создаёт отчёт типа pass/fail для каждого из них.