Skip to content

Commit

Permalink
docs: update 0.7.3 docs (#3156)
Browse files Browse the repository at this point in the history
  • Loading branch information
dl239 authored Mar 22, 2023
1 parent 7d429c6 commit 736ecb2
Show file tree
Hide file tree
Showing 32 changed files with 130 additions and 110 deletions.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# Changelog

## [0.7.3] - 2023-03-22

### Features
- Support C/C++ based User-Defined Aggregated Functions (UDAFs) (#2825 @dl239)
- Improve the diagnostic tool to support a few new sub-commands (#3106 @vagetablechicken)
- Add a new script to modify the node environment configuration (#3142 @dl239)
- Change the default value of `max_traverse_cnt` to unlimited to avoid result truncated when performing queries in CLI (#2999 @dl239)
- Improve the documents (#3111 #3093 #3119 @selenachenjingxin, #3105 #3125 #3120 @vagetablechicken, #3114 #3126 @dl239, #3128 @lumianph)

### Bug Fixes
- The user-provided `SPARK_HOME` does not work in the deployment scripts. (#3085 @zhanghaohit)
- The result of `SELECT timestamp(string_val)` is incorrect at the offline mode. (#3088 @tobegit3hub)

### Code Refactoring
#3122 @haseeb-xd

Note:
If the configuration of a tablet has not been updated when upgrading to this new version, the query result still may be truncated as the old version (#2999).

## [0.7.2] - 2023-02-17

### Features
Expand Down Expand Up @@ -527,6 +546,7 @@ Removed
- openmldb-0.2.0-linux.tar.gz targets on x86_64
- aarch64 artifacts consider experimental

[0.7.3]: https://github.com/4paradigm/OpenMLDB/compare/v0.7.2...v0.7.3
[0.7.2]: https://github.com/4paradigm/OpenMLDB/compare/v0.7.1...v0.7.2
[0.7.1]: https://github.com/4paradigm/OpenMLDB/compare/v0.7.0...v0.7.1
[0.7.0]: https://github.com/4paradigm/OpenMLDB/compare/v0.6.9...v0.7.0
Expand Down
2 changes: 1 addition & 1 deletion demo/java_quickstart/demo/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-jdbc</artifactId>
<version>0.7.2</version>
<version>0.7.3</version>
</dependency>
<dependency>
<groupId>org.testng</groupId>
Expand Down
2 changes: 1 addition & 1 deletion demo/jd-recommendation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ For full instructions, please refer to [website page](http://openmldb.ai/docs/zh
## OpenMLDB Feature Extraction

```
docker run -dit --name=openmldb --network=host -v $demodir:/work/oneflow_demo 4pdosc/openmldb:0.7.2 bash
docker run -dit --name=openmldb --network=host -v $demodir:/work/oneflow_demo 4pdosc/openmldb:0.7.3 bash
docker exec -it openmldb bash
```

Expand Down
4 changes: 2 additions & 2 deletions demo/predict-taxi-trip-duration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ w2 as (PARTITION BY passenger_count ORDER BY pickup_datetime ROWS_RANGE BETWEEN
**Start docker**
```
docker run -it 4pdosc/openmldb:0.7.2 bash
docker run -it 4pdosc/openmldb:0.7.3 bash
```
**Initialize environment**
```bash
Expand Down Expand Up @@ -138,7 +138,7 @@ python3 predict.py
**Start docker**
```bash
docker run -it 4pdosc/openmldb:0.7.2 bash
docker run -it 4pdosc/openmldb:0.7.3 bash
```
**Initialize environment**
Expand Down
2 changes: 1 addition & 1 deletion demo/talkingdata-adtracking-fraud-detection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ We recommend you to use docker to run the demo. OpenMLDB and dependencies have b
**Start docker**

```
docker run -it 4pdosc/openmldb:0.7.2 bash
docker run -it 4pdosc/openmldb:0.7.3 bash
```

#### Run locally
Expand Down
8 changes: 4 additions & 4 deletions docs/en/deploy/compile.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
This section describes the steps to compile and use OpenMLDB inside its official docker image [hybridsql](https://hub.docker.com/r/4pdosc/hybridsql).
The docker image has packed required tools and dependencies, so there is no need to set them up separately. To compile without the official docker image, refer to the section [Detailed Instructions for Build](#detailed-instructions-for-build) below.

Keep in mind that you should always use the same version of both compile image and [OpenMLDB version](https://github.com/4paradigm/OpenMLDB/releases). This section demonstrates compiling for [OpenMLDB v0.7.2](https://github.com/4paradigm/OpenMLDB/releases/tag/v0.7.2) under `hybridsql:0.7.2` ,If you prefer to compile on the latest code in `main` branch, pull `hybridsql:latest` image instead.
Keep in mind that you should always use the same version of both compile image and [OpenMLDB version](https://github.com/4paradigm/OpenMLDB/releases). This section demonstrates compiling for [OpenMLDB v0.7.3](https://github.com/4paradigm/OpenMLDB/releases/tag/v0.7.3) under `hybridsql:0.7.3` ,If you prefer to compile on the latest code in `main` branch, pull `hybridsql:latest` image instead.

1. Pull the docker image

Expand All @@ -21,11 +21,11 @@ Keep in mind that you should always use the same version of both compile image a
docker run -it 4pdosc/hybridsql:0.7 bash
```

3. Download the OpenMLDB source code inside the docker container, and setting the branch into v0.7.2
3. Download the OpenMLDB source code inside the docker container, and setting the branch into v0.7.3

```bash
cd ~
git clone -b v0.7.2 https://github.com/4paradigm/OpenMLDB.git
git clone -b v0.7.3 https://github.com/4paradigm/OpenMLDB.git
```

4. Compile OpenMLDB
Expand Down Expand Up @@ -151,7 +151,7 @@ The built jar packages are in the `target` path of each submodule. If you want t
1. Downloading the pre-built OpenMLDB Spark distribution:

```bash
wget https://github.com/4paradigm/spark/releases/download/v3.2.1-openmldb0.7.2/spark-3.2.1-bin-openmldbspark.tgz
wget https://github.com/4paradigm/spark/releases/download/v3.2.1-openmldb0.7.3/spark-3.2.1-bin-openmldbspark.tgz
```

Alternatively, you can also download the source code and compile from scratch:
Expand Down
50 changes: 25 additions & 25 deletions docs/en/deploy/install_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* The number of cores is recommended to be no less than 4 cores. If the CPU does not support the AVX2 instruction set in the Linux environment, the deployment package needs to be recompiled from the source code.

## Deployment Package
The precompiled OpenMLDB deployment package is used by default in this documentation ([Linux](https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.2/openmldb-0.7.2-linux.tar.gz) , [macOS](https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.2/openmldb-0.7.2-darwin.tar.gz)), the supported operating system requirements are: CentOS 7, Ubuntu 20.04, macOS >= 10.15. If the user wishes to compile by himself (for example, for OpenMLDB source code development, the operating system or CPU architecture is not in the support list of the precompiled deployment package, etc.), the user can choose to compile and use in the docker container or compile from the source code. For details, please refer to our [compile documentation](compile.md).
The precompiled OpenMLDB deployment package is used by default in this documentation ([Linux](https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.3/openmldb-0.7.3-linux.tar.gz) , [macOS](https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.3/openmldb-0.7.3-darwin.tar.gz)), the supported operating system requirements are: CentOS 7, Ubuntu 20.04, macOS >= 10.15. If the user wishes to compile by himself (for example, for OpenMLDB source code development, the operating system or CPU architecture is not in the support list of the precompiled deployment package, etc.), the user can choose to compile and use in the docker container or compile from the source code. For details, please refer to our [compile documentation](compile.md).

## Configure Environment (Linux)

Expand Down Expand Up @@ -91,9 +91,9 @@ OpenMLDB standalone version needs to deploy a nameserver and a tablet. The names
### Download the OpenMLDB Release Package

```
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.2/openmldb-0.7.2-linux.tar.gz
tar -zxvf openmldb-0.7.2-linux.tar.gz
cd openmldb-0.7.2-linux
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.3/openmldb-0.7.3-linux.tar.gz
tar -zxvf openmldb-0.7.3-linux.tar.gz
cd openmldb-0.7.3-linux
```

### Configuration
Expand Down Expand Up @@ -163,9 +163,9 @@ Environment Requirements:
### Download the OpenMLDB Deployment Package

```
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.2/openmldb-0.7.2-linux.tar.gz
tar -zxvf openmldb-0.7.2-linux.tar.gz
cd openmldb-0.7.2-linux
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.3/openmldb-0.7.3-linux.tar.gz
tar -zxvf openmldb-0.7.3-linux.tar.gz
cd openmldb-0.7.3-linux
```

### Configuration
Expand All @@ -175,7 +175,7 @@ which are listed below.

| Environment Variables | Default Values | Definitons |
|-----------------------------------|---------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
| OPENMLDB_VERSION | 0.7.2 | OpenMLDB version |
| OPENMLDB_VERSION | 0.7.3 | OpenMLDB version |
| OPENMLDB_MODE | standalone | standalone or cluster mode |
| OPENMLDB_HOME | root directory of the release folder | openmldb root path |
| SPARK_HOME | $OPENMLDB_HOME/spark | the root path of openmldb spark release. if not exists, download from online |
Expand Down Expand Up @@ -311,10 +311,10 @@ Deploy the Zookeeper cluster [refer to here](https://zookeeper.apache.org/doc/r3
#### 1. Download the OpenMLDB Deployment Package

```
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.2/openmldb-0.7.2-linux.tar.gz
tar -zxvf openmldb-0.7.2-linux.tar.gz
mv openmldb-0.7.2-linux openmldb-tablet-0.7.2
cd openmldb-tablet-0.7.2
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.3/openmldb-0.7.3-linux.tar.gz
tar -zxvf openmldb-0.7.3-linux.tar.gz
mv openmldb-0.7.3-linux openmldb-tablet-0.7.3
cd openmldb-tablet-0.7.3
```

#### 2. Modify the Configuration File: conf/tablet.flags
Expand Down Expand Up @@ -361,10 +361,10 @@ Repeat the above steps to deploy multiple tablets.
#### 1. Download the OpenMLDB Deployment Package

```
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.2/openmldb-0.7.2-linux.tar.gz
tar -zxvf openmldb-0.7.2-linux.tar.gz
mv openmldb-0.7.2-linux openmldb-ns-0.7.2
cd openmldb-ns-0.7.2
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.3/openmldb-0.7.3-linux.tar.gz
tar -zxvf openmldb-0.7.3-linux.tar.gz
mv openmldb-0.7.3-linux openmldb-ns-0.7.3
cd openmldb-ns-0.7.3
```

#### 2. Modify the Configuration File: conf/nameserver.flags
Expand Down Expand Up @@ -411,10 +411,10 @@ Before running, make sure that the OpenMLDB cluster has been started, otherwise
#### 1. Download the OpenMLDB Deployment Package

```
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.2/openmldb-0.7.2-linux.tar.gz
tar -zxvf openmldb-0.7.2-linux.tar.gz
mv openmldb-0.7.2-linux openmldb-apiserver-0.7.2
cd openmldb-apiserver-0.7.2
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.3/openmldb-0.7.3-linux.tar.gz
tar -zxvf openmldb-0.7.3-linux.tar.gz
mv openmldb-0.7.3-linux openmldb-apiserver-0.7.3
cd openmldb-apiserver-0.7.3
```

#### 2. Modify the Configuration File: conf/apiserver.flags
Expand Down Expand Up @@ -454,12 +454,12 @@ TaskManager can be deployed in single server. You can deploy multiple instances
#### 1. Download the OpenMLDB Spark Distribution that is Optimized for Feature Engineering

```
wget https://github.com/4paradigm/spark/releases/download/v3.2.1-openmldb0.7.2/spark-3.2.1-bin-openmldbspark.tgz
wget https://github.com/4paradigm/spark/releases/download/v3.2.1-openmldb0.7.3/spark-3.2.1-bin-openmldbspark.tgz
tar -zxvf spark-3.2.1-bin-openmldbspark.tgz
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.2/openmldb-0.7.2-linux.tar.gz
tar -zxvf openmldb-0.7.2-linux.tar.gz
mv openmldb-0.7.2-linux openmldb-taskmanager-0.7.2
cd openmldb-taskmanager-0.7.2
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.7.3/openmldb-0.7.3-linux.tar.gz
tar -zxvf openmldb-0.7.3-linux.tar.gz
mv openmldb-0.7.3-linux openmldb-taskmanager-0.7.3
cd openmldb-taskmanager-0.7.3
```

#### 2. Modify the Configuration File conf/taskmanager.properties
Expand Down
10 changes: 5 additions & 5 deletions docs/en/quickstart/java_sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Configure maven pom
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-jdbc</artifactId>
<version>0.7.2</version>
<version>0.7.3</version>
</dependency>
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-native</artifactId>
<version>0.7.2</version>
<version>0.7.3</version>
</dependency>
```
### Package Installation on Mac
Expand All @@ -24,15 +24,15 @@ Configure maven pom
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-jdbc</artifactId>
<version>0.7.2</version>
<version>0.7.3</version>
</dependency>
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-native</artifactId>
<version>0.7.2-macos</version>
<version>0.7.3-macos</version>
</dependency>
```
Note that since `openmldb-native` contains the C++ static library compiled by OpenMLDB, by default it is a Linux's static library. On macOS, the version of the above openmldb-native needs to be changed to `0.7.2-macos`, and the version of openmldb-jdbc remains unchanged.
Note that since `openmldb-native` contains the C++ static library compiled by OpenMLDB, by default it is a Linux's static library. On macOS, the version of the above openmldb-native needs to be changed to `0.7.3-macos`, and the version of openmldb-jdbc remains unchanged.

The macOS native relase only supports macos-12. If you want use in macos-11 or macos 10.15, you should build openmldb-native from source in macos-11/macos-10.15, see [Build Java SDK](../deploy/compile.md#build-java-sdk-with-multi-processes) for details.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/quickstart/openmldb_quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you wan to compile and install it by yourself, you can refer to our [installa
Pull the image (image download size is about 1GB, after decompression is about 1.7 GB) and start the docker container:

```bash
docker run -it 4pdosc/openmldb:0.7.2 bash
docker run -it 4pdosc/openmldb:0.7.3 bash
```

```{important}
Expand Down
6 changes: 3 additions & 3 deletions docs/en/reference/ip_tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ Expose the port through `-p` when starting the container, and the client can acc

The stand-alone version needs to expose the ports of three components (nameserver, tabletserver, apiserver):
```
docker run -p 6527:6527 -p 9921:9921 -p 8080:8080 -it 4pdosc/openmldb:0.7.2 bash
docker run -p 6527:6527 -p 9921:9921 -p 8080:8080 -it 4pdosc/openmldb:0.7.3 bash
```

The cluster version needs to expose the zk port and the ports of all components:
```
docker run -p 2181:2181 -p 7527:7527 -p 10921:10921 -p 10922:10922 -p 8080:8080 -p 9902:9902 -it 4pdosc/openmldb:0.7.2 bash
docker run -p 2181:2181 -p 7527:7527 -p 10921:10921 -p 10922:10922 -p 8080:8080 -p 9902:9902 -it 4pdosc/openmldb:0.7.3 bash
```

```{tip}
Expand All @@ -57,7 +57,7 @@ If the OpenMLDB service process is distributed, the "port number is occupied" ap
#### Host Network
Or more conveniently, use host networking without port isolation, for example:
```
docker run --network host -it 4pdosc/openmldb:0.7.2 bash
docker run --network host -it 4pdosc/openmldb:0.7.3 bash
```
But in this case, it is easy to find that the port is occupied by other processes in the host. If occupancy occurs, change the port number carefully.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/use_case/JD_recommendation_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Oneflow-serving:https://github.com/Oneflow-Inc/serving/tree/ce5d667468b6b3ba66
Pull the OpenMLDB docker image and run.

```bash
docker run -dit --name=openmldb --network=host -v $demodir:/work/oneflow_demo 4pdosc/openmldb:0.7.2 bash
docker run -dit --name=openmldb --network=host -v $demodir:/work/oneflow_demo 4pdosc/openmldb:0.7.3 bash
docker exec -it openmldb bash
```

Expand Down
2 changes: 1 addition & 1 deletion docs/en/use_case/airflow_provider_demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ For the newest version, please visit [GitHub example_dags](https://github.com/4p
- Please project the previously downloaded files to the path `/work/airflow/dags`, where Airflow will access for the DAG.

```
docker run -p 8080:8080 -v `pwd`/airflow_demo_files:/work/airflow/dags -it 4pdosc/openmldb:0.7.2 bash
docker run -p 8080:8080 -v `pwd`/airflow_demo_files:/work/airflow/dags -it 4pdosc/openmldb:0.7.3 bash
```

#### 0.3 Download and Install the Airflow and the Airflow OpenMLDB Provider
Expand Down
2 changes: 1 addition & 1 deletion docs/en/use_case/dolphinscheduler_task_demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ In addition to the feature engineering done by OpenMLDB, the prediction also req

The demo can run on MacOS or Linux, the OpenMLDB docker image is recommended. We'll start OpenMLDB and DolphinScheduler in the same container, expose the DolphinScheduler web port:
```
docker run -it -p 12345:12345 4pdosc/openmldb:0.7.2 bash
docker run -it -p 12345:12345 4pdosc/openmldb:0.7.3 bash
```

```{attention}
Expand Down
2 changes: 1 addition & 1 deletion docs/en/use_case/kafka_connector_demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ For OpenMLDB Kafka Connector implementation, please refer to [extensions/kafka-c
This article will start the OpenMLDB in docker container, so there is no need to download the OpenMLDB separately. Moreover, Kafka and connector can be started in the same container. We recommend that you save the three downloaded packages to the same directory. Let's assume that the packages are in the `/work/kafka` directory.

```
docker run -it -v `pwd`:/work/kafka --name openmldb 4pdosc/openmldb:0.7.2 bash
docker run -it -v `pwd`:/work/kafka --name openmldb 4pdosc/openmldb:0.7.3 bash
```

### Steps
Expand Down
2 changes: 1 addition & 1 deletion docs/en/use_case/lightgbm_demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Note that: (1) this case is based on the OpenMLDB cluster version for tutorial d
- Pull the OpenMLDB docker image and run the corresponding container:

```bash
docker run -it 4pdosc/openmldb:0.7.2 bash
docker run -it 4pdosc/openmldb:0.7.3 bash
```

The image is preinstalled with OpenMLDB and preset with all scripts, third-party libraries, open-source tools and training data required for this case.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/use_case/pulsar_connector_demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Only OpenMLDB cluster mode can be the sink dist, and only write to online storag

We recommend that you use ‘host network’ to run docker. And bind volume ‘files’ too. The sql scripts are in it.
```
docker run -dit --network host -v `pwd`/files:/work/pulsar_files --name openmldb 4pdosc/openmldb:0.7.2 bash
docker run -dit --network host -v `pwd`/files:/work/pulsar_files --name openmldb 4pdosc/openmldb:0.7.3 bash
docker exec -it openmldb bash
```
```{note}
Expand Down
2 changes: 1 addition & 1 deletion docs/en/use_case/talkingdata_demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It is recommended to run this demo in Docker. Please make sure that OpenMLDB and
**Start the OpenMLDB Docker Image**

```
docker run -it 4pdosc/openmldb:0.7.2 bash
docker run -it 4pdosc/openmldb:0.7.3 bash
```

#### 1.1.2 Run Locally
Expand Down
Loading

0 comments on commit 736ecb2

Please sign in to comment.