Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add cassandra docker usage of server & enhance loader desc #299

Merged
merged 6 commits into from
Nov 20, 2023

Conversation

aroundabout
Copy link
Contributor

@aroundabout aroundabout commented Nov 6, 2023

…image of loader

Main change

  1. supplement how to use cassandra in the docker image of server
  2. supplement how to use docker image of loader

Increment

The increment is about how to use loader with docker:
image
img_v3_0258_20a1c189-c5bf-43cb-b8c9-709c2dc46feg

DIff

The diff is mainly about oracle and folding some files:

  1. orcale
    before:
    image
    after:
    image

  2. fold
    before:
    image
    after:
    image

  3. fold2
    before:
    image

after:
image

keep the pr draft until apache/incubator-hugegraph-toolchain#530 merged

@imbajin imbajin marked this pull request as draft November 6, 2023 15:06
#### 2.1 下载已编译的压缩包
#### 2.1 使用 Docker 镜像

我们可以使用 `docker run -itd --name loader hugegraph/loader`部署 loader 服务。对于需要加载的数据,则可以通过挂载 `-v /path/to/data/file:/loader/file` 或者`docker cp`的方式将文件复制到 loader 容器内部。
Copy link
Member

@imbajin imbajin Nov 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

结尾可以 link 一下后面 4.6 的详细步骤, 用户可以点击跳转, 不然间隔有点远

另外可以缩小/折叠一下 loader 里的 oracle 的图片, 以及文档里可以折叠的部分, 目前文档太长, 后续加个 TODO 需要拆分

Copy link
Contributor Author

@aroundabout aroundabout Nov 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

确实有一些映射文件确实太长了 我之后<details>折叠一下, oracle的图片应该可以直接改size

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

确实有一些映射文件确实太长了 我之后<details>折叠一下, oracle的图片应该可以直接改size

其实我觉得 Oracle 图片可以去掉, 改为 link 就行(哪怕是需要图, 也可以改为图link) 不用直接显示, 用的人也很少了, 另外它的篇幅也应该尽量减少折叠. (不常用的都可以)

Copy link
Contributor Author

@aroundabout aroundabout Nov 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个图直接不要了吧 我刚刚看了下整个ui全变了, link 也有点老了

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个图直接不要了吧 我刚刚看了下整个ui全变了, link 也有点老了

OK, 总之应减少包括 oracle 在内不常见配置的篇幅/或折叠起来默认

@@ -970,6 +1001,54 @@ count metrics
edge insert failure : 0
```

#### 4.6 使用 docker 导入

首先使用 `docker exec -it loader bash` 进入容器内部
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里能否使用docker exec -it xxx或类似方式直接执行命令, 而不用进入容器再执行呢?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

应该是可以的,我文档上面补一下

@aroundabout aroundabout marked this pull request as ready for review November 16, 2023 09:01
@aroundabout aroundabout requested a review from imbajin November 16, 2023 09:01
Copy link
Member

@imbajin imbajin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

另外可以贴个当前改后的效果图 Diff 对比看看 (主要是看 loader 的) @liuxiaocs7 也可看看 loader 这块 doc 的优化/精简建议~

hugegraph-data:
```

在这个 yaml 中,需要在环境变量中以 `hugegraph.`的形式进行参数传递,配置 Cassandra 相关的参数,其他配置可以参照 [4 配置](#4-配置)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hugegraph. 的形式似乎不太直观?

首先我们可以根据 [4.1-4.3](#41-准备数据) 的步骤准备数据,将准备好的数据通过 `docker cp` 复制到 loader 容器内部:

```bash
docker cp /path/to/local/directory <container_name/id>:/path/to/container/directory
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里可以在下面附带给个具体的例子, 更友好

# 例如
docker cp xx

@aroundabout aroundabout requested a review from imbajin November 16, 2023 11:07
@imbajin
Copy link
Member

imbajin commented Nov 20, 2023

OK, fine to sync the EN version 🔢

Copy link
Member

@imbajin imbajin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@imbajin imbajin changed the title doc: support cassandra for docker image of server and doc for docker … doc: add cassandra docker usage of server & enhance loader desc Nov 20, 2023
@imbajin imbajin merged commit e853a54 into apache:master Nov 20, 2023
1 check passed
github-actions bot pushed a commit to JackyYangPassion/incubator-hugegraph-doc that referenced this pull request Nov 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants