You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documents/panel.md
+13-6Lines changed: 13 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,22 +4,29 @@
4
4
The panel loader is designed to read a CSV file and load the data onto the HMDA-Platform. The CSV file should use the `|` (pipe) delimiter, and should include a header row as the first line.
5
5
6
6
## Environment Variables
7
-
There are two environment variables used by the panel loader. Both must be set correctly in order for the data to be sent to the admin API.
7
+
There is only one environment variable used by the panel loader. It must be set correctly in order for the data to be sent to the admin API.
8
8
9
-
For testing locally, no changes need to be made. The defaults for both of these variables will point to the correct local admin API.
9
+
For testing on an API running in SBT, no changes need to be made. The default for this variable will point to the correct local admin API.
10
10
11
-
For loading panel data into a remote system, you'll need to set the following environment variables:
11
+
For loading panel data into a remote system or into a local Docker container, you'll need to set the following environment variable:
12
12
```shell
13
-
>export HMDA_HTTP_ADMIN_HOST={ip address}
14
-
>export HMDA_HTTP_ADMIN_PORT={port #}
13
+
>export HMDA_HTTP_ADMIN_URL={base URL}
14
+
```
15
+
16
+
**IMPORTANT NOTE:** The base URL should *include*`http://` or `https://`, but *exclude* any trailing backslash `/`. For example:
A small example file is located at `panel/src/main/resources/inst_data_2017_dummy.csv`
19
24
20
25
The real panel file is located at `panel/src/main/resources/inst_data_2017.csv`
21
26
22
-
In order for the panel data to be loaded locally, the API project must be up and running, along with Docker containers running Cassandra and Zookeper. Otherwise, no other running services are needed (but make sure your environment variables are set). In a terminal, execute the following commands:
27
+
In order for the panel data to be loaded locally, the API project must be up and running, along with Docker containers running Cassandra and Zookeper, or run the full `docker-compose` setup. To load panel data into the cluster, simply find the URL of the admin api (for the release branch: `https://hmda-ops-api.demo.cfpb.gov/admin`). No other running services are necessary.
0 commit comments