Skip to content

Commit

Permalink
Update docs version to 0.9.1 (#3960)
Browse files Browse the repository at this point in the history
  • Loading branch information
tobegit3hub authored Jul 25, 2024
1 parent 2b7d970 commit b7f0489
Show file tree
Hide file tree
Showing 34 changed files with 125 additions and 125 deletions.
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.9.0</version>
<version>0.9.1</version>
</dependency>
<dependency>
<groupId>org.testng</groupId>
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.9.0 bash
docker run -it 4pdosc/openmldb:0.9.1 bash
```
**Initialize environment**
```bash
Expand Down Expand Up @@ -138,7 +138,7 @@ python3 predict.py
**Start docker**
```bash
docker run -it 4pdosc/openmldb:0.9.0 bash
docker run -it 4pdosc/openmldb:0.9.1 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.9.0 bash
docker run -it 4pdosc/openmldb:0.9.1 bash
```

#### Run locally
Expand Down
2 changes: 1 addition & 1 deletion docs/en/blog_post/20240402_OpenmldbVsRedis.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ We plan to test with 1 million (referred to as 1M) keys, each corresponding to 1
Deployment can be done through containerization or directly on physical machines using software packages. There is no significant difference between the two methods. Below is an example of using containerization for deployment:

- OpenMLDB
- Docker image: `docker pull 4pdosc/openmldb:0.9.0`
- Docker image: `docker pull 4pdosc/openmldb:0.9.1`
- Documentation: [https://openmldb.ai/docs/zh/main/quickstart/openmldb_quickstart.html](https://openmldb.ai/docs/zh/main/quickstart/openmldb_quickstart.html)

- Redis:
Expand Down
10 changes: 5 additions & 5 deletions docs/en/deploy/compile.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
This section describes the steps to compile and use OpenMLDB inside its official docker image [hybridsql](https://hub.docker.com/r/4pdosc/hybridsql), mainly for quick start and development purposes in the docker container.
The docker image has packed the 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.9.0](https://github.com/4paradigm/OpenMLDB/releases/tag/v0.9.0) under `hybridsql:0.9.0` ,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.9.1](https://github.com/4paradigm/OpenMLDB/releases/tag/v0.9.1) under `hybridsql:0.9.1` ,If you prefer to compile on the latest code in `main` branch, pull `hybridsql:latest` image instead.

1. Pull the docker image

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

3. Download the OpenMLDB source code inside the docker container, and set the branch into v0.9.0
3. Download the OpenMLDB source code inside the docker container, and set the branch into v0.9.1

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

4. Compile OpenMLDB
Expand Down Expand Up @@ -150,7 +150,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.9.0/spark-3.2.1-bin-openmldbspark.tgz
wget https://github.com/4paradigm/spark/releases/download/v3.2.1-openmldb0.9.1/spark-3.2.1-bin-openmldbspark.tgz
```

Alternatively, you can also download the source code and compile from scratch:
Expand Down Expand Up @@ -209,7 +209,7 @@ After forking the OpenMLDB repository, you can trigger the `Other OS Build` work

- Do not change the `Use workflow from` setting to a specific tag; it can be another branch.
- Choose the desired `OS name`, which in this case is `centos6`.
- If you are not compiling the main branch, provide the name of the branch, tag (e.g., v0.9.0), or SHA you want to compile in the `The branch, tag, or SHA to checkout, otherwise use the branch` field.
- If you are not compiling the main branch, provide the name of the branch, tag (e.g., v0.9.1), or SHA you want to compile in the `The branch, tag, or SHA to checkout, otherwise use the branch` field.
- The compilation output will be accessible in "runs", as shown in an example [here](https://github.com/4paradigm/OpenMLDB/actions/runs/6044951902).
- The workflow will definitely produce the OpenMLDB binary file.
- If you don't need the Java or Python SDK, you can configure `java sdk enable` or `python sdk enable` to be "OFF" to save compilation time.
Expand Down
68 changes: 34 additions & 34 deletions docs/en/deploy/install_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,17 +56,17 @@ If your operating system is not mentioned above or if you want to compile from s

### Linux Platform Compatibility Pre-test

Due to the variations among Linux platforms, the distribution package may not be entirely compatible with your machine. Therefore, it's recommended to conduct a preliminary compatibility test. Download the pre-compiled package `openmldb-0.9.0-linux.tar.gz`, and execute:
Due to the variations among Linux platforms, the distribution package may not be entirely compatible with your machine. Therefore, it's recommended to conduct a preliminary compatibility test. Download the pre-compiled package `openmldb-0.9.1-linux.tar.gz`, and execute:

```
tar -zxvf openmldb-0.9.0-linux.tar.gz
./openmldb-0.9.0-linux/bin/openmldb --version
tar -zxvf openmldb-0.9.1-linux.tar.gz
./openmldb-0.9.1-linux/bin/openmldb --version
```

The result should display the version number of the program, as shown below:

```
openmldb version 0.9.0-xxxx
openmldb version 0.9.1-xxxx
Debug build (NDEBUG not #defined)
```

Expand Down Expand Up @@ -181,9 +181,9 @@ DataCollector and SyncTool currently do not support one-click deployment. Please
### Download OpenMLDB

```
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.9.0/openmldb-0.9.0-linux.tar.gz
tar -zxvf openmldb-0.9.0-linux.tar.gz
cd openmldb-0.9.0-linux
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.9.1/openmldb-0.9.1-linux.tar.gz
tar -zxvf openmldb-0.9.1-linux.tar.gz
cd openmldb-0.9.1-linux
```

### Environment Configuration
Expand All @@ -192,7 +192,7 @@ The environment variables are defined in `conf/openmldb-env.sh`, as shown in the

| Environment Variable | Default Value | Note |
| --------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------ |
| OPENMLDB_VERSION | 0.9.0 | OpenMLDB version |
| OPENMLDB_VERSION | 0.9.1 | OpenMLDB version |
| OPENMLDB_MODE | standalone | standalone or cluster |
| OPENMLDB_HOME | root directory of the release folder | openmldb root directory |
| SPARK_HOME | $OPENMLDB_HOME/spark | Spark root directory, if the directory does not exist, it will be downloaded automatically.|
Expand Down Expand Up @@ -365,10 +365,10 @@ Note that at least two TabletServers need to be deployed, otherwise errors may o
**1. Download the OpenMLDB deployment package**

```
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.9.0/openmldb-0.9.0-linux.tar.gz
tar -zxvf openmldb-0.9.0-linux.tar.gz
mv openmldb-0.9.0-linux openmldb-tablet-0.9.0
cd openmldb-tablet-0.9.0
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.9.1/openmldb-0.9.1-linux.tar.gz
tar -zxvf openmldb-0.9.1-linux.tar.gz
mv openmldb-0.9.1-linux openmldb-tablet-0.9.1
cd openmldb-tablet-0.9.1
```

**2. Modify the configuration file `conf/tablet.flags`**
Expand Down Expand Up @@ -431,12 +431,12 @@ For clustered versions, the number of TabletServers must be 2 or more. If there'

To start the next TabletServer on a different machine, simply repeat the aforementioned steps on that machine. If starting the next TabletServer on the same machine, ensure it's in a different directory, and do not reuse a directory where the TabletServer is already running.

For instance, you can decompress the package again (avoid using a directory where TabletServer is already running, as files generated after startup may be affected), and name the directory `openmldb-tablet-0.9.0-2`.
For instance, you can decompress the package again (avoid using a directory where TabletServer is already running, as files generated after startup may be affected), and name the directory `openmldb-tablet-0.9.1-2`.

```
tar -zxvf openmldb-0.9.0-linux.tar.gz
mv openmldb-0.9.0-linux openmldb-tablet-0.9.0-2
cd openmldb-tablet-0.9.0-2
tar -zxvf openmldb-0.9.1-linux.tar.gz
mv openmldb-0.9.1-linux openmldb-tablet-0.9.1-2
cd openmldb-tablet-0.9.1-2
```

Modify the configuration again and start the TabletServer. Note that if all TabletServers are on the same machine, use different port numbers to avoid the "Fail to listen" error in the log (`logs/tablet.WARNING`).
Expand All @@ -454,10 +454,10 @@ Please ensure that all TabletServer have been successfully started before deploy
**1. Download the OpenMLDB deployment package**

````
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.9.0/openmldb-0.9.0-linux.tar.gz
tar -zxvf openmldb-0.9.0-linux.tar.gz
mv openmldb-0.9.0-linux openmldb-ns-0.9.0
cd openmldb-ns-0.9.0
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.9.1/openmldb-0.9.1-linux.tar.gz
tar -zxvf openmldb-0.9.1-linux.tar.gz
mv openmldb-0.9.1-linux openmldb-ns-0.9.1
cd openmldb-ns-0.9.1
````

**2. Modify the configuration file conf/nameserver.flags**
Expand Down Expand Up @@ -502,12 +502,12 @@ You can have only one NameServer, but if you need high availability, you can dep

To start the next NameServer on another machine, simply repeat the above steps on that machine. If starting the next NameServer on the same machine, ensure it's in a different directory and do not reuse the directory where NameServer has already been started.

For instance, you can decompress the package again (avoid using the directory where NameServer is already running, as files generated after startup may be affected) and name the directory `openmldb-ns-0.9.0-2`.
For instance, you can decompress the package again (avoid using the directory where NameServer is already running, as files generated after startup may be affected) and name the directory `openmldb-ns-0.9.1-2`.

```
tar -zxvf openmldb-0.9.0-linux.tar.gz
mv openmldb-0.9.0-linux openmldb-ns-0.9.0-2
cd openmldb-ns-0.9.0-2
tar -zxvf openmldb-0.9.1-linux.tar.gz
mv openmldb-0.9.1-linux openmldb-ns-0.9.1-2
cd openmldb-ns-0.9.1-2
```

Then modify the configuration and start.
Expand Down Expand Up @@ -548,10 +548,10 @@ Before running APIServer, ensure that the TabletServer and NameServer processes
**1. Download the OpenMLDB deployment package**

```
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.9.0/openmldb-0.9.0-linux.tar.gz
tar -zxvf openmldb-0.9.0-linux.tar.gz
mv openmldb-0.9.0-linux openmldb-apiserver-0.9.0
cd openmldb-apiserver-0.9.0
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.9.1/openmldb-0.9.1-linux.tar.gz
tar -zxvf openmldb-0.9.1-linux.tar.gz
mv openmldb-0.9.1-linux openmldb-apiserver-0.9.1
cd openmldb-apiserver-0.9.1
```

**2. Modify the configuration file conf/apiserver.flags**
Expand Down Expand Up @@ -615,18 +615,18 @@ Download the Spark distribution from the [Spark official website](https://spark.
Alternatively, use the OpenMLDB Spark distribution.

```shell
wget https://github.com/4paradigm/spark/releases/download/v3.2.1-openmldb0.9.0/spark-3.2.1-bin-openmldbspark.tgz
# Image address (China):https://www.openmldb.com/download/v0.9.0/spark-3.2.1-bin-openmldbspark.tgz
wget https://github.com/4paradigm/spark/releases/download/v3.2.1-openmldb0.9.1/spark-3.2.1-bin-openmldbspark.tgz
# Image address (China):https://www.openmldb.com/download/v0.9.1/spark-3.2.1-bin-openmldbspark.tgz
tar -zxvf spark-3.2.1-bin-openmldbspark.tgz
export SPARK_HOME=`pwd`/spark-3.2.1-bin-openmldbspark/
```

OpenMLDB deployment package:
```
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.9.0/openmldb-0.9.0-linux.tar.gz
tar -zxvf openmldb-0.9.0-linux.tar.gz
mv openmldb-0.9.0-linux openmldb-taskmanager-0.9.0
cd openmldb-taskmanager-0.9.0
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.9.1/openmldb-0.9.1-linux.tar.gz
tar -zxvf openmldb-0.9.1-linux.tar.gz
mv openmldb-0.9.1-linux openmldb-taskmanager-0.9.1
cd openmldb-taskmanager-0.9.1
```

**2. Modify the configuration file conf/taskmanager.properties**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This article demonstrates how to use [OpenMLDB](https://github.com/4paradigm/Ope

The command is as follows:
```
docker run --network host -dit --name openmldb -v /mlsql/admin/:/byzermnt 4pdosc/openmldb:0.9.0 bash
docker run --network host -dit --name openmldb -v /mlsql/admin/:/byzermnt 4pdosc/openmldb:0.9.1 bash
docker exec -it openmldb bash
/work/init.sh
echo "create database db1;" | /work/openmldb/bin/openmldb --zk_cluster=127.0.0.1:2181 --zk_root_path=/openmldb --role=sql_client
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For smooth function, we recommend starting OpenMLDB using the docker image and i
Since Airflow Web requires an external port for login, the container's port must be exposed. Then map the downloaded file from the previous step to the `/work/airflow/dags` directory. This step is crucial for Airflow to load the DAGs from this folder correctly.

```
docker run -p 8080:8080 -v `pwd`/airflow_demo_files:/work/airflow_demo_files -it 4pdosc/openmldb:0.9.0 bash
docker run -p 8080:8080 -v `pwd`/airflow_demo_files:/work/airflow_demo_files -it 4pdosc/openmldb:0.9.1 bash
```

#### Download and Install Airflow and Airflow OpenMLDB Provider
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ In addition to SQL execution in OpenMLDB, real-time prediction also requires mod

The test can be executed on macOS or Linux, and we recommend running this demo within the provided OpenMLDB docker image. In this setup, both OpenMLDB and DolphinScheduler will be launched inside the container, with the port of DolphinScheduler exposed.
```
docker run -it -p 12345:12345 4pdosc/openmldb:0.9.0 bash
docker run -it -p 12345:12345 4pdosc/openmldb:0.9.1 bash
```
```{attention}
For proper configuration of DolphinScheduler, the tenant should be set up as a user of the operating system, and this user must have sudo permissions. It is advised to download and initiate DolphinScheduler within the OpenMLDB container. Otherwise, please ensure that the user has sudo permissions.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ This article will use Docker mode to start OpenMLDB, so there is no need to down
We recommend that you bind all three downloaded file packages to the `kafka` directory. Alternatively, you can download the file packages after starting the container. For our demonstration, we assume that the file packages are all in the `/work/kafka` directory.

```
docker run -it -v `pwd`:/work/kafka 4pdosc/openmldb:0.9.0 bash
docker run -it -v `pwd`:/work/kafka 4pdosc/openmldb:0.9.1 bash
```

### Note
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Currently, only the OpenMLDB cluster version can act as the receiver of sinks, a
We recommend using the 'host network' mode to run Docker and bind the file directory 'files' where the SQL script is located.

```
docker run -dit --network host -v `pwd`/files:/work/pulsar_files --name openmldb 4pdosc/openmldb:0.9.0 bash
docker run -dit --network host -v `pwd`/files:/work/pulsar_files --name openmldb 4pdosc/openmldb:0.9.1 bash
docker exec -it openmldb bash
```

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 @@ -18,7 +18,7 @@ This sample program is developed and deployed based on OpenMLDB CLI, so you need
Execute the following command in the command line to pull the OpenMLDB image and start the Docker container:

```bash
docker run -it 4pdosc/openmldb:0.9.0 bash
docker run -it 4pdosc/openmldb:0.9.1 bash
```

``` {note}
Expand Down
10 changes: 5 additions & 5 deletions docs/en/quickstart/sdk/java_sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ In Java SDK, the default execution mode for JDBC Statements is online, while the
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-jdbc</artifactId>
<version>0.9.0</version>
<version>0.9.1</version>
</dependency>
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-native</artifactId>
<version>0.9.0</version>
<version>0.9.1</version>
</dependency>
```

Expand All @@ -29,16 +29,16 @@ In Java SDK, the default execution mode for JDBC Statements is online, while the
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-jdbc</artifactId>
<version>0.9.0</version>
<version>0.9.1</version>
</dependency>
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-native</artifactId>
<version>0.9.0-macos</version>
<version>0.9.1-macos</version>
</dependency>
```

Note: Since the openmldb-native package contains the C++ static library compiled for OpenMLDB, it defaults to the Linux static library. For macOS, the version of openmldb-native should be changed to `0.9.0-macos`, while the version of openmldb-jdbc remains unchanged.
Note: Since the openmldb-native package contains the C++ static library compiled for OpenMLDB, it defaults to the Linux static library. For macOS, the version of openmldb-native should be changed to `0.9.1-macos`, while the version of openmldb-jdbc remains unchanged.

The macOS version of openmldb-native only supports macOS 12. To run it on macOS 11 or macOS 10.15, the openmldb-native package needs to be compiled from the source code on the corresponding OS. For detailed compilation methods, please refer to [Java SDK](../../deploy/compile.md#Build-java-sdk-with-multi-processes).
When using a self-compiled openmldb-native package, it is recommended to install it into your local Maven repository using `mvn install`. After that, you can reference it in your project's pom.xml file. It's not advisable to reference it using `scope=system`.
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.9.0 bash
docker run -p 6527:6527 -p 9921:9921 -p 8080:8080 -it 4pdosc/openmldb:0.9.1 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.9.0 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.9.1 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.9.0 bash
docker run --network host -it 4pdosc/openmldb:0.9.1 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/tutorial/standalone_use.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This article provides a guide on developing and deploying with OpenMLDB CLI. To
Execute the following command to fetch the OpenMLDB image and initiate a Docker container:

```bash
docker run -it 4pdosc/openmldb:0.9.0 bash
docker run -it 4pdosc/openmldb:0.9.1 bash
```

Upon successful container launch, all subsequent commands in this tutorial will assume execution within the container.
Expand Down
Loading

0 comments on commit b7f0489

Please sign in to comment.