doc(docker): add docker usage into README files; add a docker-compose file #1
Conversation
|
""" Walkthrough本次更改为 Vermeer 图计算引擎的文档和部署配置新增了基于 Docker 的运行说明。新增内容包括在中英文 README 中补充 Docker 和 Docker Compose 的使用方法，并引入了新的 docker-compose.yaml 文件以支持主节点和工作节点的容器化部署。 Changes
Poem
""" ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation to include instructions for running Vermeer using Docker and adds a docker-compose file to simplify container orchestration.
- Added a docker-compose file that defines master and worker services with static IP assignments.
- Updated both English and Chinese README files with usage instructions and example commands for running the image with Docker and docker-compose.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| vermeer/docker-compose.yaml | New compose configuration with master and worker services setup. |
| vermeer/README.zh-CN.md | Added Chinese Docker usage instructions along with example commands. |
| vermeer/README.md | Added English Docker usage instructions along with example commands. |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
@codecov-ai-reviewer review |
|
On it! We are reviewing the PR and will provide feedback shortly. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
vermeer/docker-compose.yaml (1)
18-18: 严重：禁止在 Docker Compose 中使用~
在 worker 服务的 volumes 行使用了~/，Docker Compose 不会展开~。请替换为${HOME}或绝对路径：- - ~/:/go/bin/config + - ${HOME}/:/go/bin/config
🧹 Nitpick comments (9)
vermeer/README.zh-CN.md (3)
6-19: 确保配置路径一致与安全性
在示例中，命令挂载了整个用户主目录（${HOME}/:/go/bin/config），可能暴露不必要的文件。建议仅挂载配置文件所在目录，例如：- docker run -v ${HOME}/:/go/bin/config … + docker run -v ${HOME}/vermeer-config:/go/bin/config …
13-13: 建议统一使用${HOME}语法
“创建好本地配置文件，例如~/master.ini与~/worker.ini” 中对~的使用与后续命令示例中的${HOME}不一致。为了避免混淆，建议统一替换为：- 例如 `~/master.ini` + 例如 `${HOME}/master.ini`
8-11: 代码块语法高亮
建议在三重反引号后添加shell或bash以开启语法高亮：```shell docker pull hugegraph/vermeer:latest</blockquote></details> <details> <summary>vermeer/README.md (3)</summary><blockquote> `6-20`: **保持中英文文档一致性** 与中文版本相同，建议示例中仅挂载配置目录，以减少权限暴露： ```diff - docker run -v ${HOME}/:/go/bin/config … + docker run -v ${HOME}/vermeer-config:/go/bin/config …
13-13: 统一路径写法
“创建本地配置文件，例如~/master.ini和~/worker.ini” 中使用了~，建议改为${HOME}以与后续挂载示例保持一致：- `~/master.ini` + `${HOME}/master.ini`
8-11: 增强可读性：标注代码块语言
可在反引号后标注bash或shell，提升示例的可读性：```bash docker pull hugegraph/vermeer:latest</blockquote></details> <details> <summary>vermeer/docker-compose.yaml (3)</summary><blockquote> `8-9`: **可选：细化挂载目录** 建议将挂载点从整个 `$HOME` 限制到具体配置目录，以降低安全风险： ```diff - - ${HOME}/:/go/bin/config + - ${HOME}/vermeer-config:/go/bin/config
1-29: 增强可用性：添加重启策略
推荐为服务添加restart: unless-stopped，并补充网络说明，提升容器稳定性：vermeer-master: image: hugegraph/vermeer + restart: unless-stopped networks: vermeer_network: ipv4_address: 172.20.0.10 vermeer-worker: image: hugegraph/vermeer + restart: unless-stopped networks: vermeer_network: ipv4_address: 172.20.0.11
29-29: 末尾缺少空行
根据 YAMLlint 提示，文件末尾应以空行结束。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
vermeer/README.md(1 hunks)vermeer/README.zh-CN.md(1 hunks)vermeer/docker-compose.yaml(1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
vermeer/docker-compose.yaml
[error] 29-29: no new line character at the end of file
(new-line-at-end-of-file)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: check-dependency-license
- GitHub Check: Analyze (java)
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
@codecov-ai-reviewer review |
|
On it! We are reviewing the PR and will provide feedback shortly. |
|
Due to the lack of activity, the current pr is marked as stale and will be closed after 180 days, any update will remove the stale label |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
vermeer/README.zh-CN.md (1)
9-11: 为代码块声明语言以通过 Markdown 规范检查
markdownlint报告缺少语言标识 (MD040)。在所有 Shell 示例前的 ``` 后补充bash（或 `shell`）即可消除告警，同时也能获得更好的语法高亮。-``` +```bash请对本段内 3 处代码块统一处理。
Also applies to: 16-19, 22-24
vermeer/README.md (1)
9-11: Add language to fenced code blocks for lint compliance
markdownlintwarns (MD040) because the fenced blocks omit a language tag.
Addbashafter ``` for all three shell snippets to gain syntax highlighting and silence the linter.-``` +```bashAlso applies to: 17-20, 24-26
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
vermeer/README.md(1 hunks)vermeer/README.zh-CN.md(1 hunks)vermeer/docker-compose.yaml(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- vermeer/docker-compose.yaml
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
vermeer/README.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
17-17: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
24-24: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
vermeer/README.zh-CN.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
17-17: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
24-24: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
| master: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=master | ||
| worker: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=worker |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Volume mount scope & env naming inconsistency
- Mounting the entire
${HOME}directory may leak unrelated files; limit the mount to a dedicated config folder, e.g.${HOME}/vermeer_conf:/go/bin/config. - The example uses
--env=worker, whereas later in the README it switches to--env=worker01. Align the examples to avoid confusion.
请运行以下脚本以确认 vermeer/README.md 中的 docker run 示例及 --env 参数用法是否一致：
🏁 Script executed:
#!/bin/bash
# 查找 docker run 挂载示例
grep -n "docker run" vermeer/README.md
# 查找所有 --env 参数用法
grep -n -- "--env=" vermeer/README.mdLength of output: 468
请限制 Docker 挂载范围并统一 --env 参数
为了避免泄露不相关文件，并消除示例中的命名混淆，请在 vermeer/README.md 中做如下调整：
• 将第 18–19 行的挂载路径
- docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=master
- docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=worker
+ docker run -v ${HOME}/vermeer_conf:/go/bin/config hugegraph/vermeer --env=master
+ docker run -v ${HOME}/vermeer_conf:/go/bin/config hugegraph/vermeer --env=worker改为只挂载专用配置目录 ${HOME}/vermeer_conf。
• 将第 32 行的 --env=worker01 改为与前面一致的 --env=worker，或反之全局统一为 worker01：
- worker: ./vermeer --env=worker01
+ worker: ./vermeer --env=worker📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| master: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=master | |
| worker: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=worker | |
| master: docker run -v ${HOME}/vermeer_conf:/go/bin/config hugegraph/vermeer --env=master | |
| worker: docker run -v ${HOME}/vermeer_conf:/go/bin/config hugegraph/vermeer --env=worker | |
| worker: ./vermeer --env=worker |
🤖 Prompt for AI Agents
In vermeer/README.md at lines 18 to 19, change the Docker volume mount path from
the broad ${HOME}/ to a more restricted directory ${HOME}/vermeer_conf to limit
file exposure. Also, ensure the --env parameter is consistent by changing the
value at line 32 from --env=worker01 to --env=worker, matching the earlier
usage, or alternatively update all occurrences to use worker01 for uniformity.
| master: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=master | ||
| worker: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=worker |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
挂载路径过宽且示例与后文 env 不一致
-v ${HOME}/:/go/bin/config会把整个用户主目录暴露到容器，风险较大，建议仅挂载配置目录，例如${HOME}/vermeer_conf:/go/bin/config。- 这里的
--env=worker与下方 “运行” 小节中的--env=worker01不一致，容易造成混淆，请统一命名。
下面运行脚本验证 vermeer/README.zh-CN.md 中的挂载路径和 --env 参数是否如评论中所述不一致：
🏁 Script executed:
#!/usr/bin/env bash
# 查找挂载 HOME 目录的命令
rg -n -- '-v \$\{HOME\}/' vermeer/README.zh-CN.md
# 查找所有 --env 标志及其参数
rg -n -- '--env' vermeer/README.zh-CN.mdLength of output: 515
请修正 README 示例的挂载路径和 --env 参数一致性
- 挂载路径过宽：第 17–18 行使用
-v ${HOME}/:/go/bin/config会暴露整个用户主目录，建议改为仅挂载配置目录，例如docker run -v ${HOME}/vermeer_conf:/go/bin/config hugegraph/vermeer --env=master docker run -v ${HOME}/vermeer_conf:/go/bin/config hugegraph/vermeer --env=worker
- 参数命名不统一：第 18 行 Docker 示例中使用
--env=worker，而第 30 行原生运行示例使用--env=worker01，容易混淆。请统一为同一标识（如都用worker01或都用worker），并同步更新所有示例。
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
17-17: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In vermeer/README.zh-CN.md around lines 17 to 18, update the Docker run commands
to mount only the specific configuration directory instead of the entire home
directory by changing the volume mount from '-v ${HOME}/:/go/bin/config' to '-v
${HOME}/vermeer_conf:/go/bin/config'. Also, ensure the '--env' parameter is
consistent across all examples by using the same identifier (either 'worker' or
'worker01') in both lines and update all related examples accordingly.
1 participant
Purpose of the PR
Main Changes
Verifying these changes
Does this PR potentially affect the following parts?
Documentation Status
Doc - TODODoc - DoneDoc - No NeedSummary by CodeRabbit
文档
新增功能