[tinkerpop] branch master updated: Added README for sample data files in Gremlin Server CTR

[sp...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git


The following commit(s) were added to refs/heads/master by this push:
     new aea5d9a  Added README for sample data files in Gremlin Server CTR
aea5d9a is described below

commit aea5d9a58833efb5af2d4dcc17385b54e244bdbf
Author: Stephen Mallette <st...@amazon.com>
AuthorDate: Mon Nov 9 10:01:33 2020 -0500

    Added README for sample data files in Gremlin Server CTR
---
 gremlin-server/data/README.asciidoc        | 26 ++++++++++++++++++++++++++
 gremlin-server/src/assembly/standalone.xml |  3 +++
 2 files changed, 29 insertions(+)

diff --git a/gremlin-server/data/README.asciidoc b/gremlin-server/data/README.asciidoc
new file mode 100644
index 0000000..b3586b9
--- /dev/null
+++ b/gremlin-server/data/README.asciidoc
@@ -0,0 +1,26 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+////
+This directory contains data files that are packaged with Gremlin Server:
+
+* `credentials.kryo` - This data file contains a sample graph built from the
+link:https://tinkerpop.apache.org/docs/current/reference/#credentials-dsl[Credentials DSL] which contains a single
+user: `stephen/password`. This file is meant to be used by the `gremlin-server-secure.yaml` and
+`gremlin-server-rest-secure.yaml` configuration files to demonstrate basic authentication functions.
+* `sample.kryo` - This data file contains a random sample graph generated from the `DistributionGenerator` in
+`IoDataGenerateTest.shouldWriteSampleForGremlinServer()`. It can be configured for use in Gremlin Server by using the
+`load-sample.groovy` server initialization script file packaged with Gremlin Server. This graph has 10,000 vertices
+and approximately 100,000 edges (using a "knows" label).
diff --git a/gremlin-server/src/assembly/standalone.xml b/gremlin-server/src/assembly/standalone.xml
index f804623..e884267 100644
--- a/gremlin-server/src/assembly/standalone.xml
+++ b/gremlin-server/src/assembly/standalone.xml
@@ -57,6 +57,9 @@ limitations under the License.
         <fileSet>
             <directory>data</directory>
             <outputDirectory>/data</outputDirectory>
+            <excludes>
+                <exclude>README.asciidoc</exclude>
+            </excludes>
         </fileSet>
         <fileSet>
             <directory>../data</directory>