rtyler
/
plugin-site
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

README clean up

This commit is contained in:
Michael McCaskill 2016-10-11 13:16:01 -04:00
parent 02dc9842f8
commit 8dbe9359a4
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.asc
View File

@ -1,12 +1,12 @@
= Plugin Site API
This the backend API for Jenkins Plugin Site frontend. It provides a REST API
This is the backend API for Jenkins Plugin Site frontend. It provides a REST API
to allow searching for plugins and retrieving specific plugin information.
== Architecture
The REST API calls are powered by Jersey 2.x running inside of Tomcat 8. Plugins
are stored and search via embedded Elasticsearch.
are stored and searched via embedded Elasticsearch.
Plugin information sources include:
@ -17,11 +17,11 @@ Plugin information sources include:
* Jenkins Wiki
** Scrape wiki content
Elasticsearch mappings and data are initialized at runtime using a temporary
directory that is cleaned up at shutdown. The data is generated via separate
process and is currently stored in src/main/resources but in the future
will likely be available in the cloud so that it can be updated independently
of the application.
Elasticsearch mappings are initialized at runtime using a temporary
directory that is cleaned up at shutdown. The data is generated via a separate
Maven task and stored on an external URL outside of the application. The data file is downloaded from
said URL and extracted at boot time. Every 12 hours the application will download the file again and check if it
contains new data. If so the application will the reindex the Elasticsearch data using the new data file.
== Run Local Plugin Site API