diff --git a/README.md b/README.md index 96f6a8c..477ab44 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,11 @@ AWS ES service authenticator for JanusGraph ES indexing backend based on aws-sig A custom authenticator for [JanusGraph](https://github.com/JanusGraph/janusgraph) ES indexing backend created to support AWS' [Elasticsearch Service](https://aws.amazon.com/elasticsearch-service/). +Building +-------- + +Run `mvn clean package` and use the ZIP file from target/ directory. This ZIP file will contain all JARs needed to be made available to JanusGraph in its "lib" directory". + Usage ----- @@ -18,7 +23,7 @@ index..elasticsearch.elasticsearch.http.auth.custom.authenticator-ar This authenticator does not require any arguments. It relies on both AWS default credentials provider chain (http://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html) and default region provider chain (http://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html). So it may be useful in the environments like AWS Elastic Container Service etc. -JanusGraph version note ------------------------ +JanusGraph minimal version +-------------------------- -For now this module is based on an unreleased (and also unmerged) set of changes extending JanusGraph ES REST API support to support the custom authenticators. This README will be updated once this support is available. +The functionality this module depends on is available in JanusGraph as of version 0.3.0. diff --git a/pom.xml b/pom.xml index e1fb197..feea0f8 100644 --- a/pom.xml +++ b/pom.xml @@ -3,14 +3,16 @@ 4.0.0 com.newforma janusgraph-es-aws-authenticator - 0.0.1-SNAPSHOT + + 0.3.1 JanusGraph AWS Authenticator A plug-in for JanusGraph ES REST providing performing authentication for AWS ES service - 0.2.0 - 0.0.20 - 1.11.125 - 3.0.2 + 0.3.1 + 0.0.22 + + 1.11.281 + 3.1.1 @@ -62,6 +64,24 @@ + + org.apache.maven.plugins + maven-assembly-plugin + + + package + + single + + + false + + src/main/assembly/zip.xml + + + + + - \ No newline at end of file + diff --git a/src/main/assembly/zip.xml b/src/main/assembly/zip.xml new file mode 100644 index 0000000..54403fd --- /dev/null +++ b/src/main/assembly/zip.xml @@ -0,0 +1,32 @@ + + zip + true + + + zip + + + + ${project.basedir}/README.md + / + + + ${project.basedir}/LICENSE + / + + + ${project.build.directory}/${project.artifactId}-${project.version}.jar + /lib + + + + + /lib + + ${project.groupId}:${project.artifactId}:jar:* + + + +