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

chore: update version to 1.5.0 #385

Merged
merged 3 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/cn/docs/changelog/hugegraph-1.3.0-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ weight: 4
1. 优先在 `hugegraph/toolchain/commons`软件中使用 Java 11, 此次是这些模块最后一次主版本兼容 Java 8 了。(computer 则仅支持 Java11)
2. 另外相比 Java11, 使用 Java8 会失去一些**安全性**的保障,我们推荐生产或对外网暴露访问的环境使用 Java11 并开启 [Auth 权限认证](/cn/docs/config/config-authentication/)

**1.3.0** 是最后兼容 **Java 8** 的版本,在下一个 1.5.0 版本发布 -- [PD/Store](https://github.com/apache/incubator-hugegraph/issues/2265) 合入主分支时就会全面使用 Java 11 (除`client`外).
**1.3.0** 是最后兼容 **Java 8** 的版本, 1.5.0 开始就会全面使用 Java 11 (除`client`外).

PS: 未来 HugeGraph 组件的版本会朝着 `Java 11 -> Java 17 -> Java 21` 演进

Expand Down
2 changes: 1 addition & 1 deletion content/cn/docs/changelog/hugegraph-1.5.0-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ Please check the release details/contributor in each repository:

### 运行环境/版本说明

1. 相较于 **1.3.0**,**1.5.0** `hugegraph` 仅支持 Java 11
1. 相较于 **1.3.0**,**1.5.0** 及后的 `hugegraph` 仅支持 Java 11

PS: 未来 HugeGraph 组件的版本会朝着 `Java 11 -> Java 17 -> Java 21` 演进
4 changes: 2 additions & 2 deletions content/cn/docs/config/config-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ bin/start-hugegraph.sh
在 `docker run` 中添加环境变量 `PASSWORD=123456`(密码可以自由设置)即可开启鉴权模式::

```bash
docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080 hugegraph/hugegraph:1.3.0
docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0
```

#### 2. 采用 docker-compose
Expand All @@ -134,7 +134,7 @@ docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080 hugegraph/hugegrap
version: '3'
services:
server:
image: hugegraph/hugegraph:1.3.0
image: hugegraph/hugegraph:1.5.0
container_name: server
ports:
- 8080:8080
Expand Down
2 changes: 1 addition & 1 deletion content/cn/docs/quickstart/hugegraph-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ weight: 4
<groupId>org.apache.hugegraph</groupId>
<artifactId>hugegraph-client</artifactId>
<!-- Update to the latest release version -->
<version>1.3.0</version>
<version>1.5.0</version>
</dependency>
</dependencies>
```
Expand Down
8 changes: 4 additions & 4 deletions content/cn/docs/quickstart/hugegraph-hubble.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ weight: 3
>
> 若 hubble 和 server 在同一 docker 网络下,**推荐**直接使用`container_name` (如下例的 `server`) 作为主机名。或者也可以使用 **宿主机 IP** 作为主机名,此时端口号为宿主机给 server 配置的端口

我们可以使用 `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble:1.2.0` 快速启动 [hubble](https://hub.docker.com/r/hugegraph/hubble).
我们可以使用 `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble:1.5.0` 快速启动 [hubble](https://hub.docker.com/r/hugegraph/hubble).

或者使用 docker-compose 启动 hubble,另外如果 hubble 和 server 在同一个 docker 网络下,可以使用 server 的 contain_name 进行访问,而不需要宿主机的 ip

Expand All @@ -63,13 +63,13 @@ weight: 3
version: '3'
services:
server:
image: hugegraph/hugegraph:1.3.0
image: hugegraph/hugegraph:1.5.0
container_name: server
ports:
- 8080:8080

hubble:
image: hugegraph/hubble:1.2.0
image: hugegraph/hubble:1.5.0
container_name: hubble
ports:
- 8088:8088
Expand All @@ -79,7 +79,7 @@ services:
>
> 1. `hugegraph-hubble` 的 docker 镜像是一个便捷发布版本,用于快速测试试用 hubble,并非**ASF 官方发布物料包的方式**。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
>
> 2. **生产环境**推荐使用 `release tag`(如 `1.2.0`) 稳定版。使用 `latest` tag 默认对应 master 最新代码。
> 2. **生产环境**推荐使用 `release tag`(如 `1.5.0`) 稳定版。使用 `latest` tag 默认对应 master 最新代码。

#### 2.2 下载 toolchain 二进制包

Expand Down
10 changes: 5 additions & 5 deletions content/cn/docs/quickstart/hugegraph-loader.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ HugeGraph-Loader 是 HugeGraph 的数据导入组件,能够将多种数据源

#### 2.1 使用 Docker 镜像 (便于**测试**)

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

或者使用 docker-compose 启动 loader, 启动命令为 `docker-compose up -d`, 样例的 docker-compose.yml 如下所示:

Expand All @@ -40,19 +40,19 @@ version: '3'

services:
server:
image: hugegraph/hugegraph:1.3.0
image: hugegraph/hugegraph:1.5.0
container_name: server
ports:
- 8080:8080

hubble:
image: hugegraph/hubble:1.2.0
image: hugegraph/hubble:1.5.0
container_name: hubble
ports:
- 8088:8088

loader:
image: hugegraph/loader:1.3.0
image: hugegraph/loader:1.5.0
container_name: loader
# mount your own data here
# volumes:
Expand All @@ -66,7 +66,7 @@ services:
>
> 1. hugegraph-loader 的 docker 镜像是一个便捷版本,用于快速启动 loader,并不是**官方发布物料包方式**。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
>
> 2. 推荐使用 `release tag`(如 `1.2.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
> 2. 推荐使用 `release tag` (如 `1.5.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。

#### 2.2 下载已编译的压缩包

Expand Down
20 changes: 10 additions & 10 deletions content/cn/docs/quickstart/hugegraph-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ Core 模块是 Tinkerpop 接口的实现,Backend 模块用于管理数据存

可参考 [Docker 部署方式](https://github.com/apache/incubator-hugegraph/blob/master/hugegraph-server/hugegraph-dist/docker/README.md)。

我们可以使用 `docker run -itd --name=server -p 8080:8080 hugegraph/hugegraph:1.3.0` 去快速启动一个内置了 `RocksDB` 的 `Hugegraph server`.
我们可以使用 `docker run -itd --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0` 去快速启动一个内置了 `RocksDB` 的 `Hugegraph server`.

可选项:

1. 可以使用 `docker exec -it server bash` 进入容器完成一些操作
2. 可以使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.3.0` 在启动的时候预加载一个**内置的**样例图。可以通过 `RESTful API` 进行验证。具体步骤可以参考 [5.1.1](/cn/docs/quickstart/hugegraph-server/#511-%E5%90%AF%E5%8A%A8-server-%E7%9A%84%E6%97%B6%E5%80%99%E5%88%9B%E5%BB%BA%E7%A4%BA%E4%BE%8B%E5%9B%BE)
2. 可以使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph:1.5.0` 在启动的时候预加载一个**内置的**样例图。可以通过 `RESTful API` 进行验证。具体步骤可以参考 [5.1.1](/cn/docs/quickstart/hugegraph-server/#511-%E5%90%AF%E5%8A%A8-server-%E7%9A%84%E6%97%B6%E5%80%99%E5%88%9B%E5%BB%BA%E7%A4%BA%E4%BE%8B%E5%9B%BE)
3. 可以使用 `-e PASSWORD=123456` 设置是否开启鉴权模式以及 admin 的密码,具体步骤可以参考 [Config Authentication](/cn/docs/config/config-authentication#使用-docker-时开启鉴权模式)

如果使用 docker desktop,则可以按照如下的方式设置可选项:
Expand All @@ -59,7 +59,7 @@ Core 模块是 Tinkerpop 接口的实现,Backend 模块用于管理数据存
version: '3'
services:
server:
image: hugegraph/hugegraph:1.3.0
image: hugegraph/hugegraph:1.5.0
container_name: server
# environment:
# - PRELOAD=true 为可选参数,为 True 时可以在启动的时候预加载一个内置的样例图
Expand All @@ -72,12 +72,12 @@ services:
>
> 1. hugegraph 的 docker 镜像是一个便捷版本,用于快速启动 hugegraph,并不是**官方发布物料包方式**。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
>
> 2. 推荐使用 `release tag` (如 `1.3.0/1.5.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
> 2. 推荐使用 `release tag` (如 `1.5.0/1.x.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。

#### 3.2 下载 tar 包

```bash
# use the latest version, here is 1.3.0 for example
# use the latest version, here is 1.5.0 for example
wget https://downloads.apache.org/incubator/hugegraph/{version}/apache-hugegraph-incubating-{version}.tar.gz
tar zxf *hugegraph*.tar.gz
```
Expand All @@ -104,7 +104,7 @@ mvn package -DskipTests

```bash
......
[INFO] Reactor Summary for hugegraph 1.3.0:
[INFO] Reactor Summary for hugegraph 1.5.0:
[INFO]
[INFO] hugegraph .......................................... SUCCESS [ 2.405 s]
[INFO] hugegraph-core ..................................... SUCCESS [ 13.405 s]
Expand Down Expand Up @@ -132,8 +132,8 @@ mvn package -DskipTests
HugeGraph-Tools 提供了一键部署的命令行工具,用户可以使用该工具快速地一键下载、解压、配置并启动 HugeGraph-Server 和 HugeGraph-Hubble,最新的 HugeGraph-Toolchain 中已经包含所有的这些工具,直接下载它解压就有工具包集合了

```bash
# download toolchain package, it includes loader + tool + hubble, please check the latest version (here is 1.3.0)
wget https://downloads.apache.org/incubator/hugegraph/1.3.0/apache-hugegraph-toolchain-incubating-1.3.0.tar.gz
# download toolchain package, it includes loader + tool + hubble, please check the latest version (here is 1.5.0)
wget https://downloads.apache.org/incubator/hugegraph/1.5.0/apache-hugegraph-toolchain-incubating-1.5.0.tar.gz
tar zxf *hugegraph-*.tar.gz
# enter the tool's package
cd *hugegraph*/*tool*
Expand Down Expand Up @@ -516,7 +516,7 @@ volumes:

1. 使用`docker run`

使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD=true hugegraph/hugegraph:1.3.0`
使用 `docker run -itd --name=server -p 8080:8080 -e PRELOAD=true hugegraph/hugegraph:1.5.0`

2. 使用`docker-compose`

Expand All @@ -526,7 +526,7 @@ volumes:
version: '3'
services:
server:
image: hugegraph/hugegraph:1.3.0
image: hugegraph/hugegraph:1.5.0
container_name: server
environment:
- PRELOAD=true
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/config/config-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,9 @@ After the authentication configuration completed, enter the **admin password** o

If deployed based on Docker image or if HugeGraph has already been initialized and needs to be converted to authentication mode,
relevant graph data needs to be deleted and HugeGraph needs to be restarted. If there is already business data in the diagram,
it is temporarily **not possible** to directly convert the authentication mode (version<=1.2.0 )
it is temporarily **not possible** to directly convert the authentication mode (version<=1.2.0)

> Improvements for this feature have been included in the latest release (available in latest docker image), please refer to [PR 2411](https://github.com/apache/incubator-hugegraph/pull/2411). Seamless switching is now available.
> Improvements for this feature have been included in the latest release (available in the latest docker image), please refer to [PR 2411](https://github.com/apache/incubator-hugegraph/pull/2411). Seamless switching is now available.

```bash
# stop the hugeGraph firstly
Expand Down Expand Up @@ -130,7 +130,7 @@ The steps are as follows:
To enable authentication mode, add the environment variable `PASSWORD=123456` (you can freely set the password) in the `docker run` command:

```bash
docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080 hugegraph/hugegraph:1.3.0
docker run -itd -e PASSWORD=123456 --name=server -p 8080:8080 hugegraph/hugegraph:1.5.0
```

#### 2. Use docker-compose
Expand All @@ -141,7 +141,7 @@ Use `docker-compose` and set the environment variable `PASSWORD=123456`:
version: '3'
services:
server:
image: hugegraph/hugegraph:1.2.0
image: hugegraph/hugegraph:1.5.0
container_name: server
ports:
- 8080:8080
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/introduction/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The functions of this system include but are not limited to:
- Supports batch import of data from multiple data sources (including local files, HDFS files, MySQL databases, and other data sources), and supports import of multiple file formats (including TXT, CSV, JSON, and other formats)
- With a visual operation interface, it can be used for operation, analysis, and display diagrams, reducing the threshold for users to use
- Optimized graph interface: shortest path (Shortest Path), K-step connected subgraph (K-neighbor), K-step to reach the adjacent point (K-out), personalized recommendation algorithm PersonalRank, etc.
- Implemented based on Apache TinkerPop3 framework, supports Gremlin graph query language
- Implemented based on the Apache TinkerPop3 framework, supports Gremlin graph query language
- Support attribute graph, attributes can be added to vertices and edges, and support rich attribute types
- Has independent schema metadata information, has powerful graph modeling capabilities, and facilitates third-party system integration
- Support multi-vertex ID strategy: support primary key ID, support automatic ID generation, support user-defined string ID, support user-defined digital ID
Expand All @@ -44,8 +44,8 @@ The functions of this system include but are not limited to:

- [HugeGraph-Server](/docs/quickstart/hugegraph-server): HugeGraph-Server is the core part of the HugeGraph project, containing Core, Backend, API and other submodules;
- Core: Implements the graph engine, connects to the Backend module downwards, and supports the API module upwards;
- Backend: Implements the storage of graph data to the backend, supports backends including: Memory, Cassandra, ScyllaDB, RocksDB, HBase, MySQL and PostgreSQL, users can choose one according to the actual situation;
- API: Built-in REST Server, provides RESTful API to users, and is fully compatible with Gremlin queries. (Supports distributed storage and computation pushdown)
- Backend: Implements the storage of graph data to the backend, supports backends including Memory, Cassandra, ScyllaDB, RocksDB, HBase, MySQL and PostgreSQL, users can choose one according to the actual situation;
- API: Built-in REST Server provides RESTful API to users and is fully compatible with Gremlin queries. (Supports distributed storage and computation pushdown)
- [HugeGraph-Toolchain](https://github.com/apache/hugegraph-toolchain): (Toolchain)
- [HugeGraph-Client](/docs/quickstart/hugegraph-client): HugeGraph-Client provides a RESTful API client for connecting to HugeGraph-Server, currently only the Java version is implemented, users of other languages can implement it themselves;
- [HugeGraph-Loader](/docs/quickstart/hugegraph-loader): HugeGraph-Loader is a data import tool based on HugeGraph-Client, which transforms ordinary text data into vertices and edges of the graph and inserts them into the graph database;
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/quickstart/hugegraph-ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ with large models, integration with graph machine learning components, etc., to

7. After running the web demo, the config file `.env` will be automatically generated at the path `hugegraph-llm/.env`. Additionally, a prompt-related configuration file `config_prompt.yaml` will also be generated at the path `hugegraph-llm/src/hugegraph_llm/resources/demo/config_prompt.yaml`.

You can modify the content on the web page, and it will be automatically saved to the configuration file after the corresponding feature is triggered. You can also modify the file directly without restarting the web application; simply refresh the page to load your latest changes.
You can modify the content on the web page, and it will be automatically saved to the configuration file after the corresponding feature is triggered. You can also modify the file directly without restarting the web application; refresh the page to load your latest changes.

(Optional)To regenerate the config file, you can use `config.generate` with `-u` or `--update`.
```bash
Expand All @@ -77,13 +77,13 @@ with large models, integration with graph machine learning components, etc., to
- Docs:
- text: Build rag index from plain text
- file: Upload file(s) which should be <u>TXT</u> or <u>.docx</u> (Multiple files can be selected together)
- [Schema](https://hugegraph.apache.org/docs/clients/restful-api/schema/): (Accept **2 types**)
- [Schema](https://hugegraph.apache.org/docs/clients/restful-api/schema/): (Except **2 types**)
- User-defined Schema (JSON format, follow the [template](https://github.com/apache/incubator-hugegraph-ai/blob/aff3bbe25fa91c3414947a196131be812c20ef11/hugegraph-llm/src/hugegraph_llm/config/config_data.py#L125)
to modify it)
- Specify the name of the HugeGraph graph instance, it will automatically get the schema from it (like
**"hugegraph"**)
- Graph extract head: The user-defined prompt of graph extracting
- If already exist the graph data, you should click "**Rebuild vid Index**" to update the index
- If it already exists the graph data, you should click "**Rebuild vid Index**" to update the index

![gradio-config](/docs/images/gradio-kg.png)

Expand Down
10 changes: 5 additions & 5 deletions content/en/docs/quickstart/hugegraph-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ weight: 4

### 1 Overview Of Hugegraph

[HugeGraph-Client](https://github.com/apache/hugegraph-toolchain) sends HTTP request to HugeGraph-Server to obtain and parse the execution result of Server.
[HugeGraph-Client](https://github.com/apache/hugegraph-toolchain) sends HTTP request to HugeGraph-Server to get and parse the execution result of Server.
We support HugeGraph-Client for Java/Go/[Python](https://github.com/apache/incubator-hugegraph-ai/tree/main/hugegraph-python-client) language.
You can use [Client-API](/cn/docs/clients/hugegraph-client) to write code to operate HugeGraph, such as adding, deleting, modifying, and querying schema and graph data, or executing gremlin statements.

> [HugeGraph client SDK tool based on Go language](https://github.com/apache/incubator-hugegraph-toolchain/blob/master/hugegraph-client-go/README.en.md) (version >=1.2.0)

### 2 What You Need

- Java 11 (also support Java 8)
- Java 11 (also supports Java 8)
- Maven 3.5+

### 3 How To Use

The basic steps to use HugeGraph-Client are as follows:

- Build a new Maven project by IDEA or Eclipse
- Add HugeGraph-Client dependency in pom file;
- Add HugeGraph-Client dependency in a pom file;
- Create an object to invoke the interface of HugeGraph-Client

See the complete example in the following section for the detail.
Expand All @@ -34,7 +34,7 @@ See the complete example in the following section for the detail.
Using IDEA or Eclipse to create the project:

- [Build by Eclipse](http://www.vogella.com/tutorials/EclipseMaven/article.html)
- [Build by Intellij Idea](https://vaadin.com/docs/-/part/framework/getting-started/getting-started-idea.html)
- [Build by IntelliJ IDEA](https://vaadin.com/docs/-/part/framework/getting-started/getting-started-idea.html)

#### 4.2 Add Hugegraph-Client Dependency In POM

Expand All @@ -44,7 +44,7 @@ Using IDEA or Eclipse to create the project:
<groupId>org.apache.hugegraph</groupId>
<artifactId>hugegraph-client</artifactId>
<!-- Update to the latest release version -->
<version>1.3.0</version>
<version>1.5.0</version>
</dependency>
</dependencies>
```
Expand Down
Loading
Loading