Merge pull request #604 from yangj1211/2.0.1

add doc of 2.0.1
matrixorigin · Dec 11, 2024 · 64350b9 · 64350b9
2 parents 38a247a + 80e07f0
commit 64350b9
Show file tree

Hide file tree

Showing 40 changed files with 1,330 additions and 115 deletions.
diff --git a/docs/MatrixOne/Contribution-Guide/How-to-Contribute/preparation.md b/docs/MatrixOne/Contribution-Guide/How-to-Contribute/preparation.md
@@ -16,7 +16,7 @@ These introductions will help you go through you the key concepts and user detai
 
 ### Roadmap
 
-MatrixOne v24.2.0.0 has been released, you can see [Release Notes](../../Release-Notes/v24.2.0.0.md) know more information.
+MatrixOne v24.2.0.1 has been released, you can see [Release Notes](../../Release-Notes/v24.2.0.1.md) know more information.
 
 For the long-term project roadmap, please refer to [MatrixOne roadmap](https://github.com/matrixorigin/matrixone/issues/613) for a more general overview.
 

diff --git a/docs/MatrixOne/Deploy/deploy-MatrixOne-cluster.md b/docs/MatrixOne/Deploy/deploy-MatrixOne-cluster.md
@@ -648,7 +648,7 @@ mysql -h $(kubectl get svc/mo-tp-cn -n mo-hn -o jsonpath='{.spec.clusterIP}') -P
 mysql: [Warning] Using a password on the command line interface can be insecure.
 Welcome to the MySQL monitor.  Commands end with ; or \g.
 Your MySQL connection id is 163
-Server version: 8.0.30-MatrixOne-v2.0.0 MatrixOne
+Server version: 8.0.30-MatrixOne-v2.0.1 MatrixOne
 
 Copyright (c) 2000, 2023, Oracle and/or its affiliates.
 

diff --git a/docs/MatrixOne/Deploy/deploy-Matrixone-cluster/deploy-MatrixOne-cluster-with-k8.md b/docs/MatrixOne/Deploy/deploy-Matrixone-cluster/deploy-MatrixOne-cluster-with-k8.md
@@ -479,6 +479,49 @@ This section describes two ways to deploy MatrixOne: YAML and Chart.
     helm install -n ${NS} ${RELEASE_NAME} matrixone-operator/matrixone --version ${VERSION} -f values.yaml
     ```
 
+### Dynamic expansion
+
+The Operator supports dynamic expansion of the cacheVolume configuration of TN and CN, but does not support the reduction operation. There is no need to restart the CN and TN pods before and after the expansion process. The specific steps are as follows:
+
+1. Make sure the StorageClass supports the volume extension feature
+
+    ```bash
+    #View storageclass name
+    >kubectl get pvc -n ${MO_NS}
+
+    #Check whether StorageClass supports volume extension function
+    >kubectl get storageclass ${SC_NAME} -oyaml |  grep allowVolumeExpansion #SC_NAME is the sc type of pvc used by the mo cluster
+    allowVolumeExpansion: true #Only when true can subsequent steps be performed
+    ```
+
+2. Enter cluster configuration editing mode
+
+    ```bash
+    kubectl edit mo -n ${MO_NS} ${MO_NAME} # Among them, MO_NS is the namespace where the MO cluster is deployed, and MO_NAME is the name of the MO cluster; for example,MO_NS=matrixone; MO_NAME=mo_cluster
+    ```
+
+3. Modify the cacheVolume size of tn and cn as needed
+
+    ```bash
+    - cacheVolume:
+            size: 900Gi
+    ```
+
+    - If it is a CN group, modify spec.cnGroups[0].cacheVolume (or spec.cnGroups[1].cacheVolume, where n in [n] is the array subscript of the CN Group);
+    - If it is CN, modify spec.tp.cacheVolume;
+    - If TN, modifies spec.tn.cacheVolume (or spec.dn.cacheVolume).
+
+    Then save and exit: press `esq` keys, and `:wq`
+
+4. View expansion results
+
+    ```bash
+    #The value of the `capacity` field is the value after expansion.
+    >kubectl get pvc -n ${MO_NS}
+
+    >kubectl get pv | grep ${NS}
+    ```
+
 ### Checking cluster status
 
 Observe cluster status until Ready

diff --git a/...atrixOne/Deploy/deploy-Matrixone-cluster/deploy-MatrixOne-cluster-without-k8.md b/...atrixOne/Deploy/deploy-Matrixone-cluster/deploy-MatrixOne-cluster-without-k8.md
@@ -679,6 +679,49 @@ To learn more about Matrixone Operator, check out [Operator Administration](../.
     mo-tp-cn-0                           1/1     Running   0             50s
     ```
 
+### Dynamic expansion
+
+The Operator supports dynamic expansion of the cacheVolume configuration of TN and CN, but does not support the reduction operation. There is no need to restart the CN and TN pods before and after the expansion process. The specific steps are as follows:
+
+1. Make sure the StorageClass supports the volume extension feature
+
+    ```bash
+    #View storageclass name
+    >kubectl get pvc -n ${MO_NS}
+
+    #Check whether StorageClass supports volume extension function
+    >kubectl get storageclass ${SC_NAME} -oyaml |  grep allowVolumeExpansion #SC_NAME is the sc type of pvc used by the mo cluster
+    allowVolumeExpansion: true #Only when true can subsequent steps be performed
+    ```
+
+2. Enter cluster configuration editing mode
+
+    ```bash
+    kubectl edit mo -n ${MO_NS} ${MO_NAME} # Among them, MO_NS is the namespace where the MO cluster is deployed, and MO_NAME is the name of the MO cluster; for example,MO_NS=matrixone; MO_NAME=mo_cluster
+    ```
+
+3. Modify the cacheVolume size of tn and cn as needed
+
+    ```bash
+    - cacheVolume:
+            size: 900Gi
+    ```
+
+    - If it is a CN group, modify spec.cnGroups[0].cacheVolume (or spec.cnGroups[1].cacheVolume, where n in [n] is the array subscript of the CN Group);
+    - If it is CN, modify spec.tp.cacheVolume;
+    - If TN, modifies spec.tn.cacheVolume (or spec.dn.cacheVolume).
+
+    Then save and exit: press `esq` keys, and `:wq`
+
+4. View expansion results
+
+    ```bash
+    #The value of the `capacity` field is the value after expansion.
+    >kubectl get pvc -n ${MO_NS}
+
+    >kubectl get pv | grep ${NS}
+    ```
+
 ## Connecting a MatrixOne Cluster
 
 In order to connect to a MatrixOne cluster, you need to map the port of the corresponding service to the MatrixOne node. Here is a guide for connecting to a MatrixOne cluster using `kubectl port-forward`:

diff --git a/docs/MatrixOne/Deploy/deploy-matrixone-single-with-s3.md b/docs/MatrixOne/Deploy/deploy-matrixone-single-with-s3.md
@@ -736,7 +736,7 @@ cnservices = [
 
 ```bash
 #Configure cn.toml, tn.toml and log.toml first.
-mo_ctl set_conf MO_CONTAINER_IMAGE=matrixorigin/matrixone/2.0.0 #Setting up mirroring
+mo_ctl set_conf MO_CONTAINER_IMAGE=matrixorigin/matrixone/2.0.1 #Setting up mirroring
 mo_ctl set_conf MO_CONTAINER_NAME=mo # Setting the container name
 mo_ctl set_conf MO_CONTAINER_CONF_HOST_PATH=/data/mo_confs/ # Set the directory on the host machine where the mo configuration file is stored
 mo_ctl set_conf MO_CONTAINER_CONF_CON_FILE="/etc/launch.toml" # Set the path to the configuration file inside the container when the container starts up

diff --git a/docs/MatrixOne/Deploy/update-MatrixOne-cluster.md b/docs/MatrixOne/Deploy/update-MatrixOne-cluster.md
@@ -69,7 +69,7 @@ According to the introduction in [MatrixOne Distributed Cluster Deployment](depl
     root@master0 ~]# mysql -h $(kubectl get svc/mo-tp-cn -n mo-hn -o jsonpath='{.spec.clusterIP}') -P 6001 -uroot -p111
     Welcome to the MariaDB monitor.  Commands end with ; or \g.
     Your MySQL connection id is 1005
-    Server version: 8.0.30-MatrixOne-v2.0.0 MatrixOne
+    Server version: 8.0.30-MatrixOne-v2.0.1 MatrixOne
 
     Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.
 

diff --git a/docs/MatrixOne/Develop/connect-mo/configure-mo-ssl-connection.md b/docs/MatrixOne/Develop/connect-mo/configure-mo-ssl-connection.md
@@ -83,7 +83,7 @@ To test the SSL configuration, perform the following steps:
     Current pager:		stdout
     Using outfile:		''
     Using delimiter:	;
-    Server version:		8.0.30-MatrixOne-v2.0.0 MatrixOne
+    Server version:		8.0.30-MatrixOne-v2.0.1 MatrixOne
     Protocol version:	10
     Connection:		127.0.0.1 via TCP/IP
     Client characterset:	utf8mb4

diff --git a/docs/MatrixOne/Develop/connect-mo/database-client-tools.md b/docs/MatrixOne/Develop/connect-mo/database-client-tools.md
@@ -41,7 +41,7 @@ Make sure you have already [installed and launched MatrixOne](../../Get-Started/
 
     ```
     Welcome to the MySQL monitor. Commands end with ; or \g. Your MySQL connection id is 1031
-    Server version: 8.0.30-MatrixOne-v2.0.0 MatrixOne
+    Server version: 8.0.30-MatrixOne-v2.0.1 MatrixOne
     Copyright (c) 2000, 2022, Oracle and/or its affiliates.
 
     Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

diff --git a/docs/MatrixOne/Develop/connect-mo/python-connect-to-matrixone.md b/docs/MatrixOne/Develop/connect-mo/python-connect-to-matrixone.md
@@ -69,7 +69,7 @@ The PyMySQL is a pure-Python MySQL client library.
 
     ```
     > python3 pymysql_connect_matrixone.py
-    Database version : 8.0.30-MatrixOne-v2.0.0
+    Database version : 8.0.30-MatrixOne-v2.0.1
     ```
 
 ## Using sqlalchemy connect to MatrixOne

diff --git a/docs/MatrixOne/Develop/export-data/select-into-outfile.md b/docs/MatrixOne/Develop/export-data/select-into-outfile.md
@@ -48,7 +48,7 @@ mysql> SELECT * FROM TEST INTO OUTFILE '/root/test.csv'
     If you installed MatrixOne via `docker`, the export directory is located in the docker image by default. If you need to mount a local directory, see the following code example: the local file system path *${local_data_path}/mo-data*is mounted into the MatrixOne Docker image and mapped to the */mo-data*path. For more information, see the [Docker Mount Volume tutorial](https://www.freecodecamp.org/news/docker-mount-volume-guide-how-to-mount-a-local-directory/).
 
 ```
-sudo docker run --name <name> --privileged -d -p 6001:6001 -v ${local_data_path}/mo-data:/mo-data:rw matrixorigin/matrixone:2.0.0
+sudo docker run --name <name> --privileged -d -p 6001:6001 -v ${local_data_path}/mo-data:/mo-data:rw matrixorigin/matrixone:2.0.1
 ```
 
 ### Steps

diff --git a/docs/MatrixOne/Develop/import-data/bulk-load/load-csv.md b/docs/MatrixOne/Develop/import-data/bulk-load/load-csv.md
@@ -104,7 +104,7 @@ __Note__: A `csv`(comma-separated values) file is a delimited text file that use
 ### Example using `Load data` with `docker` version
 
 If you install MatrixOne by `docker`, the file system is inside the docker image by default. To work with local directory, you need to bind a local directory to the container. In the following example, the local file system path `~/tmp/docker_loaddata_demo/` is binded to the MatrixOne docker image, with a mapping to the `/ssb-dbgen-path` path inside the docker.
-We will walk you through the whole process of loading data with MatrixOne 2.0.0 docker version in this example.
+We will walk you through the whole process of loading data with MatrixOne 2.0.1 docker version in this example.
 
 1. Download the dataset file and store the data in *~/tmp/docker_loaddata_demo/*:
 
@@ -122,7 +122,7 @@ We will walk you through the whole process of loading data with MatrixOne 2.0.0
 3. Use Docker to launch MatrixOne, and mount the directory *~/tmp/docker_loaddata_demo/* that stores data files to a directory in the container. The container directory is */sb-dbgen-path* as an example:
 
     ```
-    sudo docker run --name matrixone --privileged -d -p 6001:6001 -v ~/tmp/docker_loaddata_demo/:/ssb-dbgen-path:rw matrixorigin/matrixone:2.0.0
+    sudo docker run --name matrixone --privileged -d -p 6001:6001 -v ~/tmp/docker_loaddata_demo/:/ssb-dbgen-path:rw matrixorigin/matrixone:2.0.1
     ```
 
 4. Connect to MatrixOne server:

diff --git a/docs/MatrixOne/Develop/import-data/bulk-load/using-source.md b/docs/MatrixOne/Develop/import-data/bulk-load/using-source.md
@@ -66,6 +66,6 @@ select * from tool;
 
 ## Constraints
 
-MatrixOne v24.2.0.0 version already supports MySQL table creation statements, so you can smoothly migrate MySQL tables to MatrixOne. However, it should be noted that during the migration process, some keywords incompatible with MySQL, such as `engine=`, will be automatically ignored in MatrixOne and will not affect the migration of the table structure.
+MatrixOne v24.2.0.1 version already supports MySQL table creation statements, so you can smoothly migrate MySQL tables to MatrixOne. However, it should be noted that during the migration process, some keywords incompatible with MySQL, such as `engine=`, will be automatically ignored in MatrixOne and will not affect the migration of the table structure.
 
 However, it should be noted that although MatrixOne supports MySQL table creation statements, manual modification is still required if the migrated table contains incompatible data types, triggers, functions, or stored procedures. For more detailed compatibility information, see [MySQL Compatibility](../../../Overview/feature/mysql-compatibility.md).
diff --git a/docs/MatrixOne/FAQs/product-faqs.md b/docs/MatrixOne/FAQs/product-faqs.md
@@ -29,7 +29,7 @@ Both MatrixOne 0.8.0 and above can be upgraded directly from a lower version to
 
 Is MatrixOne stable **now? Which version is recommended?**
 
-MatrixOne is now available in version v24.2.0.0. We've done a lot of optimization work on stability, and it's ready to be used in the production business.
+MatrixOne is now available in version v24.2.0.1. We've done a lot of optimization work on stability, and it's ready to be used in the production business.
 
 **Is there a cloud version of MatrixOne? Want a quick test to see**.
 

diff --git a/docs/MatrixOne/Get-Started/install-on-linux/install-on-linux-method1.md b/docs/MatrixOne/Get-Started/install-on-linux/install-on-linux-method1.md
@@ -184,7 +184,7 @@ GCC_VERSION="8.5.0"
 CLANG_VERSION="13.0"
 GO_VERSION="1.22"
 MO_GIT_URL="https://github.com/matrixorigin/matrixone.git"
-MO_DEFAULT_VERSION="v2.0.0"
+MO_DEFAULT_VERSION="v2.0.1"
 GOPROXY="https://goproxy.cn,direct"
 STOP_INTERVAL="5"
 START_INTERVAL="2"
@@ -200,7 +200,7 @@ Generally, the parameters that need to be adjusted are as follows:
 ````
 mo_ctl set_conf MO_PATH="yourpath" # Set custom MatrixOne download path
 mo_ctl set_conf MO_GIT_URL="https://githubfast.com/matrixorigin/matrixone.git" # For the problem of slow downloading from the original GitHub address, set image download address
-mo_ctl set_conf MO_DEFAULT_VERSION="v2.0.0" # Set the version of MatrixOne downloaded
+mo_ctl set_conf MO_DEFAULT_VERSION="v2.0.1" # Set the version of MatrixOne downloaded
 mo_ctl set_conf MO_DEPLOY_MODE=git  # Deployment Configuration
 ````
 
@@ -219,7 +219,7 @@ Depending on your needs, choose whether you want to keep your code up to date, o
 === "Get the MatrixOne(Stable Version) code to build"
 
      ```
-     mo_ctl deploy v2.0.0
+     mo_ctl deploy v2.0.1
      ```
 
 ## Step 4: Launch MatrixOne server
@@ -256,7 +256,7 @@ root@VM-16-2-debian:~# mo_ctl connect
 mysql: [Warning] Using a password on the command line interface can be insecure.
 Welcome to the MySQL monitor.  Commands end with ; or \g.
 Your MySQL connection id is 15
-Server version: 8.0.30-MatrixOne-v2.0.0 MatrixOne
+Server version: 8.0.30-MatrixOne-v2.0.1 MatrixOne
 
 Copyright (c) 2000, 2023, Oracle and/or its affiliates.
 

diff --git a/docs/MatrixOne/Get-Started/install-on-linux/install-on-linux-method2.md b/docs/MatrixOne/Get-Started/install-on-linux/install-on-linux-method2.md
@@ -96,16 +96,16 @@ The Debian11.1 version does not have MySQL Client installed by default, so it ne
 
      ```bash
      mkdir -p /root/matrixone & cd /root/
-     wget https://github.com/matrixorigin/matrixone/releases/download/v2.0.0/mo-v2.0.0-linux-x86_64.zip
-     unzip -d matrixone/ mo-v2.0.0-linux-x86_64.zip
+     wget https://github.com/matrixorigin/matrixone/releases/download/v2.0.1/mo-v2.0.1-linux-x86_64.zip
+     unzip -d matrixone/ mo-v2.0.1-linux-x86_64.zip
      ```
 
      Binary for ARM architecture system:
 
      ```bash
      mkdir -p /root/matrixone & cd /root/
-     wget https://github.com/matrixorigin/matrixone/releases/download/v2.0.0/mo-v2.0.0-linux-arm64.zip
-     unzip -d matrixone/ mo-v2.0.0-linux-arm64.zip
+     wget https://github.com/matrixorigin/matrixone/releases/download/v2.0.1/mo-v2.0.1-linux-arm64.zip
+     unzip -d matrixone/ mo-v2.0.1-linux-arm64.zip
      ```
 
 === "**Downloading method 2: Using `curl` to install binary packages**"
@@ -114,21 +114,21 @@ The Debian11.1 version does not have MySQL Client installed by default, so it ne
 
      ```bash
      mkdir -p /root/matrixone & cd /root/
-     curl -OL https://github.com/matrixorigin/matrixone/releases/download/v2.0.0/mo-v2.0.0-linux-x86_64.zip
-     unzip -d matrixone/ mo-v2.0.0-linux-x86_64.zip
+     curl -OL https://github.com/matrixorigin/matrixone/releases/download/v2.0.1/mo-v2.0.1-linux-x86_64.zip
+     unzip -d matrixone/ mo-v2.0.1-linux-x86_64.zip
      ```
 
      Binary for ARM architecture system:
 
      ```bash
      mkdir -p /root/matrixone & cd /root/
-     curl -OL https://github.com/matrixorigin/matrixone/releases/download/v2.0.0/mo-v2.0.0-linux-arm64.zip
-     unzip -d matrixone/ mo-v2.0.0-linux-arm64.zip
+     curl -OL https://github.com/matrixorigin/matrixone/releases/download/v2.0.1/mo-v2.0.1-linux-arm64.zip
+     unzip -d matrixone/ mo-v2.0.1-linux-arm64.zip
      ```
 
 === "**Downloading method 3: Go to the page and download**"
 
-     If you want a more intuitive way to download the page, go to the [version 2.0.0](https://github.com/matrixorigin/matrixone/releases/tag/v2.0.0), pull down to find the **Assets** column, and click the installation package *mo-v2.0.0-linux-x86_64.zip* or *mo-v2.0.0-linux-arm64.zip* can be downloaded.
+     If you want a more intuitive way to download the page, go to the [version 2.0.1](https://github.com/matrixorigin/matrixone/releases/tag/v2.0.1), pull down to find the **Assets** column, and click the installation package *mo-v2.0.1-linux-x86_64.zip* or *mo-v2.0.1-linux-arm64.zip* can be downloaded.
 
 ## Step 3: Install the mo_ctl tool
 
@@ -147,26 +147,26 @@ wget https://raw.githubusercontent.com/matrixorigin/mo_ctl_standalone/main/insta
 The parameters that need to be adjusted are as follows:
 
 ````
-mo_ctl set_conf MO_PATH="/yourpath/mo-v2.0.0-xx-xx" # Set the MO_PATH to the directory where the binary files are extracted
-mo_ctl set_conf MO_CONF_FILE="/yourpath/mo-v2.0.0-xx-xx/etc/launch/launch.toml" # Set the MO_CONF_FILE path
+mo_ctl set_conf MO_PATH="/yourpath/mo-v2.0.1-xx-xx" # Set the MO_PATH to the directory where the binary files are extracted
+mo_ctl set_conf MO_CONF_FILE="/yourpath/mo-v2.0.1-xx-xx/etc/launch/launch.toml" # Set the MO_CONF_FILE path
 mo_ctl set_conf MO_DEPLOY_MODE=binary  #Deployment Configuration
 ````
 
 ## Step 4: Launch MatrixOne server
 
 Launch the MatrixOne service through the `mo_ctl start` command.
 
-If the operation is regular, the following log will appear. The relevant operation logs of MatrixOne will be in `/yourpath/mo-v2.0.0-xx-xx/matrixone/logs/`.
+If the operation is regular, the following log will appear. The relevant operation logs of MatrixOne will be in `/yourpath/mo-v2.0.1-xx-xx/matrixone/logs/`.
 
 ```
 root@VM-16-2-debian:~# mo_ctl start
 2024-03-07 14:34:04.942 UTC+0800    [INFO]    No mo-service is running
 2024-03-07 14:34:04.998 UTC+0800    [INFO]    Get conf succeeded: MO_DEPLOY_MODE="binary"
 2024-03-07 14:34:05.024 UTC+0800    [INFO]    GO memory limit(Mi): 14745
-2024-03-07 14:34:05.072 UTC+0800    [INFO]    Starting mo-service: cd /Users/admin/mo-v2.0.0-linux-arm64/ && GOMEMLIMIT=14745MiB /Users/admin/mo-v2.0.0-linux-arm64/mo-service -daemon -debug-http :9876 -launch /Users/admin/mo-v2.0.0-linux-arm64/etc/launch/launch.toml >/Users/admin/mo-v2.0.0-linux-arm64/matrixone/logs/stdout-20240307_143405.log 2>/Users/admin/mo-v2.0.0-linux-arm64/matrixone/logs/stderr-20240307_143405.log
+2024-03-07 14:34:05.072 UTC+0800    [INFO]    Starting mo-service: cd /Users/admin/mo-v2.0.1-linux-arm64/ && GOMEMLIMIT=14745MiB /Users/admin/mo-v2.0.1-linux-arm64/mo-service -daemon -debug-http :9876 -launch /Users/admin/mo-v2.0.1-linux-arm64/etc/launch/launch.toml >/Users/admin/mo-v2.0.1-linux-arm64/matrixone/logs/stdout-20240307_143405.log 2>/Users/admin/mo-v2.0.1-linux-arm64/matrixone/logs/stderr-20240307_143405.log
 2024-03-07 14:34:05.137 UTC+0800    [INFO]    Wait for 2 seconds
 2024-03-07 14:34:07.261 UTC+0800    [INFO]    At least one mo-service is running. Process info: 
-  501 27145     1   0  2:34下午 ??         0:00.18 /Users/admin/mo-v2.0.0-linux-arm64/mo-service -daemon -debug-http :9876 -launch /Users/admin/mo-v2.0.0-linux-arm64/etc/launch/launch.toml
+  501 27145     1   0  2:34下午 ??         0:00.18 /Users/admin/mo-v2.0.1-linux-arm64/mo-service -daemon -debug-http :9876 -launch /Users/admin/mo-v2.0.1-linux-arm64/etc/launch/launch.toml
 2024-03-07 14:34:07.284 UTC+0800    [INFO]    List of pid(s): 
 27145
 2024-03-07 14:34:07.308 UTC+0800    [INFO]    Start succeeded
@@ -188,7 +188,7 @@ root@VM-16-2-debian:~# mo_ctl connect
 2024-03-07 14:34:59.942 UTC+0800    [INFO]    Ok, connecting for user ... 
 Welcome to the MySQL monitor.  Commands end with ; or \g.
 Your MySQL connection id is 426
-Server version: 8.0.30-MatrixOne-v2.0.0 MatrixOne
+Server version: 8.0.30-MatrixOne-v2.0.1 MatrixOne
 
 Copyright (c) 2000, 2018, Oracle and/or its affiliates. All rights reserved.