feat(dist): support docker deployment for PD and Store (#2573)

Co-authored-by: imbajin <[email protected]>

.github/PULL_REQUEST_TEMPLATE.md

@@ -19,7 +19,7 @@ published)
 
 ## Purpose of the PR
 
-- close #xxx  <!-- or use "fix #xxx", "xxx" is the ID-link of related issue, e.g: close #1024 -->
+- close #xxx <!-- or use "fix #xxx", "xxx" is the ID-link of related issue, e.g: close #1024 -->
 
 <!--
 Please explain more context in this section, clarify why the changes are needed. 
@@ -30,7 +30,7 @@ e.g:
 
 ## Main Changes
 
-<!-- Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue. These change logs are helpful for better ant faster reviews.)
+<!-- Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue. These change logs are helpful for better and faster reviews.)
 
 For example:
 

.github/workflows/stale.yml

@@ -29,7 +29,7 @@ jobs:
         days-before-pr-stale: 30
         days-before-pr-close: 180
         operations-per-run: 10
-        start-date: '2017-10-01T00:00:00Z'
+        start-date: '2016-10-01T00:00:00Z'
 
         exempt-all-assignees: true
         remove-stale-when-updated: true

BUILDING.md

@@ -1,28 +1,35 @@
-Building hugegraph
+Building HugeGraph
 --------------
 
 Required:
 
-* Java 8/11
-* Maven
+* Java 11
+* Maven 3.5+
+
+To build without executing tests: `mvn clean package -DskipTests`
+
+## Building in IDEA
 
 To build without executing tests:
 
