Fleet.yml Reference

This section is a reference on how you can set up Fleet projects and Fleet CLI.

Using a fleet.yml configuration file, placing it at the root of your project, you can change the default behavior of Fleet and tell how it will deploy its resources.

regions

Type: Array of region identifier String.

Valid values: a list of valid region identifiers.

By setting this value, you can decide the deployment regions for Fleet Function. By default, the region is sfo2 and you can add more than one region.

regions: ['sfo2', 'fra']

env

Type: Object of String keys and values.

Valid values: environment keys and values.

Environment variables passed to the invoked Fleet Function.

env:
  KEY: 'any value'

functions

Type: Array of Object.

Value definition:

  • asynchronousThreshold (optional): The number of requests that a function can process at a time.
  • handler: The path where your function is located.
  • http: Object of String.
    • method: An Array of String that contains the valid methods of a REST API.
    • path: The path to your corresponding endpoint will invoke its Fleet Function.
  • timeout (optional): An integer that defines how long your Fleet Function should be run in milliseconds (between 1000 and the maximum limit of 300000, 5 minutes). Check the availability of your account.
functions:
  apiAuth:
    asynchronousThreshold: 10
    handler: 'functions/Auth.js'
    http:
      method: ['GET']
      path: '/v1/auth'
    timeout: 2000