alihan/fn-serverless
1
0
Fork 0
mirror of https://github.com/fnproject/fn.git synced 2022-10-28 21:29:17 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs, fixed broken links and moved things around.

Browse Source
This commit is contained in:
Travis Reeder
2017-03-21 16:34:59 -07:00
parent 200cac1477
commit cfccf33c5d
5 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -83,7 +83,7 @@ docker run --rm -it --name functions -v ${PWD}/data:/app/data -v /var/run/docker
*where ${PWD}/data is the directory where the functions application data files will be stored* *where ${PWD}/data is the directory where the functions application data files will be stored*
This will start IronFunctions in single server mode, using an embedded database and message queue. You can find all the This will start IronFunctions in single server mode, using an embedded database and message queue. You can find all the
configuration options [here](docs/options.md). If you are on Windows, check [here](docs/operating/windows.md). configuration options [here](docs/operating/options.md). If you are on Windows, check [here](docs/operating/windows.md).
### CLI tool ### CLI tool

7
docs/README.md
View File

@@ -22,8 +22,9 @@ If you are a developer using IronFunctions through the API, this section is for
If you are operating IronFunctions, this section is for you. If you are operating IronFunctions, this section is for you.
* [Running in Production Overview](operating/production.md) * [Running in Production Overview](operating/production.md)
* [Databases](databases/README.md) * [Runtime Options](operating/options.md)
* [Message Queues](mqs/README.md) * [Databases](operating/databases/README.md)
* [Message Queues](operating/mqs/README.md)
* [UI](operating/ui.md) * [UI](operating/ui.md)
* [Logging](operating/logging.md) * [Logging](operating/logging.md)
* [Metrics](operating/metrics.md) * [Metrics](operating/metrics.md)
@@ -34,5 +35,3 @@ If you are operating IronFunctions, this section is for you.
* Running IronFunctions on: * Running IronFunctions on:
* [Kubernetes](operating/kubernetes/README.md) * [Kubernetes](operating/kubernetes/README.md)
* [Docker Swarm](operating/docker-swarm/README.md) * [Docker Swarm](operating/docker-swarm/README.md)

0
docs/mqs/README.md → docs/operating/mqs/README.md
View File

0
docs/options.md → docs/operating/options.md
View File

6
docs/operating/production.md
View File

@@ -1,6 +1,6 @@
# Running IronFunctions in Production # Running IronFunctions in Production
The [QuickStart guide](/README.md) is intended to quickly get started and kick the tires. To run in production and be ready to scale, you need The [QuickStart guide](/README.md#quickstart) is intended to quickly get started and kick the tires. To run in production and be ready to scale, you need
to use more production ready components. to use more production ready components.
* Put the IronFunctions API behind a load balancer and launch run several instances of them (the more the merrier). * Put the IronFunctions API behind a load balancer and launch run several instances of them (the more the merrier).
@@ -21,14 +21,14 @@ Any load balancer will work, put every instance of IronFunctions that you run be
We've done our best to keep the database usage to a minimum. There are no writes during the request/response cycle which where most of the load will be. We've done our best to keep the database usage to a minimum. There are no writes during the request/response cycle which where most of the load will be.
The database is pluggable and we currently support a few options that can be [found here](/docs/databases/). We welcome pull requests for more! The database is pluggable and we currently support a few options that can be [found here](databases/README.md). We welcome pull requests for more!
## Message Queue ## Message Queue
The message queue is an important part of asynchronous functions, essentially buffering requests for processing when resources are available. The reliability and scale of the message queue will play an important part The message queue is an important part of asynchronous functions, essentially buffering requests for processing when resources are available. The reliability and scale of the message queue will play an important part
in how well IronFunctions runs, in particular if you use a lot of asynchronous function calls. in how well IronFunctions runs, in particular if you use a lot of asynchronous function calls.
The message queue is pluggable and we currently support a few options that can be [found here](/docs/mqs/). We welcome pull requests for more! The message queue is pluggable and we currently support a few options that can be [found here](mqs/README.md). We welcome pull requests for more!
## Logging, Metrics and Monitoring ## Logging, Metrics and Monitoring