Manual Lambda Function Registration
This topic describes how to manually register Lambda functions into Consul. Refer to Automate Lambda Function Registration for information about using the Lambda registrator to automate registration.
Requirements
Verify that your environment meets the requirements specified in Lambda Function Registration Requirements.
To manually register Lambda functions so that mesh services can invoke them, you must create and apply a service registration configuration for the Lambda function and write a service defaults configuration entry for the function.
Register a Lambda function
You can manually register Lambda functions if you are unable to automate the process using the Lambda registrator.
Create a configuration for registering the service. You can copy the following example and replace
<SERVICE_NAME>
with your Consul service name for the Lambda function:lambda.jsonSave the configuration to
lambda.json
.Send the configuration to the
catalog/register
API endpoint to register the service, for example:Create the
service-defaults
configuration entry and include the AWS tags used to invoke the Lambda function in theEnvoyExtensions
configuration. Refer to SupportedEnvoyExtension
arguments for more information.
The following example creates a service-defaults
configuration entry named lambda
:
- Issue the
consul config write
command to store the configuration entry. For example:
Supported EnvoyExtension
arguments
The lambda
Envoy extension supports the following arguments:
ARN
(string
) - Specifies the AWS ARN for the service's Lambda.ARN
must be set to a valid Lambda function ARN.Region
(string
) - Specifies the AWS region the Lambda is running in.Region
must be set to a valid AWS region where the Lambda function exists.PayloadPassthrough
(boolean: false
) - Determines if the body Envoy receives is converted to JSON or directly passed to Lambda.InvocationMode
(string: synchronous
) - Determines if Consul configures the Lambda to be invoked using thesynchronous
orasynchronous
invocation mode.