Merge pull request #307 from MITLibraries/opensearch-dashboard

Adds docker compose and info on using dashboard

Author: JPrevost

README.md

@@ -31,11 +31,27 @@ A local OpenSearch instance can be started for development purposes by running:
 ``` bash
 $ docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" \
   -e "plugins.security.disabled=true" \
-  opensearchproject/opensearch:2.3.0
+  opensearchproject/opensearch:2.11.1
 ```
 
 To confirm the instance is up, run `pipenv run tim -u localhost ping`.
 
+Alternately, you can use the included Docker Compose file to start an OpenSearch node along with an OpenSearch Dashboard. This should leave you with the same
+
+```bash
+docker pull opensearchproject/opensearch:latest
+docker pull opensearchproject/opensearch-dashboards:latest
+docker compose up
+```
+
+To confirm the instance is up, run `pipenv run tim -u localhost ping`.
+
+To access the Dashboard, access <http://localhost:5601>.
+
+DevTools is useful for writing/testing OpenSearch queries.
+
+Discover is useful for browsing data. An index pattern will be required to use this tool. Note: do not set a date filed (choose the option to skip selecting a date field). It detects a date field in our indexes but then crashes trying to use it. Once you skip the data select field, just enter an index or alias to pull patterns from and it will automatically be configured to work well enough for initial data exploration.
+
 ### OpenSearch on AWS
 
 1. Ensure that you have the correct AWS credentials set for the Dev1 (or desired) account.

compose.yaml

@@ -0,0 +1,30 @@
+version: "3.8"
+services:
+  opensearch:
+    image: opensearchproject/opensearch:latest
+    ports:
+      - "9200:9200"
+      - "9600:9600"
+    environment:
+      - plugins.security.disabled=true
+      - discovery.type=single-node
+      - bootstrap.memory_lock=true
+      - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m"
+    volumes:
+      - opensearch-local-data:/usr/share/opensearch/data
+    networks:
+      - opensearch-local-net
+  dashboard:
+    image: opensearchproject/opensearch-dashboards:latest
+    ports:
+      - "5601:5601"
+    environment:
+      - "DISABLE_SECURITY_DASHBOARDS_PLUGIN=true"
+      - 'OPENSEARCH_HOSTS=["http://opensearch:9200"]'
+    networks:
+      - opensearch-local-net
+volumes:
+  opensearch-local-data:
+
+networks:
+  opensearch-local-net: