Commit addeaeb3 authored by rosejcday's avatar rosejcday Committed by Tao Feng

Updated installation document to include virtualbox install step which is...

Updated installation document to include virtualbox install step which is required for the first command to run. (#100)
parent 8340253a
...@@ -35,21 +35,22 @@ $ python3 amundsen_application/wsgi.py ...@@ -35,21 +35,22 @@ $ python3 amundsen_application/wsgi.py
The following instructions are for setting up a version of Amundsen using Docker. At the moment, we only support a bootstrap for connecting the Amundsen application to an example metadata service. The following instructions are for setting up a version of Amundsen using Docker. At the moment, we only support a bootstrap for connecting the Amundsen application to an example metadata service.
1. Install `docker`, `docker-compose`, and `docker-machine`. 1. Install `docker`, `docker-compose`, and `docker-machine`.
2. Start a managed docker virtual host using the following command: 2. Install `virtualbox`.
3. Start a managed docker virtual host using the following command:
```bash ```bash
# in our examples our machine is named 'default' # in our examples our machine is named 'default'
$ docker-machine create -d virtualbox default $ docker-machine create -d virtualbox default
``` ```
3. Check your docker daemon locally using: 4. Check your docker daemon locally using:
```bash ```bash
$ docker-machine ls $ docker-machine ls
``` ```
You should see the `default` machine listed, running on virtualbox with no errors listed. You should see the `default` machine listed, running on virtualbox with no errors listed.
4. Set up the docker environment using 5. Set up the docker environment using
```bash ```bash
$ eval $(docker-machine env default) $ eval $(docker-machine env default)
``` ```
5. Setup your local environment. 6. Setup your local environment.
* Clone [this repo](https://github.com/lyft/amundsenfrontendlibrary), [amundsenmetadatalibrary](https://github.com/lyft/amundsenmetadatalibrary), and [amundsensearchlibrary](https://github.com/lyft/amundsensearchlibrary). * Clone [this repo](https://github.com/lyft/amundsenfrontendlibrary), [amundsenmetadatalibrary](https://github.com/lyft/amundsenmetadatalibrary), and [amundsensearchlibrary](https://github.com/lyft/amundsensearchlibrary).
* In your local versions of each library, update the `LOCAL_HOST` in the `LocalConfig` with the IP used for the `default` docker machine. You can see the IP in the `URL` outputted from running `docker-machine ls`. * In your local versions of each library, update the `LOCAL_HOST` in the `LocalConfig` with the IP used for the `default` docker machine. You can see the IP in the `URL` outputted from running `docker-machine ls`.
* Build the docker images * Build the docker images
...@@ -63,12 +64,12 @@ $ eval $(docker-machine env default) ...@@ -63,12 +64,12 @@ $ eval $(docker-machine env default)
# in ~/<your-path-to-cloned-repo>/amundsensearchlibrary # in ~/<your-path-to-cloned-repo>/amundsensearchlibrary
$ docker build -f Dockerfile -t amundsen-search:latest . $ docker build -f Dockerfile -t amundsen-search:latest .
``` ```
6. Start all of the services using: 7. Start all of the services using:
```bash ```bash
# in ~/<your-path-to-cloned-repo>/amundsenfrontendlibrary # in ~/<your-path-to-cloned-repo>/amundsenfrontendlibrary
$ docker-compose -f docker-amundsen.yml up $ docker-compose -f docker-amundsen.yml up
``` ```
7. Ingest dummy data into Neo4j by doing the following: 8. Ingest dummy data into Neo4j by doing the following:
* Clone [amundsendatabuilder](https://github.com/lyft/amundsendatabuilder). * Clone [amundsendatabuilder](https://github.com/lyft/amundsendatabuilder).
* Update the `NEO4J_ENDPOINT` and `Elasticsearch host` in [sample_data_loader.py](https://github.com/lyft/amundsendatabuilder/blob/master/example/scripts/sample_data_loader.py) and replace `localhost` with the IP used for the `default` docker machine. You can see the IP in the `URL` outputted from running `docker-machine ls`. * Update the `NEO4J_ENDPOINT` and `Elasticsearch host` in [sample_data_loader.py](https://github.com/lyft/amundsendatabuilder/blob/master/example/scripts/sample_data_loader.py) and replace `localhost` with the IP used for the `default` docker machine. You can see the IP in the `URL` outputted from running `docker-machine ls`.
* Run the following commands: * Run the following commands:
...@@ -80,6 +81,6 @@ $ docker-compose -f docker-amundsen.yml up ...@@ -80,6 +81,6 @@ $ docker-compose -f docker-amundsen.yml up
$ python setup.py install $ python setup.py install
$ python example/scripts/sample_data_loader.py $ python example/scripts/sample_data_loader.py
``` ```
8. Verify dummy data has been ingested by viewing in Neo4j by visiting `http://YOUR-DOCKER-HOST-IP:7474/browser/` and run `MATCH (n:Table) RETURN n LIMIT 25` in the query box. You should see two tables -- `hive.test_schema.test_table1` and `dynamo.test_schema.test_table2`. 9. Verify dummy data has been ingested by viewing in Neo4j by visiting `http://YOUR-DOCKER-HOST-IP:7474/browser/` and run `MATCH (n:Table) RETURN n LIMIT 25` in the query box. You should see two tables -- `hive.test_schema.test_table1` and `dynamo.test_schema.test_table2`.
9. View UI at `http://YOUR-DOCKER-HOST-IP:5000/table_detail/gold/hive/test_schema/test_table1` or `/table_detail/gold/dynamo/test_schema/test_table2` 10. View UI at `http://YOUR-DOCKER-HOST-IP:5000/table_detail/gold/hive/test_schema/test_table1` or `/table_detail/gold/dynamo/test_schema/test_table2`
10. View UI at `http://YOUR-DOCKER-HOST-IP:5000` and try to search `test`, it should return some result. 11. View UI at `http://YOUR-DOCKER-HOST-IP:5000` and try to search `test`, it should return some result.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment