Guides

In-depth guides for building, testing, deploying, and operating services with osls (OSS Serverless). New to osls? Start with Concepts, then work through Services and Functions.

Concepts

• osls Concepts — Core concepts and the mental model behind osls services.
• Services — What a service is, the serverless.yml file, and how projects are organized.
• Security model — How osls handles credentials, secrets, and the trust boundaries of a deployment.

Build & test

• AWS Lambda Functions — Defining functions, handlers, runtimes, and per-function settings.
• AWS Lambda Events — Wiring event sources (HTTP, schedule, queues, streams, and more) to functions.
• IAM Permissions For Functions — Granting functions the permissions they need via IAM roles and policies.
• AWS Lambda Layers — Publishing and consuming Lambda layers.
• AWS Infrastructure Resources — Adding raw CloudFormation resources and outputs to a service.
• Packaging — Controlling what code and dependencies are bundled into the deployment artifact.
• Variables — Using ${...} variable sources to keep configuration DRY.
• Loading .env files — Loading local .env files into a command's environment.
• Parameters — Defining and overriding stage/instance parameters.
• Service configuration validation — How serverless.yml is validated against the schema and how to tune validation.
• Testing — Strategies and tooling for testing functions and services.

Deploy & operate

• AWS Credentials — Configuring AWS credentials and profiles for deployment.
• Deploying to AWS — The deploy workflow, what happens under the hood, and deployment options.
• Workflow Tips — Day-to-day tips for developing and iterating on services.
• Composing services — Orchestrating multiple services together with compose.
• CI/CD — Running osls in continuous integration and deployment pipelines.

Reference

• Serverless.yml Reference — Full reference for every serverless.yml property.
• Upgrading from osls v3 to v4 — Migration guide and breaking changes for the v4 line.
• osls Deprecations — Deprecation codes, what they mean, and how to resolve them.
• Authoring plugins — Index of guides for writing your own osls plugins, commands, variables, and config extensions.