README.md 11.3 KB
Newer Older
1
2
# Rare project - Data discovery

3
4
5
6
7
- [Rare project - Data discovery](#rare-project---data-discovery)
  - [Contribute](#contribute)
    - [Data](#data)
    - [Code](#code)
  - [Setup](#setup)
8
    - [Requirements](#requirements)
9
    - [Data handling](#data-handling)
10
11
12
13
14
15
    - [Backend](#backend)
    - [Frontend](#frontend)
  - [Build](#build)
  - [CI](#ci)
  - [Documentation](#documentation)
  - [Harvest](#harvest)
16
    - [Portability](#portability)
17
18
19
  - [Indices and aliases](#indices-and-aliases)
  - [Spring Cloud config](#spring-cloud-config)
  - [Building other apps](#building-other-apps)
20

21
22
## Contribute

23
If you want to install the program locally, it's cool, just keep reading at [Setup section and beyond](#setup).
24
25
26

### Data

27
You might probably want to know how to contribute to the federation of data. That's great, let's have a look at the [WheatIS/Plant guide](./HOW-TO-JOIN-WHEATIS-AND-PLANT-FEDERATIONS.md) or the [RARe guide](./HOW-TO-JOIN-RARe-FEDERATION.md) to know how to.
28

29
30
31
### Code

If you do want to contribute to code, that's great also, have a look at [CONTRIBUTING.md](./CONTRIBUTING.MD).
32

33
34
## Setup

35
36
37
38
39
40
41
42
43
44
45
46
47
48
### Requirements

The application itself is running under a Java OpenJDK 8+: <https://openjdk.java.net/install/>

For getting the data, you need to install Git LFS: <https://git-lfs.github.com/>

The indexing process depends on the following tools, you need to have them installed and available in your `PATH` variable:

- JQ 1.6+: <https://stedolan.github.io/jq/>
- GNU Parallel (recent enough version): <https://www.gnu.org/software/parallel/>
- GNU coreutils (sed, date...): <https://www.gnu.org/software/coreutils/>
- GNU GZIP: <https://git.savannah.gnu.org/cgit/gzip.git>
- GNU Bash v4+: <https://www.gnu.org/software/bash/>

49
50
### Data handling

51
At the moment, all data is located next to the code in the `data` directory. If you want to have a look at the code only, you can ignore this directory at git clone step by setting the variable `GIT_LFS_SKIP_SMUDGE=1`, ie.:
52
53
54
55
56
57
58
59
60
61
62
63

```sh
GIT_LFS_SKIP_SMUDGE=1 git clone git@forgemia.inra.fr:urgi-is/data-discovery.git
```

After clone done, if you want to fetch some of the data (for instance for RARe only), let's run:

```sh
$ git lfs pull -I data/rare/
Downloading LFS objects: 100% (16/16), 8.8 MB | 0 B/s
```

64
65
### Backend

66
The project uses Spring (5.x) for the backend, with Spring Boot.
67
68
69
70
71

You need to install:

- a recent enough JDK8

72
73
74
The docker images need quite a bit of resources,
so make sure you have at least 4g of RAM configured (Docker Desktop / Resources / Memory).

75
The application expects to connect on an Elasticsearch instance running on `http://127.0.0.1:9200`.
Exbrayat Cédric's avatar
Exbrayat Cédric committed
76
77
To have such an instance, simply run:

Raphaël Flores's avatar
Raphaël Flores committed
78
79
80
```sh
docker-compose up
```
Exbrayat Cédric's avatar
Exbrayat Cédric committed
81

Raphaël Flores's avatar
Raphaël Flores committed
82
And this will start Elasticsearch and a Kibana instance (allowing to explore the data on <http://localhost:5601>).
Exbrayat Cédric's avatar
Exbrayat Cédric committed
83

84
85
86
Then at the root of the application, run `./gradlew build` to download the dependencies.
Then run `./gradlew bootRun` to start the app.

87
You can stop the Elasticsearch and Kibana instances by running:
Exbrayat Cédric's avatar
Exbrayat Cédric committed
88

Raphaël Flores's avatar
Raphaël Flores committed
89
90
91
```sh
docker-compose stop
```
92
93

or run:
94

Raphaël Flores's avatar
Raphaël Flores committed
95
96
97
```sh
docker-compose down
```
98

99
to also remove the stopped containers as well as any networks that were created.
Exbrayat Cédric's avatar
Exbrayat Cédric committed
100

101
102
### Frontend

103
The project uses Angular (8.x) for the frontend, with the Angular CLI.
104
105
106

You need to install:

Raphaël Flores's avatar
Raphaël Flores committed
107
- a recent enough NodeJS (ie. v12 LTS) is required for Angular 8.
108
109
110
111
112
- Yarn as a package manager (see [here to install](https://yarnpkg.com/en/docs/install))

Then in the `frontend` directory, run `yarn` to download the dependencies.
Then run `yarn start` to start the app, using the proxy conf to reroute calls to `/api` to the backend.

Raphaël Flores's avatar
Raphaël Flores committed
113
The application will be available on:
114
115
116

- <http://localhost:4000/rare-dev> for RARe (runs with: `yarn start:rare` or simply `yarn start`)
- <http://localhost:4100/wheatis-dev> for WheatIS (runs with: `yarn start:wheatis`)
117
- <http://localhost:4200/data-discovery-dev> for DataDiscovery (runs with: `yarn start:data-discovery`)
118
119

See [./frontend/package.json (scripts section)](./frontend/package.json) for other yarn commands.
120
121
122
123
124

## Build

To build the app, just run:

Raphaël Flores's avatar
Raphaël Flores committed
125
126
127
```sh
./gradlew assemble
```
128
129
130

or

Raphaël Flores's avatar
Raphaël Flores committed
131
132
133
```sh
./gradlew assemble -Papp=wheatis
```
134
135
136

which is a shortcut for

Raphaël Flores's avatar
Raphaël Flores committed
137
138
139
```sh
./gradlew assemble -Papp=wheatis && java -jar path/to/wheatis.jar
```
140

141
This will build a standalone jar at `backend/build/libs/`, that you can run with either:
142

Raphaël Flores's avatar
Raphaël Flores committed
143
144
145
146
147
```sh
java -jar backend/build/libs/rare.jar
java -jar backend/build/libs/wheatis.jar
java -jar backend/build/libs/data-discovery.jar
```
Raphaël Flores's avatar
Raphaël Flores committed
148

149
And the full app running on:
150

151
152
153
- <http://localhost:8080/rare-dev>
- <http://localhost:8180/wheatis-dev>
- <http://localhost:8280/data-discovery-dev>
154
155
156
157
158

## CI

The `.gitlab-ci.yml` file describes how Gitlab is running the CI jobs.

159
160
161
It uses a base docker image named `urgi/docker-browsers`
available on [DockerHub](https://hub.docker.com/r/urgi/docker-browsers/)
and [INRA-MIA Gitlab](https://forgemia.inra.fr/urgi-is/docker-rare).
Raphaël Flores's avatar
Raphaël Flores committed
162
The image is based on `openjdk:8` and adds all stuff needed to run the tests
163
(ie. a Chrome binary with a headless Chrome in `--no-sandbox` mode).
164
165
166
167
168
169

We install `node` and `yarn` in `/tmp` (this is not the case for local builds)
to avoid symbolic links issues on Docker.

You can approximate what runs on CI by executing:

Raphaël Flores's avatar
Raphaël Flores committed
170
171
172
```sh
docker run --rm -v "$PWD":/home/rare -w /home/rare urgi/docker-browsers ./gradlew build
```
Jean-Baptiste Nizet's avatar
Jean-Baptiste Nizet committed
173

174
175
Or also run a gitlab-runner as Gitlab-CI would do (minus the environment variables and caching system):

Raphaël Flores's avatar
Raphaël Flores committed
176
177
178
```sh
gitlab-runner exec docker test
```
179
180
181
182
183

## Documentation

An API documentation describing most of the webservices can be generated using the
build task `asciidoctor`, which executes tests and generates documentation based on snippets generated
184
by these tests. The documentation is generated in the folder `backend/build/asciidoc/html5/index.html`
185

Raphaël Flores's avatar
Raphaël Flores committed
186
187
188
```sh
./gradlew asciidoctor
```
189

Jean-Baptiste Nizet's avatar
Jean-Baptiste Nizet committed
190
191
## Harvest

192
Before all, if you have cloned the repository without fetching the data (see [Data handling](#data-handling) section), take care to get it before running any indexing script.
193
194
195

### Portability

196
197
198
199
200
201
202
203
Feedback related to portability on MacOS and other GNU/Linux distro is really welcomed.

For MacOS, care to use latest GNU Parallel and Bash v4 versions, not the version provided by default via Brew.
Install the following packages to be able to run the scripts:

```sh
brew install gnu-sed coreutils parallel
```
204

205
Harvesting (i.e. importing JSON documents into Elasticsearch) consists in creating the necessary index and aliases and Elasticsearch templates.
Jean-Baptiste Nizet's avatar
Jean-Baptiste Nizet committed
206

Raphaël Flores's avatar
Raphaël Flores committed
207
To create the index and its aliases execute the script below for local dev environment:
208

Raphaël Flores's avatar
Raphaël Flores committed
209
210
211
```sh
./scripts/index.sh -app rare|wheat|data-discovery --local
```
Jean-Baptiste Nizet's avatar
Jean-Baptiste Nizet committed
212

213
The -app parameter will trigger a harvest of the resources stored in the Git LFS directories `data/rare`, `data/wheatis` and `data/data-discovery` respectively.
Raphaël Flores's avatar
Raphaël Flores committed
214

215
216
## Indices and aliases

217
The application uses several physical indices:
218

219
220
- one to store physical resources, containing the main content
- one to store suggestions, use for the search type-ahead feature only
Raphaël Flores's avatar
Raphaël Flores committed
221
222

Both indices must be created explicitly before using the application. If not, requests to the web services will return errors.
223

224
Each index and alias below refers to `rare` application in `dev` environment, the equivalent shall be created for `wheatis` and `data-discovery` app in `dev` environment as same as in `beta` or `staging` or `prod` environments. For brevity, only `rare-dev` is explained here.
Raphaël Flores's avatar
Raphaël Flores committed
225
226
{: .alert .alert-info}

227
228
229
230
231
232
233
234
The application doesn't use the physical resources index directly. Instead, it uses two aliases, that must be created before using the application:

- `rare-dev-resource-alias` is the alias used by the application to store and search for documents
- `rare-dev-suggestions-alias` is the alias used by the application to store and search for suggestions, only used for completion service.

In normal operations, these two aliases should refer to physical indices having a timestamp such as `rare-dev-tmstp1579877133-suggestions` and `rare-dev-tmstp1579877133-resource-index`. Those timestamps allow for reindexing data without breaking another runnning application having another timestamp. The alias switch being done atomicly, we always see data in the web interface.

Using two aliases is useful when deleting obsolete documents. This is actually done by removing everything and then harvesting the new JSON files again, to re-populate the index from scratch.
235

236
237
## Spring Cloud config

238
On bootstrap, the application will try to connect to a remote Spring Cloud config server to fetch its configuration. The details of this remote server are filled in the `bootstrap.yml` file. By default, it tries to connect to the local server on <http://localhost:8888> but it can of course be changed, or even configured via the `SPRING_CONFIG_URI` environment variable.
239
240
241

It will try to fetch the configuration for the application name `rare`, and the default profile.
If such a configuration is not found, it will then fallback to the local `application.yml` properties.
242

243
244
245
To avoid running the Spring Cloud config server every time when developing the application,
all the properties are still available in `application.yml` even if they are configured on the remote Spring Cloud server as well.

246
If you want to use the Spring Cloud config app locally, see <https://forgemia.inra.fr/urgi-is/data-discovery-config>
247

248
The configuration is currently only read on startup, meaning the application has to be reboot if the configuration is changed on the Spring Cloud server. For a dynamic reload without restarting the application, see <http://cloud.spring.io/spring-cloud-static/Finchley.SR1/single/spring-cloud.html#refresh-scope>
249
to check what has to be changed.
250

251
In case of testing configuration from the config server, one may use a dedicated branch on `data-discovery-config` project and append the `--spring.cloud.config.label=<branch name to test>` parameter when starting the application's executable jar. More info on [how to pass a parameter to a Spring Boot app](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html#boot-features-external-config).
252

253
254
255
256
257
258
259
260
## Building other apps

By default, the built application is RARe. But this project actually allows building other
applications (WheatIS, for the moment, but more could come).

To build a different app, specify an `app` property when building. For example, to assemble
the WheatIS app, run the following command

Raphaël Flores's avatar
Raphaël Flores committed
261
262
263
```sh
./gradlew assemble -Papp=wheatis
```
264

265
266
You can also run the backend WheatIS application using

Raphaël Flores's avatar
Raphaël Flores committed
267
268
269
```sh
./gradlew bootRun -Papp=wheatis
```
270

271
272
Adding this property has the following consequences:

273
274
275
276
- the generated jar file (in `backend/build/libs`) is named `wheatis.jar` instead of `rare.jar`;
- the Spring active profile in `bootstrap.yml` is `wheatis-app` instead of `rare-app`;
- the frontend application built and embedded inside the jar file is the WheatIS frontend application instead of the  RARe frontend application, i.e. the frontend command `yarn build:wheatis` is executed instead of the command `yarn:rare`.

277
278
Since the active Spring profile is different, all the properties specific to this profile
are applies. In particular:
279
280
281

- the context path of the application is `/wheatis-dev` instead of `/rare-dev`;
- the Elasticsearch prefix used for the index aliases is different.
282

Raphaël Flores's avatar
Raphaël Flores committed
283
See the `backend/src/main/resources/application.yml` file for details.
284
285

You can adapt the elasticsearch index used with the following parameter
286

Raphaël Flores's avatar
Raphaël Flores committed
287
288
289
```sh
java -jar backend/build/libs/data-discovery.jar --data-discovery.elasticsearch-prefix="data-discovery-staging-"
```