Skip to content

Latest commit

 

History

History
64 lines (36 loc) · 3.01 KB

README.md

File metadata and controls

64 lines (36 loc) · 3.01 KB
Raw

OpenFunction Functions Framework

The OpenFunction Functions Framework is designed to provide users with the ability to convert function code into applications that support multiple runtimes.

OpenFunction Context

To learn more about the design of the OpenFunction Context, refer to Function Context.

To learn more about different versions of the OpenFunction Context specifications, refer to the following links:

The direct user of OpenFunction Context is the OpenFunction Builder (Go). The following table describes the compatibility between Context, Builder, and OpenFunction.

You can get the corresponding version compatibility information from the specific builder repository. Here we use the OpenFunction Go (v1.15) builder as an example.

OpenFunction Context Builder (Go)
v0.3.* v0.1.0 v0.2.2 (openfunction/builder-go:v0.2.2-1.15)
v0.4.* v0.2.0 v0.3.0 (openfunction/builder-go:v0.3.0-1.15)
v0.5.* v0.2.0 v0.4.0 (openfunction/builder-go:v0.4.0-1.15)
v0.6.* v0.3.0 v2-1.16+

Functions Framework Samples

For more examples of functions framework, refer to OpenFunction/samples: Functions-framework samples.

Support

Languages

Runtimes

  • Knative
  • OpenFuncAsync

Function Types

  • HTTP

    The framework creates a route that associates the "/" URL path and the user function. After that, it starts the HTTP service according to the PORT parameter.

  • CloudEvent

    The CloudEvent provides a handler for handling HTTP requests while binding user function. The framework creates a route that associates the "/" URL path and the CloudEvent HTTP handler. After that, it starts the HTTP service according to the PORT parameter.

  • OpenFunction

    This function type is an implementation of Data Bindings.

    The framework creates a route that associates the specified HTTP URL path with the user function.

    The framework also provides the SDK for getting data and sending data. Users can use OpenFunction Context to handle function resource contexts, including performing "get data" and "send data".

Contributing

Refer to CONTRIBUTING to get started with developing OpenFunction Functions Framework.