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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.serverless.

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

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

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

Требования

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

serverless
PyYAML

Параметры

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

Атрибуты

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

Примечания

Примечание

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

Примеры

- 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 string	Полная команда `serverless`, выполненная этим модулем. Ее можно повторно запустить вне модуля. Возвращается: всегда Пример: `"serverless deploy --stage production"`
service_name string	Имя службы, указанное в только что развернутом файле serverless.yml. Возвращается: всегда Пример: `"my-fancy-service-dev"`
state string	Наличие или отсутствие стека проекта Serverless. Возвращается: всегда

Авторы

Ryan Scott Brown (@ryansb)

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

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