README.md 10.5 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
    - [Data handling](#data-handling)
9
10
11
12
13
14
    - [Backend](#backend)
    - [Frontend](#frontend)
  - [Build](#build)
  - [CI](#ci)
  - [Documentation](#documentation)
  - [Harvest](#harvest)
15
    - [Portability](#portability)
16
17
18
  - [Indices and aliases](#indices-and-aliases)
  - [Spring Cloud config](#spring-cloud-config)
  - [Building other apps](#building-other-apps)
19

20
21
## Contribute

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

### Data

26
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.
27

28
29
30
### Code

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

32
33
## Setup

34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
### Data handling

At the moment, all data is located next to the code in the `data` directory. You might want to have a look at the code only, in such case, you can skip the data at git clone step by setting variable `GIT_LFS_SKIP_SMUDGE=1`, ie.:

```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
```

49
50
### Backend

51
The project uses Spring (5.x) for the backend, with Spring Boot.
52
53
54
55
56

You need to install:

- a recent enough JDK8

57
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
58
59
To have such an instance, simply run:

Raphaël Flores's avatar
Raphaël Flores committed
60
61
62
```sh
docker-compose up
```
Exbrayat Cédric's avatar
Exbrayat Cédric committed
63

Raphaël Flores's avatar
Raphaël Flores committed
64
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
65

66
67
68
Then at the root of the application, run `./gradlew build` to download the dependencies.
Then run `./gradlew bootRun` to start the app.

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

Raphaël Flores's avatar
Raphaël Flores committed
71
72
73
```sh
docker-compose stop
```
74
75

or run:
76

Raphaël Flores's avatar
Raphaël Flores committed
77
78
79
```sh
docker-compose down
```
80

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

83
84
### Frontend

85
The project uses Angular (8.x) for the frontend, with the Angular CLI.
86
87
88

You need to install:

Raphaël Flores's avatar
Raphaël Flores committed
89
- a recent enough NodeJS (ie. v12 LTS) is required for Angular 8.
90
91
92
93
94
- 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
95
The application will be available on:
96
97
98

- <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`)
99
- <http://localhost:4200/data-discovery-dev> for DataDiscovery (runs with: `yarn start:data-discovery`)
100
101

See [./frontend/package.json (scripts section)](./frontend/package.json) for other yarn commands.
102
103
104
105
106

## Build

To build the app, just run:

Raphaël Flores's avatar
Raphaël Flores committed
107
108
109
```sh
./gradlew assemble
```
110
111
112

or

Raphaël Flores's avatar
Raphaël Flores committed
113
114
115
```sh
./gradlew assemble -Papp=wheatis
```
116
117
118

which is a shortcut for

Raphaël Flores's avatar
Raphaël Flores committed
119
120
121
```sh
./gradlew assemble -Papp=wheatis && java -jar path/to/wheatis.jar
```
122

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

Raphaël Flores's avatar
Raphaël Flores committed
125
126
127
128
129
```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
130

131
And the full app running on:
132

133
134
135
- <http://localhost:8080/rare-dev>
- <http://localhost:8180/wheatis-dev>
- <http://localhost:8280/data-discovery-dev>
136
137
138
139
140

## CI

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

141
142
143
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
144
The image is based on `openjdk:8` and adds all stuff needed to run the tests
145
(ie. a Chrome binary with a headless Chrome in `--no-sandbox` mode).
146
147
148
149
150
151

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
152
153
154
```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
155

156
157
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
158
159
160
```sh
gitlab-runner exec docker test
```
161
162
163
164
165

## 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
166
by these tests. The documentation is generated in the folder `backend/build/asciidoc/html5/index.html`
167

Raphaël Flores's avatar
Raphaël Flores committed
168
169
170
```sh
./gradlew asciidoctor
```
171

Jean-Baptiste Nizet's avatar
Jean-Baptiste Nizet committed
172
173
## Harvest

174
175
176
177
178
179
Before all, if you've cloned the repository with git LFS data skipped (see [Data handling](#data-handling) section), take care to fetch the relevant data before running any indexing script.

### Portability

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.

180
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
181

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

Raphaël Flores's avatar
Raphaël Flores committed
184
185
186
```sh
./scripts/index.sh -app rare|wheat|data-discovery --local
```
Jean-Baptiste Nizet's avatar
Jean-Baptiste Nizet committed
187

188
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
189

190
191
## Indices and aliases

192
The application uses several physical indices:
193

194
195
- 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
196
197

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

199
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
200
201
{: .alert .alert-info}

202
203
204
205
206
207
208
209
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.
210

211
212
## Spring Cloud config

213
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.
214
215
216

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.
217

218
219
220
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.

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

223
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>
224
to check what has to be changed.
225

226
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).
227

228
229
230
231
232
233
234
235
## 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
236
237
238
```sh
./gradlew assemble -Papp=wheatis
```
239

240
241
You can also run the backend WheatIS application using

Raphaël Flores's avatar
Raphaël Flores committed
242
243
244
```sh
./gradlew bootRun -Papp=wheatis
```
245

246
247
Adding this property has the following consequences:

248
249
250
251
- 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`.

252
253
Since the active Spring profile is different, all the properties specific to this profile
are applies. In particular:
254
255
256

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

Raphaël Flores's avatar
Raphaël Flores committed
258
See the `backend/src/main/resources/application.yml` file for details.
259
260

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

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