mirror of
https://github.com/fnproject/fn.git
synced 2022-10-28 21:29:17 +03:00
all: rename hot containers to hot functions (#465)
This commit is contained in:
@@ -15,7 +15,7 @@ If you are a developer using IronFunctions through the API, this section is for
|
||||
* [Packaging functions](packaging.md)
|
||||
* [Open Function Format](function-format.md)
|
||||
* [API Reference](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/iron-io/functions/master/docs/swagger.yml)
|
||||
* [Hot containers](hot-containers.md)
|
||||
* [Hot functions](hot-functions.md)
|
||||
|
||||
## For Operators
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ curl -H "Content-Type: application/json" -X POST -d '{
|
||||
|
||||
#### name (string)
|
||||
|
||||
`name` is a property that references an unique app.
|
||||
`name` is a property that references an unique app.
|
||||
|
||||
App names are immutable. When updating apps with `PATCH` requests, keep in mind that although you
|
||||
are able to update an app's configuration set, you cannot really rename it.
|
||||
@@ -47,7 +47,7 @@ are able to update an app's configuration set, you cannot really rename it.
|
||||
#### config (object)
|
||||
|
||||
`config` is a map of values passed to the route runtime in the form of
|
||||
environment variables.
|
||||
environment variables.
|
||||
|
||||
Note: Route level configuration overrides app level configuration.
|
||||
|
||||
@@ -138,16 +138,16 @@ Note: Route level configuration overrides app level configuration.
|
||||
|
||||
#### format (string)
|
||||
|
||||
`format` defines if the function is running or not in `hot container` mode.
|
||||
`format` defines if the function is running or not in `hot function` mode.
|
||||
|
||||
To define the function execution as `hot container` you set it as one of the following formats:
|
||||
To define the function execution as `hot function` you set it as one of the following formats:
|
||||
|
||||
- `"http"`
|
||||
|
||||
### 'Hot Container' Only Properties
|
||||
### 'Hot function' Only Properties
|
||||
|
||||
This properties are only used if the function is in `hot container` mode
|
||||
This properties are only used if the function is in `hot function` mode
|
||||
|
||||
#### max_concurrency (string)
|
||||
|
||||
This property defines the maximum amount of concurrent hot containers instances the function should have (per IronFunction node).
|
||||
This property defines the maximum amount of concurrent hot functions instances the function should have (per IronFunction node).
|
||||
@@ -55,17 +55,17 @@ during functions execution.
|
||||
`build` (optional) is an array of local shell calls which are used to help
|
||||
building the function.
|
||||
|
||||
## Hot containers
|
||||
## Hot functions
|
||||
|
||||
Hot containers support also adds two extra options to this configuration file.
|
||||
hot functions support also adds two extra options to this configuration file.
|
||||
|
||||
`format` (optional) is one of the streaming formats covered at [function-format.md](function-format.md).
|
||||
|
||||
`max_concurrency` (optional) is the maximum of hot containers per node to be
|
||||
`max_concurrency` (optional) is the maximum of hot functions per node to be
|
||||
started for a certain function. It defaults to one per function. If you
|
||||
understand you need more processing power, make sure to raise this number.
|
||||
Keep in mind that if there is not available memory to execute the configured
|
||||
workload, it will fail to start new hot containers.
|
||||
workload, it will fail to start new hot functions.
|
||||
|
||||
## Testing functions
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Hot containers
|
||||
# Hot functions
|
||||
|
||||
IronFunctions is built on top of container technologies, for each incoming
|
||||
workload, it spins a new container, feed it with the payload and sends the
|
||||
@@ -8,8 +8,8 @@ container. You may refer to [this blog](https://medium.com/travis-on-docker/the-
|
||||
In the case you need faster start times for your function, you may use a hot
|
||||
container instead.
|
||||
|
||||
Hot containers are started once and kept alive while there is incoming workload.
|
||||
Thus, it means that once you decide to use a hot container, you must be able to
|
||||
hot functions are started once and kept alive while there is incoming workload.
|
||||
Thus, it means that once you decide to use a hot function, you must be able to
|
||||
tell the moment it should reading from standard input to start writing to
|
||||
standard output.
|
||||
|
||||
@@ -17,9 +17,9 @@ Currently, IronFunctions implements a HTTP-like protocol to operate hot
|
||||
containers, but instead of communication through a TCP/IP port, it uses standard
|
||||
input/output.
|
||||
|
||||
## Implementing a hot container
|
||||
## Implementing a hot function
|
||||
|
||||
In the [examples directory](https://github.com/iron-io/functions/blob/master/examples/hotcontainers/http/func.go), there is one simple implementation of a hot container
|
||||
In the [examples directory](https://github.com/iron-io/functions/blob/master/examples/hotcontainers/http/func.go), there is one simple implementation of a hot function
|
||||
which we are going to get in the details here.
|
||||
|
||||
The basic cycle comprises three steps: read standard input up to a previosly
|
||||
@@ -75,9 +75,9 @@ res.Write(os.Stdout)
|
||||
Rinse and repeat for each incoming workload.
|
||||
|
||||
|
||||
## Deploying a hot container
|
||||
## Deploying a hot function
|
||||
|
||||
Once your functions is adapted to be handled as hot container, you must tell
|
||||
Once your functions is adapted to be handled as hot function, you must tell
|
||||
IronFunctions daemon that this function is now ready to be reused across
|
||||
requests:
|
||||
|
||||
@@ -99,5 +99,5 @@ requests:
|
||||
`format` (mandatory) either "default" or "http". If "http", then it is a hot
|
||||
container.
|
||||
|
||||
`max_concurrency` (optional) - the number of simultaneous hot containers for
|
||||
`max_concurrency` (optional) - the number of simultaneous hot functions for
|
||||
this functions. This is a per-node configuration option. Default: 1
|
||||
@@ -6,7 +6,7 @@ swagger: '2.0'
|
||||
info:
|
||||
title: IronFunctions
|
||||
description: The open source serverless platform.
|
||||
version: "0.1.28"
|
||||
version: "0.1.29"
|
||||
# the domain of the service
|
||||
host: "127.0.0.1:8080"
|
||||
# array of all schemes that your API supports
|
||||
@@ -370,7 +370,7 @@ definitions:
|
||||
max_concurrency:
|
||||
type: integer
|
||||
format: int32
|
||||
description: Maximum number of hot containers concurrency
|
||||
description: Maximum number of hot functions concurrency
|
||||
config:
|
||||
type: object
|
||||
description: Route configuration - overrides application configuration
|
||||
|
||||
Reference in New Issue
Block a user