Requirements

Quick start

export TEMPLATE=python3

serverless create \  --path${TEMPLATE}-func \  --template-url https://github.com/scaleway/serverless-scaleway-functions/tree/master/examples/${TEMPLATE}

cd${TEMPLATE}-funcnpm i

serverless deploy

serverless invoke --function first

Contents

Configuration

General configuration

# The name of your namespaceservice:my-namespace# Read environment variables from a .env fileuseDotenv:false# Use of this plugin. This must not be changedplugins:  -serverless-scaleway-functions# Scaleway-specific configurationprovider:# Must not changename:scaleway# Runtime used for functions (unless overridden)# List: https://www.scaleway.com/en/docs/serverless/functions/reference-content/functions-lifecycle/#available-runtimesruntime:python310# Global environment variables, used in every function/container in this namespaceenv:MY_VAR:"some var"MY_OTHER_VAR:"some other var"# Global secrets, used in every function/container in this namespacesecret:MY_SECRET:"some secret"MY_OTHER_SECRET:"some other secret"# Optional override of Scaleway credentialsscwToken:<scw-token>scwProject:<scw-project-id># Scaleway region for the deployscwRegion:fr-par# Include/exclude directoriespackage:patterns:    -"!node_modules/**"    -"!.gitignore"    -"!.git/**"

Function-specific configuration

functions:my-func:# Handler entrypointhandler:handler.py# Minimum and maximum number of instancesminScale:0maxScale:10# Memory limit (in MiB)# Limits: https://www.scaleway.com/en/docs/serverless/functions/reference-content/functions-limitations/memoryLimit:1024# Maximum duration a request will wait to be served before it times out (in seconds)# Value in string format ex: "300s" (default: 300 seconds)timeout:300s# Runtime for this function, allows overriding provider.runtimeruntime:node20# How to handle HTTP. Options: enabled (allow HTTP), or redirected (redirect HTTP -> HTTPS)httpOption:enabled# Execution environment to use when running the function. Options: v1 (legacy), v2 (recommended, with improved cold starts)sandbox:v2# Controls privacy of the function. Options: public (no authentication), private (token-based authentication)privacy:public# Local environment variables, used only in this functionenv:LOCAL_VAR:"local var"# Local secrets, used only in this functionsecret:LOCAL_SECRET:"local secret"# Custom domains configured for the function# https://www.scaleway.com/en/docs/compute/functions/how-to/add-a-custom-domain-name-to-a-function/custom_domains:      -my-func.some.domain.com# List of events to trigger the functionevents:      -schedule:rate:"1 * * * *"# Data passed as input in the requestinput:key-a:"value-a"key-b:"value-b"

Container-specific configuration

custom:containers:my-container:# Subdirectory holding the Dockerfile, cannot be used with registryImagedirectory:container/# Name of the registry image, cannot be used with directoryregistryImage:nginx:latest# Minimum and maximum number of instancesminScale:0maxScale:10# Configuration used to decide when to scale the container up or downscalingOption:# Can be one of: concurrentRequests, cpuUsage, memoryUsagetype:concurrentRequests# Value to trigger scaling up# It's expressed in:# - concurrentRequests: number of requests# - cpuUsage: percentage of CPU usage# - memoryUsage: percentage of memory usage# Note that cpu and memory scaling are only available for minScale >= 1 containersthreshold:50# Memory limit (in MiB)# Limits: https://www.scaleway.com/en/docs/serverless/containers/reference-content/containers-limitations/memoryLimit:1024# CPU limit for the container in mvCPU, chosen based on resource tiers if not set# Limits and tiers: https://www.scaleway.com/en/docs/serverless/containers/reference-content/containers-limitations/cpuLimit:1000# Maximum duration a request will wait to be served before it times out (in seconds)# Value in string format ex: "300s" (default: 300 seconds)timeout:300s# How to handle HTTP. Options: enabled (allow HTTP), or redirected (redirect HTTP -> HTTPS)httpOption:enabled# Execution environment to use when running the container. Options: v1 (legacy), v2 (recommended, with improved cold starts)sandbox:v2# Controls privacy of the container. Options: public (no authentication), private (token-based authentication)privacy:public# Local environment variables, used only in this containerenv:LOCAL_VAR:"local var"# Local secrets, used only in this containersecret:LOCAL_SECRET:"local secret"# Custom domains configured for the function# https://www.scaleway.com/en/docs/serverless/containers/how-to/add-a-custom-domain-to-a-container/custom_domains:        -my-container.some.domain.com# Health check configurationhealthCheck:type:http# Or tcp if you only want to check that the port is openhttpPath:/healthinterval:10sfailureThreshold:3# List of events to trigger the containerevents:        -schedule:rate:"1 * * * *"# Data passed as input in the requestinput:key-a:"value-a"key-b:"value-b"# Deprecated: number of simultaneous requests to handle# Please use scalingOption of type concurrentRequests instead# maxConcurrency: 20

Supported commands

serverless deploy

serverless logs

Warning

This command is deprecated and will be removed on March 12, 2024. Please refer to the documentation (forfunctions andcontainers) to continue getting your logs.TL;DR: You can still access function and container logs conveniently via theCockpit interface. Dedicated dashboards called "Serverless Functions Logs" and "Serverless Containers Logs" are accessible there.

serverless logs --function<function_or_container_name>

serverless info

Unsupported commands

serverless invoke local

Useful links

Contributing

Help & support

Reach Us

License