Модуль community.general.serverless – Управление проектом Serverless Framework

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в playbook, укажите: community.general.serverless.

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Обеспечивает поддержку управления развертываниями и стеками проектов Serverless Framework (https://serverless.com/).

Требования

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

serverless
yaml

Параметры

Параметр	Комментарии
deploy boolean	Развертывать ли артефакты после их сборки. Когда эта опция `false`, все функции будут собраны, но обновление стека для их отправки выполняться не будет. Это в основном полезно для генерации артефактов для хранения/развертывания в другом месте. Варианты: `false` `true` ← (по умолчанию)
force boolean	Выполнять ли полное развертывание, эквивалентно опции serverless `--force`. Варианты: `false` ← (по умолчанию) `true`
region string	Регион AWS для развертывания сервиса. Этот параметр по умолчанию равен `us-east-1`. По умолчанию: `""`
serverless_bin_path path	Путь к бинарному файлу фреймворка serverless относительно ‘service_path’, например, node_module/.bin/serverless
service_path path / required	Путь к корневому каталогу сервиса Serverless, с которым нужно работать.
stage string	Имя этапа проекта фреймворка serverless, в который нужно выполнить развертывание. Используется значение по умолчанию фреймворка serverless “dev”. По умолчанию: `""`
state string	Целевое состояние данного этапа/проекта. Варианты: `"absent"` `"present"` ← (по умолчанию)
verbose boolean	Показывает все события стека во время развертывания и отображает любой вывод стека. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: отсутствует	Может работать в режиме `check_mode` и возвращать прогноз состояния изменений без изменения цели.
diff_mode	Поддержка: отсутствует	Возвращает подробную информацию о том, что изменилось (или может потребовать изменения в `check_mode`), в режиме diff.

Примечания

Примечание

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

Примеры

- name: Basic deploy of a service
  community.general.serverless:
    service_path: '{{ project_dir }}'
    state: present

- name: Deploy a project, then pull its resource list back into Ansible
  community.general.serverless:
    stage: dev
    region: us-east-1
    service_path: '{{ project_dir }}'
  register: sls

# The cloudformation stack is always named the same as the full service, so the
# cloudformation_info module can get a full list of the stack resources, as
# well as stack events and outputs
- cloudformation_info:
    region: us-east-1
    stack_name: '{{ sls.service_name }}'
    stack_resources: true

- name: Deploy a project using a locally installed serverless binary
  community.general.serverless:
    stage: dev
    region: us-east-1
    service_path: '{{ project_dir }}'
    serverless_bin_path: node_modules/.bin/serverless

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
command строка	Полная `serverless` команда, выполняемая этим модулем, в случае, если вы хотите повторно выполнить команду вне модуля. Возвращается: всегда Пример: `"serverless deploy --stage production"`
service_name строка	Имя сервиса, указанное в serverless.yml, который только что был развернут. Возвращается: всегда Пример: `"my-fancy-service-dev"`
state строка	Наличие/отсутствие стека для проекта serverless. Возвращается: всегда

Авторы

Ryan Scott Brown (@ryansb)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/serverless_module.html