-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* Move examples to common location * clear notebooks * update proxy example * update main readme * remove gaffer-gremlin build * Apply suggestions from code review Co-authored-by: cn337131 <141730190+cn337131@users.noreply.github.com> Co-authored-by: p29876 <165825455+p29876@users.noreply.github.com> * address comments --------- Co-authored-by: cn337131 <141730190+cn337131@users.noreply.github.com> Co-authored-by: p29876 <165825455+p29876@users.noreply.github.com>
- Loading branch information
1 parent
a7210bb
commit 87f5d48
Showing
47 changed files
with
444 additions
and
444 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Example Gaffer Deployments | ||
|
||
These directories have basic examples of deploying containerised Gaffer with | ||
different store backings. Some example notebooks are also available which | ||
primarily feature the use of the Gremlin interface for interacting with the | ||
Graph. | ||
|
||
All examples will provide a Gaffer REST API to start interacting with the | ||
deployed graph. | ||
|
||
## Modern Example (Accumulo) | ||
|
||
The modern example, which uses the [Tinkerpop modern dataset](https://tinkerpop.apache.org/docs/current/tutorials/the-gremlin-console/#toy-graphs), | ||
can be found under the `modern-example` directory which features an Accumulo | ||
store as its storage backing. | ||
|
||
## Federation Example | ||
|
||
A demo/example of using Gaffer REST with a Federated Store is available under | ||
the `federated-example` directory. | ||
|
||
## Proxy Example | ||
|
||
A demo/example of using Gaffer REST with a Proxy Store is available under the | ||
`proxy-example` directory. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Gaffer Modern Example | ||
|
||
This is an example deployment of Gaffer on Accumulo. This uses a REST API | ||
deployment of Gaffer with full Accumulo and Hadoop storage backing. | ||
|
||
The example uses the | ||
[Tinkerpop Modern Graph](https://tinkerpop.apache.org/docs/current/tutorials/the-gremlin-console/#toy-graphs) | ||
as its data set to demonstrate basic querying of data. The data can be queried | ||
via the REST API using standard Gaffer operations or by using the Gremlin | ||
websocket (see [the docs](https://gchq.github.io/gaffer-doc/latest/user-guide/query/gremlin/gremlin.html) | ||
for more info). | ||
|
||
## Running the Example | ||
|
||
To run the example please use the provided start script with an environment file | ||
to specify the image versions e.g. `accumulo2.env`: | ||
|
||
```bash | ||
./create-deployment.sh ../../accumulo2.env | ||
``` | ||
|
||
With the demo deployment a standard Gaffer REST API will be started (available | ||
on port 8080 by default). Basic configuration for Accumulo and Hadoop have been | ||
added but can be modified to test out different | ||
scenarios, please see the [documentation](https://gchq.github.io/gaffer-doc/latest/administration-guide/gaffer-stores/accumulo-store.html) | ||
for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
docker/example-deployments/modern-example/conf/gaffer/schema/elements.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
{ | ||
"entities": { | ||
"id": { | ||
"vertex": "string.id" | ||
}, | ||
"person": { | ||
"vertex": "string.id", | ||
"properties": { | ||
"name": "property.string", | ||
"age": "property.integer" | ||
} | ||
}, | ||
"software": { | ||
"vertex": "string.id", | ||
"properties": { | ||
"name": "property.string", | ||
"lang": "property.string" | ||
} | ||
} | ||
}, | ||
"edges": { | ||
"knows": { | ||
"source": "string.id", | ||
"destination": "string.id", | ||
"directed": "true", | ||
"properties": { | ||
"weight": "property.double" | ||
} | ||
}, | ||
"created": { | ||
"source": "string.id", | ||
"destination": "string.id", | ||
"directed": "true", | ||
"properties": { | ||
"weight": "property.double" | ||
} | ||
}, | ||
"dependsOn": { | ||
"source": "string.id", | ||
"destination": "string.id", | ||
"directed": "true" | ||
}, | ||
"encapsulates": { | ||
"source": "string.id", | ||
"destination": "string.id", | ||
"directed": "true" | ||
} | ||
} | ||
} |
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
...ple/conf/gaffer/store-accumulo.properties → ...ple/conf/gaffer/store-accumulo.properties
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.