Repository: incubator-senssoft Updated Branches: refs/heads/master b59bdd405 -> 23dfae26c
Updated Docker instructions Project: http://git-wip-us.apache.org/repos/asf/incubator-senssoft/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-senssoft/commit/23dfae26 Tree: http://git-wip-us.apache.org/repos/asf/incubator-senssoft/tree/23dfae26 Diff: http://git-wip-us.apache.org/repos/asf/incubator-senssoft/diff/23dfae26 Branch: refs/heads/master Commit: 23dfae26cce2fb07f3a842a895c25f2eca55f857 Parents: b59bdd4 Author: msbeard <msbe...@apache.org> Authored: Thu Aug 24 13:58:16 2017 -0400 Committer: msbeard <msbe...@apache.org> Committed: Thu Aug 24 13:58:16 2017 -0400 ---------------------------------------------------------------------- docker/README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-senssoft/blob/23dfae26/docker/README.md ---------------------------------------------------------------------- diff --git a/docker/README.md b/docker/README.md index 186c1ec..2669bdb 100644 --- a/docker/README.md +++ b/docker/README.md @@ -1,29 +1,35 @@ How to Build Docker Containers ------------------------------ -1. Install [``Docker``](http://docker.com) -2. Install ``docker-compose``. +1. Install [``Docker``](http://docker.com) on your machine. +2. Install ``docker-compose`` in an virtual environment. Full instructions can be found [``here``](https://docs.docker.com/compose/install/). ``` $ python3 -m venv env $ source env/bin/activate $ pip install docker-compose ``` -3. Build and run all ``Docker`` containers. +3. Before launching the Docker containers, ensure your ``vm_max_map_count`` kernel setting is set to at least 262144. + Visit [``Running Elasticsearch in Production mode``](https://www.elastic.co/guide/en/elasticsearch/reference/5.5/docker.html#docker-cli-run-prod-mode) for OS specific instructions. + ``` + # For Linux systems + $ sysctl -w vm.max_map_count=262144 + ``` +4. To build and run all ``Docker`` containers. ``` $ docker-compose up -d ``` -4. Run a specific ``Docker`` container. +5. To run a specific ``Docker`` container. ``` $ docker-compose up -d site # Note: site container is instrumented w/ userale; all userale logs will be sent to the # elasticsearch docker container. ``` -5. Verify the deployment by navigating to ``Kibana`` in your favorite browser. +6. Verify the deployment by navigating to ``Kibana`` in your favorite browser. ```sh http://localhost:5601 ``` -6. Stop all the containers. +7. Stop all the containers. ```sh $ docker-compose stop ```
