docs: moving documentation around to be more clear and easier to browse (#236)
* moving documentation around to be more clear and easier to browse - moved assets into their own directory and updated links to them - moved operating docs into their own directory - consolidated kubernetes docs - added docker-swarm folder for docs - updated docs layout in docs/README.md to reflect the changes and make it easier to read * docs: s/Operating Functions/Operating IronFunctions/ * docs: removing duplicate database link * docs: moving databases into general docs * docs: moving databases/mqs back * docs: removing memory.md (duplicate of operating/routes.md) * docs: converting to markdown bullets
@@ -201,7 +201,7 @@ You will get a `call_id` in the response:
|
||||
|
||||
If you watch the logs, you will see the function actually runs in the background:
|
||||
|
||||

|
||||

|
||||
|
||||
Read more on [logging](docs/logging.md).
|
||||
|
||||
|
||||
@@ -1,11 +1,13 @@
|
||||
# IronFunctions Documentation
|
||||
|
||||
* [FAQ](faq.md)
|
||||
|
||||
## For Developers
|
||||
|
||||
If you are a developer using IronFunctions through the API, this section is for you.
|
||||
|
||||
* [Quickstart](https://github.com/iron-io/functions#quickstart)
|
||||
* [CLI tool - fnctl](../fnctl/README.md)
|
||||
* [fnctl (CLI Tool)](/fnctl/README.md)
|
||||
* [Writing functions](writing.md)
|
||||
* [Writing Lambda functions](docs/lambda/create.md)
|
||||
* [Packaging functions](packaging.md)
|
||||
@@ -16,11 +18,13 @@ If you are a developer using IronFunctions through the API, this section is for
|
||||
|
||||
If you are operating IronFunctions, this section is for you.
|
||||
|
||||
* [Running in Production](production.md)
|
||||
* [Running in Production](operating/production.md)
|
||||
* [Databases](databases/README.md)
|
||||
* [Message Queues](mqs/README.md)
|
||||
* [Logging](logging.md)
|
||||
* [Metrics](metrics.md)
|
||||
* [Triggers](triggers.md)
|
||||
* [Extending IronFunctions](extending.md)
|
||||
* [Docker Configuration](docker.md)
|
||||
* [Logging](operating/logging.md)
|
||||
* [Metrics](operating/metrics.md)
|
||||
* [Triggers](operating/triggers.md)
|
||||
* [Extending IronFunctions](operating/extending.md)
|
||||
* [Docker Configuration](operating/docker.md)
|
||||
* [Operating On Windows](operating/windows.md)
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 49 KiB |
|
Before Width: | Height: | Size: 384 KiB After Width: | Height: | Size: 384 KiB |
|
Before Width: | Height: | Size: 229 KiB After Width: | Height: | Size: 229 KiB |
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
@@ -1,4 +1,6 @@
|
||||
# HOWTO run IronFunction as a scheduler on top of Docker Standalone Swarm cluster
|
||||
# Docker Swarm and IronFunctions
|
||||
|
||||
How to run IronFunction as a scheduler on top of Docker Standalone Swarm cluster.
|
||||
|
||||
## Quick installation
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
To get the best performance, you'll want to ensure that Docker is configured properly. These are the environments known to produce the best results:
|
||||
|
||||
1) Linux 4.7 or newer with aufs or overlay2 module
|
||||
2) Ubuntu 16.04 LTS or newer with aufs or overlay2 module
|
||||
3) Docker 1.12 or newer to be available
|
||||
1. Linux 4.7 or newer with aufs or overlay2 module.
|
||||
2. Ubuntu 16.04 LTS or newer with aufs or overlay2 module.
|
||||
3. Docker 1.12 or newer to be available.
|
||||
|
||||
It is important to reconfigure host's Docker with this filesystem module. Thus, in your Docker start scripts you must do as following:
|
||||
|
||||
@@ -16,7 +16,7 @@ Every function call/request is assigned a `call_id`. If you search your logs, yo
|
||||
for each function call and find errors on a call by call basis. For example, these are the log lines for an aynschronous
|
||||
function call:
|
||||
|
||||

|
||||

|
||||
|
||||
Note the easily searchable `call_id=x` format.
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
Metrics are emitted via the logs for few couple of reasons:
|
||||
|
||||
1) Everything supports STDERR.
|
||||
2) User can optionally use them, if not, they just end up in the logs.
|
||||
3) No particular metrics system required, in other words, all metrics systems can be used via adapters (see below).
|
||||
1. Everything supports STDERR.
|
||||
2. User can optionally use them, if not, they just end up in the logs.
|
||||
3. No particular metrics system required, in other words, all metrics systems can be used via adapters (see below).
|
||||
|
||||
## Metrics
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
|
||||
# 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
|
||||
@@ -10,7 +9,7 @@ to use more production ready components.
|
||||
|
||||
Here's a rough diagram of what a production deployment looks like:
|
||||
|
||||

|
||||

|
||||
|
||||
## Load Balancer
|
||||
|
||||