Update to include verification

This commit is contained in:
Michael McCaskill 2016-10-13 22:16:07 -04:00
parent 22106e1a31
commit 1ff595ba61
1 changed files with 16 additions and 0 deletions

View File

@ -40,6 +40,7 @@ docker run -p 8080:8080 -it -e DATA_FILE_URL="http://url.to/plugins.json.gzip" j
== Rebuild Elasticsearch data
=== Generate Plugin Data
----
mvn -P generatePluginData
----
@ -47,6 +48,21 @@ mvn -P generatePluginData
This will generate a new file in `target/plugins.json.gzip` consisting of plugin information and installation
statistics. This file should be uploaded to DATA_FILE_URL.
=== Verify Plugin Data
----
REST_API_URL="http://url.to.api" mvn -P verifyPluginData
----
This will check the /health/model endpoint and ensure it matches the model version within the generated plugin data.
Currently this is a SHA256 hash of the mappings and the Elasticsearch version string.
For the cases where Elasticsearch is upgraded or the mappings are changed this can prevent generating plugin data
that the deployed API cannot ingest. To get around this you can force the verification process. Afterwards the API
needs to be rebuilt and deployed
----
FORCE=true mvn -P verifyPluginData
----
== REST API Reference
WARNING: This API is still in flux as the frontend and backend are