Skip to content
This repository was archived by the owner on Oct 5, 2021. It is now read-only.

Commit f38b801

Browse files
Alexander PatrikalakisAlexander Patrikalakis
authored andcommitted
Update CloudFormation and testing documentation.
1 parent cc98849 commit f38b801

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -143,12 +143,12 @@ Skip the `TinkerGraph.open()` step as the remote execution environment already h
143143
`graph` variable set up. TinkerPop have
144144
[other tutorials](http://tinkerpop.apache.org/docs/3.2.3/#tutorials) available as well.
145145
146-
### Run Gremlin on Gremlin Server in EC2 using a CloudFormation template
147-
The DynamoDB Storage Backend for JanusGraph includes a CloudFormation template that
146+
### Run Gremlin on Gremlin Server in EC2 using CloudFormation templates
147+
The DynamoDB Storage Backend for JanusGraph includes CloudFormation templates that
148148
creates a VPC, an EC2 instance in the VPC, installs Gremlin Server with the
149149
DynamoDB Storage Backend for JanusGraph installed, and starts the Gremlin Server
150-
websockets endpoint. The Network ACL of the VPC includes just enough access to
151-
allow:
150+
Websocket endpoint. Also included are templates that create the graph's DynamoDB tables.
151+
The Network ACL of the VPC includes just enough access to allow:
152152
153153
- you to connect to the instance using SSH and create tunnels (SSH inbound)
154154
- the EC2 instance to download yum updates from central repositories (HTTP
@@ -171,27 +171,31 @@ Requirements for running this CloudFormation template include two items.
171171
write data in those tables.
172172
173173
Note, this cloud formation template downloads
174-
[repackaged versions](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tools.TitanDB.GremlinServerEC2.html)
175-
of the JanusGraph zip files available on the
174+
the JanusGraph zip files available on the
176175
[JanusGraph downloads page](https://github.com/JanusGraph/janusgraph/releases).
177-
We repackaged these zip files in order to include the DynamoDB Storage Backend
178-
for JanusGraph and its dependencies.
176+
The CloudFormation template downloads these packages and builds and adds the
177+
DynamoDB Storage Backend for JanusGraph with its dependencies.
179178
179+
####CloudFormation Template table
180+
Below you can find a list of CloudFormation templates discussed in this document,
181+
and links to launch each stack in CloudFormation and to view the stack in the designer.
182+
183+
| Template name | Description | View | View in Designer | Launch in us-west-2 |
184+
|----------------------------|------------------------------------------------------------|------|------------------|---------------------|
185+
| Single-Item Model Tables | Set up six graph tables with the single item data model. | [View](https://raw.githubusercontent.com/awslabs/dynamodb-titan-storage-backend/master/dynamodb-janusgraph-tables-single.yaml) | [View in Designer](https://console.aws.amazon.com/cloudformation/designer/home?region=us-west-2&templateURL=https://raw.githubusercontent.com/awslabs/dynamodb-titan-storage-backend/master/dynamodb-janusgraph-tables-single.yaml) | [Launch](https://console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks/new?stackName=JanusGraphTablesSingleItem&templateURL=https://raw.githubusercontent.com/awslabs/dynamodb-titan-storage-backend/master/dynamodb-janusgraph-tables-single.yaml) |
186+
| Multiple-Item Model Tables | Set up six graph tables with the multiple item data model. | [View](https://raw.githubusercontent.com/awslabs/dynamodb-titan-storage-backend/master/dynamodb-janusgraph-tables-multiple.yaml) | [View in Designer](https://console.aws.amazon.com/cloudformation/designer/home?region=us-west-2&templateURL=https://raw.githubusercontent.com/awslabs/dynamodb-titan-storage-backend/master/dynamodb-janusgraph-tables-multiple.yaml) | [Launch](https://console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks/new?stackName=JanusGraphTablesMultipleItem&templateURL=https://raw.githubusercontent.com/awslabs/dynamodb-titan-storage-backend/master/dynamodb-janusgraph-tables-multiple.yaml) |
187+
| Gremlin Server on DynamoDB | The HTTP user agent header to send with all requests. | [View](https://raw.githubusercontent.com/awslabs/dynamodb-titan-storage-backend/master/dynamodb-janusgraph-storage-backend-cfn.yaml) | [View in Designer](https://console.aws.amazon.com/cloudformation/designer/home?region=us-west-2&templateURL=https://raw.githubusercontent.com/awslabs/dynamodb-titan-storage-backend/master/dynamodb-janusgraph-storage-backend-cfn.yaml) | [Launch](https://console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks/new?stackName=DynamoDBJanusGraphGremlin&templateURL=https://raw.githubusercontent.com/awslabs/dynamodb-titan-storage-backend/master/dynamodb-janusgraph-storage-backend-cfn.yaml) |
188+
189+
####Instructions to Launch
180190
1. Choose between the single and multiple item data models and create your graph tables
181-
with the corresponding CloudFormation template
182-
([single](https://github.com/awslabs/dynamodb-titan-storage-backend/blob/janusgraph/dynamodb-janusgraph-tables-single.yaml),
183-
[multiple](https://github.com/awslabs/dynamodb-titan-storage-backend/blob/janusgraph/dynamodb-janusgraph-tables-multiple.yaml)).
191+
with the corresponding CloudFormation template above.
184192
Note, the configuration provided in dynamodb.properties assumes the multiple item model.
185-
2. Download the latest version of the CFN template from
186-
[GitHub](https://github.com/awslabs/dynamodb-titan-storage-backend/blob/janusgraph/dynamodb-janusgraph-storage-backend-cfn.yaml).
187-
3. Navigate to the
188-
[CloudFormation console](https://console.aws.amazon.com/cloudformation/home)
189-
and click Create Stack.
193+
2. Inspect the latest version of the Gremlin Server on DynamoDB stack in the third row above.
194+
3. Click the create stack link for Gremlin Server on DynamoDB to create the stack in us-west-2.
190195
4. On the Select Template page, name your Gremlin Server stack and select the
191196
CloudFormation template that you just downloaded.
192197
5. On the Specify Parameters page, you need to specify the following:
193198
* EC2 Instance Type
194-
* The network whitelist pattern for Gremlin Server Websockets port
195199
* The Gremlin Server port, default 8182.
196200
* The S3 URL to your dynamodb.properties configuration file
197201
* The name of your pre-existing EC2 SSH key. Be sure to `chmod 400` on your key as
@@ -415,8 +419,7 @@ credential configuration.
415419
-Dexclude.category=com.amazon.janusgraph.testcategory.SingleItemTestCategory \
416420
-Dinclude.category="**/*.java" > o 2>&1
417421
```
418-
5. Run other miscellaneous tests, as well as single and multiple-item tests that are known to
419-
fail on Travis CI.
422+
5. Run other miscellaneous tests.
420423
421424
```bash
422425
mvn verify -P integration-tests -Dinclude.category="**/*.java" \

0 commit comments

Comments
 (0)