-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README to include useful info
- Loading branch information
Showing
3 changed files
with
29 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,38 @@ | ||
# Integration Dashboard | ||
|
||
This dashboard provides the statuses of ASKEM's TA1 services. | ||
Specifically, the dashboard indicates | ||
- If an operation works with `knowledge-middleare` | ||
- How long that operation takes to complete | ||
- The quality of the outputs (not yet implemented) | ||
|
||
Currently, the dashboard is testing `knowledge-middleware` integration | ||
but other services and TAs might be checked in the future. | ||
|
||
![TA1 Dashboard Screenshot](./assets/ta1-dashboard-example.png) | ||
|
||
## Usage | ||
To set up the project, run | ||
``` | ||
docker build . -t integration-dashboard | ||
docker run --name dashboard -p8501:8501 integration-dashboard | ||
make init | ||
``` | ||
|
||
Add a new report by running | ||
To add a new report, run | ||
``` | ||
make report | ||
``` | ||
This uploads a `report_{datetime}.json` to S3 which the dashboard reads | ||
off of directly. | ||
|
||
|
||
To view the current status, start the [Streamlit](https://streamlit.io/) app | ||
by running: | ||
``` | ||
docker build . -t integration-dashboard | ||
docker run --name dashboard -p8501:8501 integration-dashboard | ||
``` | ||
Upon execution, you can pass the following environment variables (with `docker run` do `-e ENV_NAME='ENV_VAL'` for each variable). | ||
|
||
- `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`: Standard credentials for reading and writing to S3 | ||
- `BUCKET`: The bucket you'd like to read and write to. | ||
- `SKEMA_RS_URL`, `TA1_UNIFIED_URL`, and `MIT_TR_URL`: Provide overrides for the services being used. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.