Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 2.28 KB

README.md

File metadata and controls

60 lines (39 loc) · 2.28 KB
Raw

invana-engine

GraphQL API and Insights engine for Apache TinkerPop supported graph databases.

Note: Under active development.

Apache license Build Status Commit Activity codecov

Environment variables

Following environment variables are supported and optional variables can be used to authenticate gremlin server connection.

  • GREMLIN_SERVER_URL: http or ws gremlin url. ex: ws://xx.xx.xx.xx:8182/gremlin or http://xx.xx.xx.xx:8182/gremlin
  • GREMLIN_TRAVERSAL_SOURCE(optional): defaults: 'g'
  • GREMLIN_SERVER_USERNAME(optional): gremlin username. ex: myusername
  • GREMLIN_SERVER_PASSWORD(optional): gremlin password. ex: mypassword
  • SERVER_PORT(optional, available in standalone python mode only): port on which invana engine server is available: defaults to 8200

Running using Docker

docker run -p 8200:8200 -d  -e GREMLIN_SERVER_URL=ws://xx.xx.xx.xx:8182/gremlin --name invana-engine invanalabs/invana-engine

Running using standalone python

#example usage :
pip install invana-engine
or
pip install -e git+https://github.com/invanalabs/invana-engine.git@develop#egg=invana_engine

export GREMLIN_SERVER_URL=ws://xx.xx.xx.xx:8182/gremlin
invana-engine-start # this will start invana-engine server.

Optional env variable in cmd line SERVER_PORT can be used to run the invana engine server at port of your interest(defaults to 8200)

This will start invana-engine service at 8200 port. GraphQL API can be accessed at http://localhost:8200/graphql

Supported Graph Databases

  • janusgraph

Invana Engine uses gremlin at the core, so in theory any database that supports Apache TinkerPop's Gremlin 3.4.x shall work. Vertex/Edge Id resolution, needs to be fixed to add any new database support.

License

Apache License 2.0