mirror of https://github.com/serverless/serverless.git synced 2025-12-08 19:46:03 +00:00

Maciej Skierkowski 1a95b5ca61

docs: refactor variable docs & add docs for terraform and vault resolvers (#12584 )

* docs: update and consolidate param docs

* docs: add reference to dev in workflow tips

* docs: moving variables into section

* docs: refactor variables into dedicated files

* docs: adds terraform resolver docs

* docs: updating per terraform resolver changes

* docs: adding terraform remote variable resolver

* docs: fix links in headers

* docs: add docs for vault resolver

* docs: adding note on AWS accounts to TF resolver

* docs: refactor terraform & add http config

* docs: fixing provider links

* docs: move workflow out of aws guides

* docs: update menu link for new workflow location

2024-06-10 15:49:18 -07:00

2.9 KiB

Raw Permalink Blame History

Read this on the main serverless docs site

Workflow Tips

Quick recommendations and tips for various processes.

Development Workflow

Write your functions
Use serverless deploy only when you've made changes to serverless.yml and in CI/CD systems. For more information on setting up CI/CD for your Serverless app, read this article.
Use serverless deploy function -f myFunction to rapidly deploy changes when you are working on a specific AWS Lambda Function.
Use serverless invoke -f myFunction -l to test your AWS Lambda Functions on AWS.
Open up a separate tab in your console and stream logs in there via serverless logs -f myFunction -t.
Write tests to run locally.

Using stages

At the very least, use a dev and production stage.
Use different AWS accounts for stages.
In larger teams, each member should use a separate AWS account and their own stage for development.

Larger Projects

Break your application/project into multiple Serverless Services.
Model your Serverless Services around Data Models or Workflows.
Keep the Functions and Resources in your Serverless Services to a minimum.

Cheat Sheet

A handy list of commands to use when developing with the Serverless Framework.

Create A Service:

Creates a new Service

serverless

Deploy All

Use this when you have made changes to your Functions, Events or Resources in serverless.yml or you simply want to deploy all changes within your Service at the same time.

serverless deploy -s [STAGE NAME] -r [REGION NAME] -v

Deploy Function

Use this to quickly overwrite your AWS Lambda code on AWS, allowing you to develop faster.

serverless deploy function -f [FUNCTION NAME] -s [STAGE NAME] -r [REGION NAME]

Develop Locally

Use this to easily develop your AWS Lambda Functions locally. This will run your AWS Lambda Functions locally and allow you to send events to them on AWS.

Currently this is only supported for Node.js. Learn more about the dev command.

serverless dev

Invoke Function

Invokes an AWS Lambda Function on AWS and returns logs.

serverless invoke -f [FUNCTION NAME] \
  -s [STAGE NAME] \
  -r [REGION NAME] \
  -l

Streaming Logs

Open up a separate tab in your console and stream all logs for a specific Function using this command.

serverless logs -f [FUNCTION NAME] -s [STAGE NAME] -r [REGION NAME]

2.9 KiB Raw Permalink Blame History