Skip to content
This repository has been archived by the owner on Nov 26, 2021. It is now read-only.

Latest commit

 

History

History
40 lines (24 loc) · 2.06 KB

README.md

File metadata and controls

40 lines (24 loc) · 2.06 KB
Raw

FaaS Runner for ASPNET Functions

FaaS Runner (or just faas-run) is one of the components of ASPNET Functions for OpenFaaS. It uses a plugin architecture to dynamically load a function assembly and host the function execution. It was used by the OpenFaaS ASPNET Template v1.x, but it can also be used separately.

Since the release of v2.x of the template, faas-run is no longer used and considered deprecated. See here how to migrate your function if you're still using v1.x.

Installing

Go to the Releases page and download the appropriate binary for your platform. You can also pull the Docker image from GitHub.

Usage

The purpose of faas-run is to load and serve a function assembly. Assuming you are in the project folder, you can simply pass the assembly path as an argument.

~/source/hello$ faas-run bin/Debug/netstandard2.0/function.dll
OpenFaaS ASPNET Function Loader

To debug attach to process id 1212.

Loaded function assembly 'bin/Debug/netstandard2.0/function.dll'.

Running...
info: Microsoft.Hosting.Lifetime[0]
      Now listening on: http://[::]:9000
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.

By default, faas-run listens on port 9000. You can change this using the --port option.

Configuration

If a config.json file exists, it is added to the configuration pipeline, thus, available for the function in runtime. You can also specify a different configuration file by using the --config option.

Secrets

On an OpenFaaS cluster, secrets that the function has access to are loaded into the configuration model, prepended with the prefix _secret_. When running locally, we can add values into the config.json file using just the same prefix.

NOTE: The value of the secrets in the config.json file need to be base64 encoded.