From 4fbad780e4cffdad5073629627ddd22085f4c17f Mon Sep 17 00:00:00 2001 From: Suresh Srinivas Date: Fri, 13 Aug 2021 11:24:31 -0700 Subject: [PATCH] Docs: Add ElasticSearch docker warning --- .../metadata-ingestion/ingest-sample-data.md | 6 +++ docs/install/run-openmetadata.md | 42 ++++++++++++++----- 2 files changed, 37 insertions(+), 11 deletions(-) diff --git a/docs/install/metadata-ingestion/ingest-sample-data.md b/docs/install/metadata-ingestion/ingest-sample-data.md index 46a083a11b2..efbb5ca2602 100644 --- a/docs/install/metadata-ingestion/ingest-sample-data.md +++ b/docs/install/metadata-ingestion/ingest-sample-data.md @@ -50,6 +50,12 @@ metadata ingest -c ./pipelines/sample_users.json ### Index Sample Data into ElasticSearch Start Elastic Search Docker: +{% hint style="warning" %} + Below command to run elastic search docker stores the indexed data in memory. + If you stop the container it will lose any data on restart. + Please re-run the metadata_to_es workflow again to index the data upon starting + the container. +{% endhint %} ```bash docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch:7.10.2 diff --git a/docs/install/run-openmetadata.md b/docs/install/run-openmetadata.md index d6eda10442c..1b979e7c158 100644 --- a/docs/install/run-openmetadata.md +++ b/docs/install/run-openmetadata.md @@ -15,10 +15,6 @@ description: >- * Docker >= 20.10.x -**Ports to access once the docker is up:** - -* OpenMetadata UI: 8585 -* Scheduler UI: 7777 {% endhint %} ```bash @@ -27,6 +23,20 @@ cd OpenMetadata/docker/metadata docker-compose up ``` +Above command brings up all the necessary services + +1. MySQL +2. ElasticSearch +3. OpenMetadata Sever +4. Ingestion with SimpleScheduler + +To access the OpenMetadata + +Open [http://localhost:8585](http://localhost:8585) in your browser + +Scheduler UI available at [http://localhost:7777](http://localhost:7777) + + ## Run Manually {% hint style="success" %} @@ -90,9 +100,9 @@ cd openmetadata-1.0.0-SNAPSHOT * Install MySQL - ```text - brew install mysql - ``` + ```text + brew install mysql + ``` * Configure MySQL @@ -113,10 +123,10 @@ cd openmetadata-1.0.0-SNAPSHOT 2. Run bootstrap scripts to initiate the database and tables - ```text - cd openmetadata-0.3.0 - ./bootstrap/bootstrap_storage.sh migrate - ``` + ```text + cd openmetadata-0.3.0 + ./bootstrap/bootstrap_storage.sh migrate + ``` 3. Start the OpenMetadata Server @@ -124,4 +134,14 @@ cd openmetadata-1.0.0-SNAPSHOT cd openmetadata-0.3.0 ./bin/openmetadata.sh start ``` + +### Ingest Sample Data + +Previous steps starts the OpenMetadataServer. To start using using it +we need to run ElasticSearch and ingest sample metadata. Please follow the below +guide + +[Ingest Sample Data](./metadata-ingestion/ingest-sample-data.md) + +