You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.serverless – Manages a Serverless Framework project

Note

This plugin is part of the community.general collection (version 3.8.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.serverless.

Synopsis

• Provides support for managing Serverless Framework (https://serverless.com/) project deployments and stacks.

Requirements

The below requirements are needed on the host that executes this module.

• serverless

• yaml

Parameters

Parameter	Comments
deploy boolean	Whether or not to deploy artifacts after building them. When this option is false all the functions will be built, but no stack update will be run to send them out. This is mostly useful for generating artifacts to be stored/deployed elsewhere. Choices: no yes ← (default)
force boolean	Whether or not to force full deployment, equivalent to serverless --force option. Choices: no ← (default) yes
functions list / elements=string	A list of specific functions to deploy. If this is not provided, all functions in the service will be deployed. Deprecated parameter, it will be removed in community.general 5.0.0. Default: []
region string	AWS region to deploy the service to. This parameter defaults to us-east-1.
serverless_bin_path path	The path of a serverless framework binary relative to the ‘service_path’ eg. node_module/.bin/serverless
service_path path / required	The path to the root of the Serverless Service to be operated on.
stage string	The name of the serverless framework project stage to deploy to. This uses the serverless framework default “dev”.
state string	Goal state of given stage/project. Choices: absent present ← (default)
verbose boolean	Shows all stack events during deployment, and display any Stack Output. Choices: no ← (default) yes

Notes

Note

• Currently, the serverless command must be in the path of the node executing the task. In the future this may be a flag.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
command string	Full serverless command run by this module, in case you want to re-run the command outside the module. Returned: always Sample: “serverless deploy –stage production”
service_name string	The service name specified in the serverless.yml that was just deployed. Returned: always Sample: “my-fancy-service-dev”
state string	Whether the stack for the serverless project is present/absent. Returned: always

Authors

• Ryan Scott Brown (@ryansb)