-```
-mvn clean 
-mvn package -DskipTests
-```
+1. Click on "File" -> "Open", choose your project location.
+2. Open maven view by click "View" -> "Tool Windows" -> "Maven Projects".
+3. Choose root module "hugegraph: Distributed Graph Database", unfold the menu of "Lifecycle".
+4. Click the "Toggle 'Skip Tests' Mode" button which is located on the top navibar of "Maven Projects" window to skip tests.
+5. Double click "package" or "install" to build a project.
+
+Could also refer [Dev-In-IDEA](https://hugegraph.apache.org/docs/contribution-guidelines/hugegraph-server-idea-setup/) for more details.
 
-## Building on Eclipse IDE
-Note that this has only been tested on Eclipse Neon.2 Release (4.6.2) with m2e (1.7.0.20160603-1933) and m2e-wtp (1.3.1.20160831-1005) plugin.
+## Building in Eclipse
 
+> Note: this has only been tested on Eclipse Neon.2 Release (4.6.2) with m2e (1.7.0.20160603-1933) and m2e-wtp (1.3.1.20160831-1005) plugin.
 
 To build without executing tests:
 
 1. Right-click on your project -> "Run As..." -> "Run Configurations..."
 2. On "Goals", populate with `install`
 3. Select the options `Update Snapshots` and `Skip Tests`
-4. Before clicking "Run", make sure that Eclipse knows where `JAVA_HOME` is. On same window, go to "Environment" tab and click "New".
+4. Before clicking "Run", make sure that Eclipse knows where `JAVA_HOME` is. In the same window, go to "Environment" tab and click "New".
 5. Under "Name:", add `JAVA_HOME`
 6. Under "Value:", add the path where `java` is located
 7. Click "OK"
@@ -32,13 +39,3 @@ To find the Java binary in your environment, run the appropriate command for you
 * Linux/macOS: `which java`
 * Windows: `for %i in (java.exe) do @echo. %~$PATH:i`
 
-## Building on IDEA
-
-To build without executing tests:
-
-1. Click on "File" -> "Open", choose your project location.
-2. Open maven view by click "View" -> "Tool Windows" -> "Maven Projects".
-3. Choose root module "hugegraph: Distributed Graph Database", unfold the menu of "Lifecycle".
-4. Click the "Toggle 'Skip Tests' Mode" button which is located on the top
-navibar of "Maven Projects" window to skip tests.
-5. Double click "package" or "install" to build project.

CONTRIBUTING.md

@@ -1,7 +1,9 @@
 # How to Contribute to HugeGraph
 
-Thanks for taking the time to contribute! As an open source project, HugeGraph is looking forward to be contributed from everyone, 
-and we are also grateful to all the contributors.
+> Refer [website-doc](https://hugegraph.apache.org/docs/contribution-guidelines/) for the latest information.
+
+Thanks for taking the time to contribute!
+As an open source project, HugeGraph is looking forward to being contributed from everyone, and we are also grateful to all the contributors.
 
 The following is a contribution guide for HugeGraph:
 
@@ -15,7 +17,7 @@ We can contribute by reporting issues, submitting code patches or any other feed
 
 Before submitting the code, we need to do some preparation:
 
-1. Sign up or login to GitHub:  [https://github.com](https://github.com)
+1. Sign up or login to GitHub: [https://github.com](https://github.com)
 
 2. Fork HugeGraph repo from GitHub: [https://github.com/apache/incubator-hugegraph/fork](https://github.com/apache/incubator-hugegraph/fork)
 
@@ -69,21 +71,21 @@ vim hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/HugeFacto
 # run test locally (optional)
 mvn test -Pcore-test,memory
 ```
-Note: In order to be consistent with the code style easily, if you use [IDEA](https://www.jetbrains.com/idea/) as your IDE, you can directly [import](https://www.jetbrains.com/help/idea/configuring-code-style.html) our code style [configuration file](./hugegraph-style.xml). 
+Note: To be consistent with the code style easily, if you use [IDEA](https://www.jetbrains.com/idea/) as your IDE, you can directly [import](https://www.jetbrains.com/help/idea/configuring-code-style.html) our code style [configuration file](./hugegraph-style.xml). 
 
 ##### 3.2.1 Check licenses
 If we want to add new third-party dependencies to the `HugeGraph` project, we need to do the following things:
 1. Find the third-party dependent repository, put the dependent `license` file into [./hugegraph-dist/release-docs/licenses/](https://github.com/apache/incubator-hugegraph/tree/master/hugegraph-dist/release-docs/licenses) path.
 2. Declare the dependency in [./hugegraph-server/hugegraph-dist/release-docs/LICENSE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/release-docs/LICENSE) `LICENSE` information.
 3. Find the NOTICE file in the repository and append it to [./hugegraph-server/hugegraph-dist/release-docs/NOTICE](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/release-docs/NOTICE) file (skip this step if there is no NOTICE file).
-4. Execute locally [./hugegraph-server/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh) to update the dependency list [known-dependencies.txt](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/scripts/dependency/known-dependencies.txt) (or manually update) .
+4. Execute locally [./hugegraph-server/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh) to update the dependency list [known-dependencies.txt](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/scripts/dependency/known-dependencies.txt) (or manually update).
 
 **Example**: A new third-party dependency is introduced into the project -> `ant-1.9.1.jar`
 - The project source code is located at: https://github.com/apache/ant/tree/rel/1.9.1
 - LICENSE file: https://github.com/apache/ant/blob/rel/1.9.1/LICENSE
 - NOTICE file: https://github.com/apache/ant/blob/rel/1.9.1/NOTICE
 
-The license information of `ant-1.9.1.jar` needs to be specified in the LICENSE file, and the notice information needs to be specified in the NOTICE file. The detailed LICENSE file corresponding to ant-1.9.1.jar needs to be copied to our licenses/ directory. Finally update the known-dependencies.txt file.
+The license information of `ant-1.9.1.jar` needs to be specified in the LICENSE file, and the notice information needs to be specified in the NOTICE file. The detailed LICENSE file corresponding to ant-1.9.1.jar needs to be copied to our licenses/ directory. Finally, update the known-dependencies.txt file.
 
 #### 3.3 Commit changes to git repo
 
@@ -105,7 +107,7 @@ Fix bug: run deploy multiple times
 fix #ISSUE_ID
 ```
 
->  Please remember to fill in the issue id, which was generated by GitHub after issue creation.
+>  Please remember to fill in the issue id, which GitHub generated after issue creation.
 
 #### 3.4 Push commit to GitHub fork repo
 
@@ -121,7 +123,7 @@ Note that since GitHub requires submitting code through `username + token` (inst
 
 ## 4. Create a Pull Request
 
-Go to the web page of GitHub fork repo, there would be a chance to create a Pull Request after pushing to a new branch, just click button "Compare & pull request" to do it. Then edit the description for proposed changes, which can just be copied from the commit message.
+Go to the web page of GitHub fork repo, there would be a chance to create a Pull Request after pushing to a new branch, click the button "Compare & pull request" to do it. Then edit the description for proposed changes, which can just be copied from the commit message.
 
 Note: please make sure the email address you used to submit the code is bound to the GitHub account. For how to bind the email address, please refer to https://github.com/settings/emails:
 <img width="1280" alt="image" src="https://user-images.githubusercontent.com/9625821/163522445-2a50a72a-dea2-434f-9868-3a0d40d0d037.png">
@@ -131,7 +133,7 @@ Note: please make sure the email address you used to submit the code is bound to
  Maintainers will start the code review after all the **automatic** checks are passed:
 
 - Check: Contributor License Agreement is signed
-- Check: Travis CI builds is passed (automatically Test and Deploy)
+- Check: Travis CI builds are passed (automatically Test and Deploy)
 
 The commit will be accepted and merged if there is no problem after review.
 
@@ -171,8 +173,8 @@ And push it to GitHub fork repo again:
 git push -f origin bugfix-branch:bugfix-branch
 ```
 
-GitHub will automatically update the Pull Request after we push it, just wait for code review.
+GitHub will automatically update the Pull Request after we push it, wait for code review.
 
-Any question please contact to us through [[email protected]](mailto:[email protected]) or [other contact information](https://hugegraph.github.io/hugegraph-doc/).
+For Any question, please contact us through [[email protected]](mailto:[email protected]) ([subscriber](https://hugegraph.apache.org/docs/contribution-guidelines/subscribe/) only)
 
 

README.md

@@ -37,7 +37,7 @@ achieved through [Gremlin](https://tinkerpop.apache.org/gremlin.html)(a powerful
 We can use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph` to quickly start an inner 
 HugeGraph server with `RocksDB` (in backgrounds) for **test/dev**.
 You can visit [doc page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#3-deploy) or
-the [README](hugegraph-server/hugegraph-dist/docker/READEME.md) for more details. ([Docker Compose](./hugegraph-server/hugegraph-dist/docker/example))
+the [README](hugegraph-server/hugegraph-dist/docker/README.md) for more details. ([Docker Compose](./hugegraph-server/hugegraph-dist/docker/example))
 
 > Note:
 >  

docker/configs/application-pd0.yml

@@ -0,0 +1,63 @@
+#
+# 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.
+#
+
+spring:
+  application:
+    name: hugegraph-pd
+
+management:
+  metrics:
+    export:
+      prometheus:
+        enabled: true
+  endpoints:
+    web:
+      exposure:
+        include: "*"
+
+logging:
+  config: 'file:./conf/log4j2.xml'
+license:
+  verify-path: ./conf/verify-license.json
+  license-path: ./conf/hugegraph.license
+grpc:
+  port: 8686
+  host: 127.0.0.1
+
+server:
+  port: 8620
+
+pd:
+  data-path: ./pd_data
+  patrol-interval: 1800
+  initial-store-count: 3
+  initial-store-list: 127.0.0.1:8500,127.0.0.1:8501,127.0.0.1:8502
+
+raft:
+  address: 127.0.0.1:8610
+  peers-list: 127.0.0.1:8610,127.0.0.1:8611,127.0.0.1:8612
+
+store:
+  max-down-time: 172800
+  monitor_data_enabled: true
+  monitor_data_interval: 1 minute
+  monitor_data_retention: 1 day
+  initial-store-count: 1
+
+partition:
+  default-shard-count: 1
+  store-max-shard-count: 12

docker/configs/application-pd1.yml

@@ -0,0 +1,63 @@
+#
+# 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.
+#
+
+spring:
+  application:
+    name: hugegraph-pd
+
+management:
+  metrics:
+    export:
+      prometheus:
+        enabled: true
+  endpoints:
+    web:
+      exposure:
+        include: "*"
+
+logging:
+  config: 'file:./conf/log4j2.xml'
+license:
+  verify-path: ./conf/verify-license.json
+  license-path: ./conf/hugegraph.license
+grpc:
+  port: 8687
+  host: 127.0.0.1
+
+server:
+  port: 8621
+
+pd:
+  data-path: ./pd_data
+  patrol-interval: 1800
+  initial-store-count: 3
+  initial-store-list: 127.0.0.1:8500,127.0.0.1:8501,127.0.0.1:8502
+
+raft:
+  address: 127.0.0.1:8611
+  peers-list: 127.0.0.1:8610,127.0.0.1:8611,127.0.0.1:8612
+
+store:
+  max-down-time: 172800
+  monitor_data_enabled: true
+  monitor_data_interval: 1 minute
+  monitor_data_retention: 1 day
+  initial-store-count: 1
+
+partition:
+  default-shard-count: 1
+  store-max-shard-count: 12

docker/configs/application-pd2.yml

@@ -0,0 +1,63 @@
+#
+# 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.
+#
+
+spring:
+  application:
+    name: hugegraph-pd
+
+management:
+  metrics:
+    export:
+      prometheus:
+        enabled: true
+  endpoints:
+    web:
+      exposure:
+        include: "*"
+
+logging:
+  config: 'file:./conf/log4j2.xml'
+license:
+  verify-path: ./conf/verify-license.json
+  license-path: ./conf/hugegraph.license
+grpc:
+  port: 8688
+  host: 127.0.0.1
+
+server:
+  port: 8622
+
+pd:
+  data-path: ./pd_data
+  patrol-interval: 1800
+  initial-store-count: 3
+  initial-store-list: 127.0.0.1:8500,127.0.0.1:8501,127.0.0.1:8502
+
+raft:
+  address: 127.0.0.1:8612
+  peers-list: 127.0.0.1:8610,127.0.0.1:8611,127.0.0.1:8612
+
+store:
+  max-down-time: 172800
+  monitor_data_enabled: true
+  monitor_data_interval: 1 minute
+  monitor_data_retention: 1 day
+  initial-store-count: 1
+
+partition:
+  default-shard-count: 1
+  store-max-shard-count: 12