Add information about host's Docker configuration (#184)

* Add information about host's Docker configuration

* Move Docker block to its own file

* Fix configuration mistake
This commit is contained in:
C Cirello
2016-10-19 16:42:05 -07:00
committed by Travis Reeder
parent 9e73770811
commit 64e74adce9
3 changed files with 23 additions and 1 deletions

View File

@@ -116,7 +116,7 @@ Read more on [logging](docs/logging.md).
## Writing Functions ## Writing Functions
TODO: TODO:
## More Documentation ## More Documentation

View File

@@ -10,3 +10,4 @@
* [Metrics](metrics.md) * [Metrics](metrics.md)
* [Triggers](triggers.md) * [Triggers](triggers.md)
* [Extending IronFunctions](extending.md) * [Extending IronFunctions](extending.md)
* [Docker Configuration](docker.md)

21
docs/docker.md Normal file
View File

@@ -0,0 +1,21 @@
# Docker Configuration
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 Overlay2 module
2) Ubuntu 16.04 LTS or newer with 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:
```
docker daemon [...] --storage-driver=overlay2
```
In case you are using Ubuntu, you can reconfigure Docker easily by updating `/etc/docker/daemon.json` and restarting Docker:
```json
{
"storage-driver": "overlay2"
}
```