diff --git a/README.md b/README.md index 030a8944cc..7c955f5714 100644 --- a/README.md +++ b/README.md @@ -65,8 +65,8 @@ Execute the [DDL files][DDL] to create the required repository tables in **where 1. Get the source code: ```git clone https://github.com/linkedin/WhereHows.git``` 2. Put a few 3rd-party jar files to **metadata-etl/extralibs** directory. Some of these jar files may not be available in Maven Central or Artifactory. See [the download instrucitons][EXJAR] for more detail. ```cd WhereHows/metadata-etl/extralibs``` 3. Go back to the **WhereHows** root directory and build all the modules: ```./gradlew build``` -4. Go back to the **WhereHows** root directory and start the metadata ETL and API service: ```cd backend-service ; $PLAY_HOME/play run``` -5. Go back to the **WhereHows** root directory and start the web front-end: ```cd web ; $PLAY_HOME/play run``` Then WhereHows UI is available at http://localhost:9000 by default. For example, ```play run -Dhttp.port=19001``` will use port 19001 to serve UI. +4. Go back to the **WhereHows** root directory and start the metadata ETL and API service: ```cd backend-service ; $ACTIVATOR_HOME/bin/activator run``` +5. Go back to the **WhereHows** root directory and start the web front-end: ```cd web ; $ACTIVATOR_HOME/bin/activator run``` Then WhereHows UI is available at http://localhost:9000 by default. For example, ```play run -Dhttp.port=19001``` will use port 19001 to serve UI. ## Contribute diff --git a/backend-service/README.md b/backend-service/README.md index a23bca8da4..7a199c788f 100644 --- a/backend-service/README.md +++ b/backend-service/README.md @@ -33,21 +33,20 @@ Please become familiar with these pages: - https://github.com/linkedin/WhereHows - https://github.com/LinkedIn/Wherehows/wiki/Getting-Started -First set env variables to Play and Gradle: +First set env variables for Play (Activator): ``` export WH_HOME=~/development/wherehows/src/deployment/ -export PLAY_HOME=~/development/play-2.2.4 -export GRADLE_HOME=~/development/gradle-2.4 -export PATH=$PATH:$GRADLE_HOME/bin:$PLAY_HOME +export ACTIVATOR_HOME="$HOME/activator-1.3.11-minimal" +export SBT_OPTS="-Xms1G -Xmx1G -Xss2M" ``` ### Build: ``` -gradlew dist +./gradlew build dist ``` ### Install: -Download/upload the distribution binaries, unzip to +Download/upload the distribution binaries, unzip to ``` /opt/wherehows/backend-service-1.0-SNAPSHOT ``` @@ -118,10 +117,10 @@ export WHZ_DB_HOST= ``` Run backend service application on port 9001 (from the backend-service folder run: ``` -$PLAY_HOME/play “run -Dhttp.port=9001” +$ACTIVATOR_HOME/bin/activator “run -Dhttp.port=9001” ``` -In separate window, monitor -```tail -f /var/tmp/wherehows/wherehows.log``` +In separate window, monitor +```tail -f $APP_HOME/logs/console.log``` Open browser to ```http://:9001/``` This will show ‘TEST’. This is the RESTful api endpoint @@ -131,7 +130,7 @@ Run the web ui cd cd web # -$PLAY_HOME/play run +$ACTIVATOR_HOME/bin/activator run ``` ## Next steps @@ -148,7 +147,7 @@ select * from wh_property; select distinct wh_etl_job_name from wh_etl_job; -select j.wh_etl_job_name, j.ref_id_type, j.ref_id, +select j.wh_etl_job_name, j.ref_id_type, j.ref_id, coalesce(d.db_code, a.app_code) db_or_app_code, j.cron_expr, p.property_name, p.property_value from wh_etl_job j join wh_etl_job_property p