Scaleway plugin for Serverless Framework

export TEMPLATE=python3

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

cd ${TEMPLATE}-func
npm i

serverless deploy

serverless invoke --function first

# The name of your namespace
service: my-namespace
# Read environment variables from a .env file
useDotenv: false
# Use of this plugin. This must not be changed
plugins:
  - serverless-scaleway-functions
# Scaleway-specific configuration
provider:
  # Must not change
  name: scaleway
  # Runtime used for functions (unless overridden)
  # List: https://www.scaleway.com/en/docs/serverless/functions/reference-content/functions-lifecycle/#available-runtimes
  runtime: python310
  # Global environment variables, used in every function/container in this namespace
  env:
    MY_VAR: "some var"
    MY_OTHER_VAR: "some other var"
  # Global secrets, used in every function/container in this namespace
  secret:
    MY_SECRET: "some secret"
    MY_OTHER_SECRET: "some other secret"
  # Optional override of Scaleway credentials
  scwToken: <scw-token>
  scwProject: <scw-project-id>
  # Scaleway region for the deploy
  scwRegion: fr-par
# Include/exclude directories
package:
  patterns:
    - "!node_modules/**"
    - "!.gitignore"
    - "!.git/**"

functions:
  my-func:
    # Handler entrypoint
    handler: handler.py
    # Minimum and maximum number of instances
    minScale: 0
    maxScale: 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.runtime
    runtime: 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 function
    env:
      LOCAL_VAR: "local var"
    # Local secrets, used only in this function
    secret:
      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 function
    events:
      - schedule:
          rate: "1 * * * *"
          # Data passed as input in the request
          input:
            key-a: "value-a"
            key-b: "value-b"

custom:
  containers:
    my-container:
      # Subdirectory holding the Dockerfile, cannot be used with registryImage
      directory: container/
      # Name of the registry image, cannot be used with directory
      registryImage: nginx:latest
      # Minimum and maximum number of instances
      minScale: 0
      maxScale: 10
      # Number of simultaneous requests to handle simultaneously
      maxConcurrency: 20
      # 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 container
      env:
        LOCAL_VAR: "local var"
      # Local secrets, used only in this container
      secret:
        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
      # List of events to trigger the container
      events:
        - schedule:
            rate: "1 * * * *"
            # Data passed as input in the request
            input:
              key-a: "value-a"
              key-b: "value-b"

serverless logs --function <function_or_container_name>