Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@adastradev/serverless-discovery-plugin
Advanced tools
Readme
A serverless plugin to register AWS micro-service endpoints with a discovery service at serverless deploy
or serverless remove
time, or to pass the output to a JavaScript function for further processing.
See the Ad Astra Serverless Discovery project for more information.
$ > yarn add serverless-discovery-plugin
$ > npm install serverless-discovery-plugin
plugins:
- serverless-discovery-plugin
custom:
discovery:
discoveryServiceUri: 'https://abcdefghij.execute-api.us-east-1.amazonaws.com/dev'
accessKeyId: ${env:DISCOVERY_KEY_ID} # optional, if separate keys are needed
secretAccessKey: ${env:DISCOVERY_SECRET_ACCESS_KEY} # optional, if separate keys are needed
deployHandler: scripts/deploy.handler # Same syntax as you already know
removeHandler: scripts/remove.handler # Same syntax as you already know
file: .build/stack.toml # toml, yaml, yml, and json format is available
version: 1.0.0 # you could alternatively source this from package.json, etc.
externalID: An alternative identifier/stage name for your service deployment
The service URL can store a JSON object of data as part of the registration process. Setting the value of serviceURL
with additional properties will store the additional properties with the service registration. These additional properties will be returned when requesting the service information from the discovery service.
serviceURL:
{
jobName: '${self:service}-${env:STAGE_NAME}',
jobDefinition: '${self:service}-${env:STAGE_NAME}',
}
The custom properties stored on the service URL can reference stack deployment properties and store the result of those properties when the service is registered. The deployment properties are referenced using the @DeploymentProp
tag in the custom property followed by the property to reference. The available properties that can be referenced are the properties written to the file
property of the custom discovery
object declared in the serverless.yml file.
serviceURL:
{
servicePath: { '@DeploymentProp': 'ServiceEndpoint' },
someLambdaFunctionArn:
{ '@DeploymentProp': 'SomeLambdaFunctionArnLambdaFunctionQualifiedArn' },
}
serviceURL:
{
servicePath: 'https://APIGatewayID.execute-api.us-east-1.amazonaws.com/dev',
someLambdaFunctionArn: 'arn:aws:lambda:us-east-1:AccountID:function:sls-stack-output-example-dev-example:9',
}
If the service under development is deployed into the same account as the discovery service, serverless-discovery-plugin
will use the same credentials from AWS environment variables at pipeline run time to authenticate to the discovery service for registration purposes. Otherwise, you can designate explicit credentials that should be used in the configuration.
Based on the configuration above the plugin will search for a file scripts/deploy.js
with the following content:
// async declaration here implicitly returns a Promise<void>
async function handler(data, serverless, options) {
console.log('Received Stack Output', data)
}
module.exports = { handler }
Just name your file with a .json
, .toml
, .yaml
, or .yml
extension, and the plugin will take care of formatting your output. Please make sure the location where you want to save the file exists!
Feel free to use the code, it's released using the MIT license.
You are more than welcome to contribute to this project! 😘 🙆
To make sure you have a pleasant experience, please read the code of conduct. It outlines core values and believes and will make working together a happier experience.
The plugins works fine with serverless functions, as well as when using custom CloudFormation resources. The following example configuration will deploy an AWS Lambda function, API Gateway, SQS Queue, IAM User with AccessKey and SecretKey, and a static value:
service: sls-stack-output-example
plugins:
- serverless-discovery-plugin
package:
exclude:
- node_modules/**
custom:
discovery:
discoveryServiceUri: 'https://DiscoveryServiceID.execute-api.us-east-1.amazonaws.com/prod'
deployHandler: scripts/output.handler
file: .build/stack.toml
provider:
name: aws
runtime: nodejs16.18
functions:
example:
handler: functions/example.handle
events:
- http:
path: example
method: get
cors: true
resources:
Resources:
ExampleQueue:
Type: AWS::SQS::Queue
Properties:
QueueName: example-queue
ExampleUser:
Type: 'AWS::IAM::User'
Properties:
UserName: example-user
Policies:
- PolicyName: ExampleUserSQSPolicy
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: 'Allow'
Action:
- sqs:SendMessage
Resource:
- {
'Fn::Join':
[
':',
[
'arn:aws:sqs:*',
{ 'Ref': 'AWS::AccountId' },
'example-queue',
],
],
}
ExampleUserKey:
Type: AWS::IAM::AccessKey
Properties:
UserName:
Ref: ExampleUser
Outputs:
ExampleUserKey:
Value:
Ref: ExampleUserKey
ExampleUserSecret:
Value: { 'Fn::GetAtt': ['ExampleUserKey', 'SecretAccessKey'] }
ExampleStaticValue:
Value: example-static-value
Serverless: Stack update finished...
Service Information
service: sls-stack-output-example
stage: dev
region: us-east-1
stack: sls-stack-output-example-dev
api keys:
None
endpoints:
GET - https://APIGatewayID.execute-api.us-east-1.amazonaws.com/dev/example
...
-------------------
Serverless: Registering service endpoint with service: https://DiscoveryServiceID.execute-api.us-east-1.amazonaws.com/prod
Serverless: Stack Output saved to file: test/system/lib/outputs.json
ExampleUserSecret = "YourUserSecretKey"
ExampleUserKey = "YourUserAccessKey"
ExampleLambdaFunctionQualifiedArn = "arn:aws:lambda:us-east-1:AccountID:function:sls-stack-output-example-dev-example:9"
ExampleStaticValue = "example-static-value"
ServiceEndpoint = "https://APIGatewayID.execute-api.us-east-1.amazonaws.com/dev"
ServerlessDeploymentBucketName = "sls-stack-output-example-serverlessdeploymentbuck-BucketID"
ExampleUserSecret: YourUserSecretKey
ExampleUserKey: YourUserAccessKey
ExampleLambdaFunctionQualifiedArn: 'arn:aws:lambda:us-east-1:AccountID:function:sls-stack-output-example-dev-example:9'
ExampleStaticValue: example-static-value
ServiceEndpoint: 'https://APIGatewayID.execute-api.us-east-1.amazonaws.com/dev'
ServerlessDeploymentBucketName: sls-stack-output-example-serverlessdeploymentbuck-BucketID
{
"ExampleUserSecret": "YourUserSecretKey",
"ExampleUserKey": "YourUserAccessKey",
"ExampleLambdaFunctionQualifiedArn": "arn:aws:lambda:us-east-1:AccountID:function:sls-stack-output-example-dev-example:9",
"ExampleStaticValue": "example-static-value",
"ServiceEndpoint": "https://APIGatewayID.execute-api.us-east-1.amazonaws.com/dev",
"ServerlessDeploymentBucketName": "sls-stack-output-example-serverlessdeploymentbuck-BucketID"
}
FAQs
Serverless plugin to register/de-register endpoints upon deploy and remove command hooks
The npm package @adastradev/serverless-discovery-plugin receives a total of 687 weekly downloads. As such, @adastradev/serverless-discovery-plugin popularity was classified as not popular.
We found that @adastradev/serverless-discovery-plugin demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 37 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.