Merge pull request #6338 from rooftopcellist/update_logstash_docs

Update logstash docs

Reviewed-by: https://github.com/apps/softwarefactory-project-zuul

tools/docker-compose/README

@@ -1,34 +0,0 @@
-docker build --no-cache=true --rm=true -t ansible/awx_devel:latest .
-docker run --name awx_test -it --memory="4g" --cpuset="0,1" -v /Users/meyers/ansible/:/awx_devel -p 8013:8013 -p 8080:8080 -p 27017:27017 -p 2222:22 ansible/awx_devel
-
-## How to use the logstash container
-
-POST the following content to `/api/v2/settings/logging/` (this uses
-authentication set up inside of the logstash configuration file).
-
-```
-{
-    "LOG_AGGREGATOR_HOST": "http://logstash",
-    "LOG_AGGREGATOR_PORT": 8085,
-    "LOG_AGGREGATOR_TYPE": "logstash",
-    "LOG_AGGREGATOR_USERNAME": "awx_logger",
-    "LOG_AGGREGATOR_PASSWORD": "workflows",
-    "LOG_AGGREGATOR_LOGGERS": [
-        "awx",
-        "activity_stream",
-        "job_events",
-        "system_tracking"
-    ],
-    "LOG_AGGREGATOR_INDIVIDUAL_FACTS": false,
-    "LOG_AGGREGATOR_TOWER_UUID": "991ac7e9-6d68-48c8-bbde-7ca1096653c6",
-    "LOG_AGGREGATOR_ENABLED": true
-}
-```
-
-> Note: HTTP must be specified in the `LOG_AGGREGATOR_HOST` if you are using the docker development environment.  
-
-An example of how to view the most recent logs from the container:
-
-```
-docker exec -i -t $(docker ps -aqf "name=tools_logstash_1") tail -n 50 /logstash.log
-```

tools/docker-compose/README.md

@@ -0,0 +1,86 @@
+# Docker Compose for Dev container
+
+## How to start the Dev container
+
+In the root directory of your awx clone, run the following to build your docker image.  
+This step takes a while, but once your image is built, you don't need to do this again 
+unless you make changes to the Dockerfile or any of the files used by the Dockerfile.  
+
+```
+make docker-compose-build
+```
+
+> Note: By default, this image will be tagged with your branch name.  
+
+Copy over your local settings 
+
+```
+cp awx/settings/local_settings.py.docker_compose awx/settings/local_settings.py
+```
+
+Build the UI
+
+```
+make ui-devel
+```
+
+Run the container 
+
+```
+make docker-compose
+```
+
+> Note: You may need to add `COMPOSE_TAG=<yourbranch>` at the end of this to use the correct image for your branch.  
+
+The app should now be accessible in your browser at `https://localhost:8043/#/home`
+
+
+## How to use the logstash container
+
+#### Modify the docker-compose.yml
+
+Uncomment the following lines in the `docker-compose.yml`
+
+```
+#- logstash
+...
+
+#logstash:
+#  build:
+#    context: ./docker-compose
+#    dockerfile: Dockerfile-logstash
+```
+
+POST the following content to `/api/v2/settings/logging/` (this uses
+authentication set up inside of the logstash configuration file).
+
+```
+{
+    "LOG_AGGREGATOR_HOST": "http://logstash",
+    "LOG_AGGREGATOR_PORT": 8085,
+    "LOG_AGGREGATOR_TYPE": "logstash",
+    "LOG_AGGREGATOR_USERNAME": "awx_logger",
+    "LOG_AGGREGATOR_PASSWORD": "workflows",
+    "LOG_AGGREGATOR_LOGGERS": [
+        "awx",
+        "activity_stream",
+        "job_events",
+        "system_tracking"
+    ],
+    "LOG_AGGREGATOR_INDIVIDUAL_FACTS": false,
+    "LOG_AGGREGATOR_TOWER_UUID": "991ac7e9-6d68-48c8-bbde-7ca1096653c6",
+    "LOG_AGGREGATOR_ENABLED": true
+}
+```
+
+> Note: HTTP must be specified in the `LOG_AGGREGATOR_HOST` if you are using the docker development environment.  
+
+An example of how to view the most recent logs from the container:
+
+```
+docker exec -i -t $(docker ps -aqf "name=tools_logstash_1") tail -n 50 /logstash.log
+```
+
+#### How to add logstash plugins
+
+Add any plugins you need in `tools/elastic/logstash/Dockerfile` before running the container.  

tools/elastic/README.md

@@ -16,6 +16,7 @@ done by getting via bash in the running Docker machine. Example:
 ```bash
 docker-machine ssh default sudo sysctl -w vm.max_map_count=262144
 ```
+> Note: If you are running docker natively on linux, you need only run `sysctl -w vm.max_map_count=262144`
 
 After this, the containers can be started up with commands like:
 

tools/elastic/docker-compose.logstash-link.yml

@@ -1,7 +1,7 @@
 ---
 version: '2'
 services:
-  # Primary Tower Development Container
+  # Primary AWX Development Container
-  tower:
+  awx:
     links:
       - logstash