feat: pre-load some data in container(#840)

apache · Jul 11, 2023 · 82b09fa · 82b09fa
1 parent 8ee3d32
commit 82b09fa
Show file tree

Hide file tree

Showing 4 changed files with 235 additions and 2 deletions.
diff --git a/hugegraph-dist/README.md b/hugegraph-dist/README.md
@@ -0,0 +1,35 @@
+# Deploy Hugegraph server with docker compose(WIP)
+
+## 1. Deploy
+
+We can use `docker-compose up -d` to quickly start an inner HugeGraph server with RocksDB in background.
+
+The docker-compose.yaml is below:
+
+```yaml
+version: '3'
+services:
+  graph:
+    image: hugegraph/hugegraph
+    ports:
+      - 18080:8080
+```
+
+## 2. Create Sample Graph on Server Startup
+
+If you want to pre-load some data or graphs in container, you can set the env `PRELOAD=ture`
+
+If you want to customize the pre-loaded data, please mount the the groovy scripts
+
+```yaml
+version: '3'
+services:
+  graph:
+    image: hugegraph/hugegraph
+    environment:
+      - PRELOAD=true
+    volumes:
+      - /path/to/yourscript:/hugegraph/scripts/example-preload.groovy
+    ports:
+      - 18080:8080
+```
diff --git a/hugegraph-dist/src/assembly/static/bin/start-hugegraph.sh b/hugegraph-dist/src/assembly/static/bin/start-hugegraph.sh
@@ -79,13 +79,20 @@ if [ ! -d "$LOGS" ]; then
     mkdir -p "$LOGS"
 fi
 
+GERMLIN_SERVER_YAML="gremlin-server.yaml"
+
+if [ $PRELOAD ]; then
+    GERMLIN_SERVER_YAML="gremlin-server-preload.yaml"
+fi
+
+
 if [[ $DAEMON == "true" ]]; then
     echo "Starting HugeGraphServer in daemon mode..."
-    "${BIN}"/hugegraph-server.sh "${CONF}"/gremlin-server.yaml "${CONF}"/rest-server.properties \
+    "${BIN}"/hugegraph-server.sh "${CONF}"/"${GERMLIN_SERVER_YAML}" "${CONF}"/rest-server.properties \
     "${OPEN_SECURITY_CHECK}" "${USER_OPTION}" "${GC_OPTION}" >>"${LOGS}"/hugegraph-server.log 2>&1 &
 else
     echo "Starting HugeGraphServer in foreground mode..."
-    "${BIN}"/hugegraph-server.sh "${CONF}"/gremlin-server.yaml "${CONF}"/rest-server.properties \
+    "${BIN}"/hugegraph-server.sh "${CONF}"/"${GERMLIN_SERVER_YAML}" "${CONF}"/rest-server.properties \
     "${OPEN_SECURITY_CHECK}" "${USER_OPTION}" "${GC_OPTION}" >>"${LOGS}"/hugegraph-server.log 2>&1
 fi
 

diff --git a/hugegraph-dist/src/assembly/static/conf/gremlin-server-preload.yaml b/hugegraph-dist/src/assembly/static/conf/gremlin-server-preload.yaml
@@ -0,0 +1,126 @@
+#
+# 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.
+#
+# host and port of gremlin server, need to be consistent with host and port in rest-server.properties
+#host: 127.0.0.1
+#port: 8182
+
+# timeout in ms of gremlin query
+evaluationTimeout: 30000
+
+channelizer: org.apache.tinkerpop.gremlin.server.channel.WsAndHttpChannelizer
+# don't set graph at here, this happens after support for dynamically adding graph
+graphs: {
+}
+scriptEngines: {
+  gremlin-groovy: {
+    staticImports: [
+        org.opencypher.gremlin.process.traversal.CustomPredicates.*',
+        org.opencypher.gremlin.traversal.CustomFunctions.*
+    ],
+    plugins: {
+      org.apache.hugegraph.plugin.HugeGraphGremlinPlugin: {},
+      org.apache.tinkerpop.gremlin.server.jsr223.GremlinServerGremlinPlugin: {},
+      org.apache.tinkerpop.gremlin.jsr223.ImportGremlinPlugin: {
+        classImports: [
+          java.lang.Math,
+          org.apache.hugegraph.backend.id.IdGenerator,
+          org.apache.hugegraph.type.define.Directions,
+          org.apache.hugegraph.type.define.NodeRole,
+          org.apache.hugegraph.traversal.algorithm.CollectionPathsTraverser,
+          org.apache.hugegraph.traversal.algorithm.CountTraverser,
+          org.apache.hugegraph.traversal.algorithm.CustomizedCrosspointsTraverser,
+          org.apache.hugegraph.traversal.algorithm.CustomizePathsTraverser,
+          org.apache.hugegraph.traversal.algorithm.FusiformSimilarityTraverser,
+          org.apache.hugegraph.traversal.algorithm.HugeTraverser,
+          org.apache.hugegraph.traversal.algorithm.JaccardSimilarTraverser,
+          org.apache.hugegraph.traversal.algorithm.KneighborTraverser,
+          org.apache.hugegraph.traversal.algorithm.KoutTraverser,
+          org.apache.hugegraph.traversal.algorithm.MultiNodeShortestPathTraverser,
+          org.apache.hugegraph.traversal.algorithm.NeighborRankTraverser,
+          org.apache.hugegraph.traversal.algorithm.PathsTraverser,
+          org.apache.hugegraph.traversal.algorithm.PersonalRankTraverser,
+          org.apache.hugegraph.traversal.algorithm.SameNeighborTraverser,
+          org.apache.hugegraph.traversal.algorithm.ShortestPathTraverser,
+          org.apache.hugegraph.traversal.algorithm.SingleSourceShortestPathTraverser,
+          org.apache.hugegraph.traversal.algorithm.SubGraphTraverser,
+          org.apache.hugegraph.traversal.algorithm.TemplatePathsTraverser,
+          org.apache.hugegraph.traversal.algorithm.steps.EdgeStep,
+          org.apache.hugegraph.traversal.algorithm.steps.RepeatEdgeStep,
+          org.apache.hugegraph.traversal.algorithm.steps.WeightedEdgeStep,
+          org.apache.hugegraph.traversal.optimize.ConditionP,
+          org.apache.hugegraph.traversal.optimize.Text,
+          org.apache.hugegraph.traversal.optimize.TraversalUtil,
+          org.apache.hugegraph.util.DateUtil,
+          org.opencypher.gremlin.traversal.CustomFunctions,
+          org.opencypher.gremlin.traversal.CustomPredicate
+        ],
+        methodImports: [
+            java.lang.Math#*,
+            org.opencypher.gremlin.traversal.CustomPredicate#*,
+            org.opencypher.gremlin.traversal.CustomFunctions#*
+        ]
+      },
+      org.apache.tinkerpop.gremlin.jsr223.ScriptFileGremlinPlugin: {
+        files: [scripts/example-preload.groovy]
+      }
+    }
+  }
+}
+serializers:
+  - { className: org.apache.tinkerpop.gremlin.driver.ser.GraphBinaryMessageSerializerV1,
+      config: {
+        serializeResultToString: false,
+        ioRegistries: [org.apache.hugegraph.io.HugeGraphIoRegistry]
+      }
+  }
+  - { className: org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerV1d0,
+      config: {
+        serializeResultToString: false,
+        ioRegistries: [org.apache.hugegraph.io.HugeGraphIoRegistry]
+      }
+  }
+  - { className: org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerV2d0,
+      config: {
+        serializeResultToString: false,
+        ioRegistries: [org.apache.hugegraph.io.HugeGraphIoRegistry]
+      }
+  }
+  - { className: org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerV3d0,
+      config: {
+        serializeResultToString: false,
+        ioRegistries: [org.apache.hugegraph.io.HugeGraphIoRegistry]
+      }
+  }
+metrics: {
+  consoleReporter: {enabled: false, interval: 180000},
+  csvReporter: {enabled: false, interval: 180000, fileName: ./metrics/gremlin-server-metrics.csv},
+  jmxReporter: {enabled: false},
+  slf4jReporter: {enabled: false, interval: 180000},
+  gangliaReporter: {enabled: false, interval: 180000, addressingMode: MULTICAST},
+  graphiteReporter: {enabled: false, interval: 180000}
+}
+maxInitialLineLength: 4096
+maxHeaderSize: 8192
+maxChunkSize: 8192
+maxContentLength: 65536
+maxAccumulationBufferComponents: 1024
+resultIterationBatchSize: 64
+writeBufferLowWaterMark: 32768
+writeBufferHighWaterMark: 65536
+ssl: {
+  enabled: false
+}
diff --git a/hugegraph-dist/src/assembly/static/scripts/example-preload.groovy b/hugegraph-dist/src/assembly/static/scripts/example-preload.groovy
@@ -0,0 +1,65 @@
+/*
+ * 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.
+ */
+import org.apache.hugegraph.HugeFactory
+import org.apache.hugegraph.backend.id.IdGenerator
+import org.apache.hugegraph.dist.RegisterUtil
+import org.apache.hugegraph.type.define.NodeRole
+import org.apache.tinkerpop.gremlin.structure.T
+
+conf = "conf/graphs/hugegraph.properties"
+graph = HugeFactory.open(conf)
+schema = graph.schema()
+
+schema.propertyKey("name").asText().ifNotExist().create()
+schema.propertyKey("age").asInt().ifNotExist().create()
+schema.propertyKey("city").asText().ifNotExist().create()
+schema.propertyKey("weight").asDouble().ifNotExist().create()
+schema.propertyKey("lang").asText().ifNotExist().create()
+schema.propertyKey("date").asText().ifNotExist().create()
+schema.propertyKey("price").asInt().ifNotExist().create()
+
+schema.vertexLabel("person").properties("name", "age", "city").primaryKeys("name").ifNotExist().create()
+schema.vertexLabel("software").properties("name", "lang", "price").primaryKeys("name").ifNotExist().create()
+schema.indexLabel("personByCity").onV("person").by("city").secondary().ifNotExist().create()
+schema.indexLabel("personByAgeAndCity").onV("person").by("age", "city").secondary().ifNotExist().create()
+schema.indexLabel("softwareByPrice").onV("software").by("price").range().ifNotExist().create()
+schema.edgeLabel("knows").sourceLabel("person").targetLabel("person").properties("date", "weight").ifNotExist().create()
+schema.edgeLabel("created").sourceLabel("person").targetLabel("software").properties("date", "weight").ifNotExist().create()
+schema.indexLabel("createdByDate").onE("created").by("date").secondary().ifNotExist().create()
+schema.indexLabel("createdByWeight").onE("created").by("weight").range().ifNotExist().create()
+schema.indexLabel("knowsByWeight").onE("knows").by("weight").range().ifNotExist().create()
+
+marko = graph.addVertex(T.label, "person", "name", "marko", "age", 29, "city", "Beijing")
+vadas = graph.addVertex(T.label, "person", "name", "vadas", "age", 27, "city", "Hongkong")
+lop = graph.addVertex(T.label, "software", "name", "lop", "lang", "java", "price", 328)
+josh = graph.addVertex(T.label, "person", "name", "josh", "age", 32, "city", "Beijing")
+ripple = graph.addVertex(T.label, "software", "name", "ripple", "lang", "java", "price", 199)
+peter = graph.addVertex(T.label, "person", "name", "peter", "age", 35, "city", "Shanghai")
+
+marko.addEdge("knows", vadas, "date", "20160110", "weight", 0.5)
+marko.addEdge("knows", josh, "date", "20130220", "weight", 1.0)
+marko.addEdge("created", lop, "date", "20171210", "weight", 0.4)
+josh.addEdge("created", lop, "date", "20091111", "weight", 0.4)
+josh.addEdge("created", ripple, "date", "20171210", "weight", 1.0)
+peter.addEdge("created", lop, "date", "20170324", "weight", 0.2)
+
+graph.tx().commit()
+
+g = graph.traversal()
+
+System.out.println(">>>> query all vertices: size=" + g.V().toList().size())
+System.out.println(">>>> query all edges: size=" + g.E().toList().size())