update README to add child section number and remove tsbs, crash_gen test from testing part
This commit is contained in:
parent
c85f5833a0
commit
a0be3dcaec
187
README.md
187
README.md
|
@ -63,121 +63,25 @@ For user manual, system design and architecture, please refer to [TDengine Docum
|
||||||
|
|
||||||
# 3. Prerequisites
|
# 3. Prerequisites
|
||||||
|
|
||||||
List the software and tools required to work on the project.
|
## 3.1 Install dependencies tools
|
||||||
|
|
||||||
- go 1.20+ (for taosadapter)
|
### The required package for linux
|
||||||
- node 16.20.2 (for taos-explorer)
|
|
||||||
- python 3.10.12+ (for test)
|
|
||||||
|
|
||||||
Step-by-step instructions to set up the prerequisites software.
|
|
||||||
|
|
||||||
#### Install dependencies tools
|
|
||||||
|
|
||||||
- The required package for linux
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
apt-get install -y llvm gcc make cmake libssl-dev pkg-config perl g++ lzma curl locales psmisc sudo tree libgeos-dev libgflags2.2 libgflags-dev libgoogle-glog-dev libjansson-dev libsnappy-dev liblzma-dev libz-dev zlib1g build-essential valgrind rsync vim libjemalloc-dev openssh-server screen sshpass net-tools dirmngr gnupg apt-transport-https ca-certificates software-properties-common r-base iputils-ping
|
apt-get install -y llvm gcc make cmake libssl-dev pkg-config perl g++ lzma curl locales psmisc sudo tree libgeos-dev libgflags2.2 libgflags-dev libgoogle-glog-dev libjansson-dev libsnappy-dev liblzma-dev libz-dev zlib1g build-essential valgrind rsync vim libjemalloc-dev openssh-server screen sshpass net-tools dirmngr gnupg apt-transport-https ca-certificates software-properties-common r-base iputils-ping
|
||||||
```
|
```
|
||||||
|
|
||||||
Install Go for linux
|
### The required package for windows
|
||||||
|
|
||||||
Update the installation package to version 1.23.3.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd /usr/local/
|
|
||||||
wget https://golang.google.cn/dl/go1.23.3.linux-amd64.tar.gz
|
|
||||||
rm -rf /usr/local/go && tar -C /usr/local -xzf go1.23.3.linux-amd64.tar.gz
|
|
||||||
```
|
|
||||||
|
|
||||||
Set up environment variables, first add the following content to the end of the `~/.bashrc` file.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
export GO_HOME=/usr/local/go
|
|
||||||
export PATH=$GO_HOME/bin:$PATH
|
|
||||||
export CGO_ENABLED=1
|
|
||||||
```
|
|
||||||
|
|
||||||
Then make the environment variables take effect.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
source ~/.bashrc
|
|
||||||
```
|
|
||||||
|
|
||||||
Configure proxy to accelerate the download of Go dependencies.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go env -w GOPROXY=https://goproxy.cn,direct
|
|
||||||
go env -w GO111MODULE=on
|
|
||||||
```
|
|
||||||
|
|
||||||
Check if the environment variables have taken effect and if the version is the installed version.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go env
|
|
||||||
go version
|
|
||||||
```
|
|
||||||
|
|
||||||
Install node for linux
|
|
||||||
|
|
||||||
Recommend install node using nvm.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.8/install.sh | bash
|
|
||||||
```
|
|
||||||
|
|
||||||
Set up environment variables, add the following content to the end of the `~/.bashrc` file.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
export NVM_DIR="$HOME/.nvm"
|
|
||||||
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
|
|
||||||
```
|
|
||||||
|
|
||||||
Then make the environment variables take effect.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
source ~/.bashrc
|
|
||||||
```
|
|
||||||
|
|
||||||
Finally, Install node and yarn.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
nvm install 16.20.2
|
|
||||||
npm config set registry=https://registry.npmmirror.com
|
|
||||||
npm install -g yarn
|
|
||||||
```
|
|
||||||
|
|
||||||
Install Python-connector for linux
|
|
||||||
|
|
||||||
Install Python3.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
apt install python3
|
|
||||||
apt install python3-pip
|
|
||||||
```
|
|
||||||
|
|
||||||
Install the dependent Python components.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip3 install pandas psutil fabric2 requests faker simplejson toml pexpect tzlocal distro decorator loguru hyperloglog
|
|
||||||
```
|
|
||||||
|
|
||||||
Install the Python connector for TDengine.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip3 install taospy taos-ws-py
|
|
||||||
```
|
|
||||||
|
|
||||||
- The required package for windows
|
|
||||||
|
|
||||||
to be updated...
|
to be updated...
|
||||||
|
|
||||||
- The required package for macOS
|
### The required package for macOS
|
||||||
|
|
||||||
```
|
```
|
||||||
brew install argp-standalone gflags pkgconfig
|
brew install argp-standalone gflags pkgconfig
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Get the source codes
|
## 3.2 Get the source codes
|
||||||
|
|
||||||
First of all, you may clone the source codes from github:
|
First of all, you may clone the source codes from github:
|
||||||
|
|
||||||
|
@ -193,7 +97,7 @@ Step-by-step instructions to set up the prerequisites software.
|
||||||
insteadOf = https://github.com/
|
insteadOf = https://github.com/
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Special Note
|
## 3.3 Special Note
|
||||||
[JDBC Connector](https://github.com/taosdata/taos-connector-jdbc), [Go Connector](https://github.com/taosdata/driver-go),[Python Connector](https://github.com/taosdata/taos-connector-python),[Node.js Connector](https://github.com/taosdata/taos-connector-node),[C# Connector](https://github.com/taosdata/taos-connector-dotnet) ,[Rust Connector](https://github.com/taosdata/taos-connector-rust) and [Grafana plugin](https://github.com/taosdata/grafanaplugin) has been moved to standalone repository.
|
[JDBC Connector](https://github.com/taosdata/taos-connector-jdbc), [Go Connector](https://github.com/taosdata/driver-go),[Python Connector](https://github.com/taosdata/taos-connector-python),[Node.js Connector](https://github.com/taosdata/taos-connector-node),[C# Connector](https://github.com/taosdata/taos-connector-dotnet) ,[Rust Connector](https://github.com/taosdata/taos-connector-rust) and [Grafana plugin](https://github.com/taosdata/grafanaplugin) has been moved to standalone repository.
|
||||||
|
|
||||||
# 4. Building
|
# 4. Building
|
||||||
|
@ -206,7 +110,7 @@ TDengine provide a few useful tools such as taosBenchmark (was named taosdemo) a
|
||||||
|
|
||||||
To build TDengine, use [CMake](https://cmake.org/) 3.13.0 or higher versions in the project directory.
|
To build TDengine, use [CMake](https://cmake.org/) 3.13.0 or higher versions in the project directory.
|
||||||
|
|
||||||
- Linux platform building
|
## 4.1 Linux platform building
|
||||||
|
|
||||||
You can run the bash script `build.sh` to build both TDengine and taosTools including taosBenchmark and taosdump as below:
|
You can run the bash script `build.sh` to build both TDengine and taosTools including taosBenchmark and taosdump as below:
|
||||||
|
|
||||||
|
@ -239,7 +143,7 @@ To build TDengine, use [CMake](https://cmake.org/) 3.13.0 or higher versions in
|
||||||
cmake .. -DCPUTYPE=aarch64 && cmake --build .
|
cmake .. -DCPUTYPE=aarch64 && cmake --build .
|
||||||
```
|
```
|
||||||
|
|
||||||
- Windows platform building
|
## 4.2 Windows platform building
|
||||||
|
|
||||||
If you use the Visual Studio 2013, please open a command window by executing "cmd.exe".
|
If you use the Visual Studio 2013, please open a command window by executing "cmd.exe".
|
||||||
Please specify "amd64" for 64 bits Windows or specify "x86" for 32 bits Windows when you execute vcvarsall.bat.
|
Please specify "amd64" for 64 bits Windows or specify "x86" for 32 bits Windows when you execute vcvarsall.bat.
|
||||||
|
@ -271,7 +175,7 @@ To build TDengine, use [CMake](https://cmake.org/) 3.13.0 or higher versions in
|
||||||
nmake
|
nmake
|
||||||
```
|
```
|
||||||
|
|
||||||
- MacOS platform building
|
## 4.3 MacOS platform building
|
||||||
|
|
||||||
Please install XCode command line tools and cmake. Verified with XCode 11.4+ on Catalina and Big Sur.
|
Please install XCode command line tools and cmake. Verified with XCode 11.4+ on Catalina and Big Sur.
|
||||||
|
|
||||||
|
@ -286,7 +190,7 @@ To be updated...
|
||||||
|
|
||||||
# 6. Installation
|
# 6. Installation
|
||||||
|
|
||||||
- Linux platform installation
|
## 6.1 Linux platform installation
|
||||||
|
|
||||||
After building successfully, TDengine can be installed by
|
After building successfully, TDengine can be installed by
|
||||||
|
|
||||||
|
@ -298,7 +202,7 @@ To be updated...
|
||||||
|
|
||||||
Installing from source code will also configure service management for TDengine.Users can also choose to [install from packages](https://docs.tdengine.com/get-started/deploy-from-package/) for it.
|
Installing from source code will also configure service management for TDengine.Users can also choose to [install from packages](https://docs.tdengine.com/get-started/deploy-from-package/) for it.
|
||||||
|
|
||||||
- Windows platform installation
|
## 6.2 Windows platform installation
|
||||||
|
|
||||||
After building successfully, TDengine can be installed by:
|
After building successfully, TDengine can be installed by:
|
||||||
|
|
||||||
|
@ -306,7 +210,7 @@ To be updated...
|
||||||
nmake install
|
nmake install
|
||||||
```
|
```
|
||||||
|
|
||||||
- MacOS platform installation
|
## 6.3 MacOS platform installation
|
||||||
|
|
||||||
After building successfully, TDengine can be installed by:
|
After building successfully, TDengine can be installed by:
|
||||||
|
|
||||||
|
@ -316,7 +220,9 @@ To be updated...
|
||||||
|
|
||||||
# 7. Running
|
# 7. Running
|
||||||
|
|
||||||
- To start the service after installation on linux, in a terminal, use:
|
## 7.1 Run TDengine on linux
|
||||||
|
|
||||||
|
To start the service after installation on linux, in a terminal, use:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo systemctl start taosd
|
sudo systemctl start taosd
|
||||||
|
@ -344,18 +250,23 @@ To be updated...
|
||||||
|
|
||||||
option "-c test/cfg" specifies the system configuration file directory.
|
option "-c test/cfg" specifies the system configuration file directory.
|
||||||
|
|
||||||
- To start the service after installation on windows, in a terminal, use:
|
## 7.2 Run TDengine on windows
|
||||||
|
|
||||||
|
To start the service after installation on windows, in a terminal, use:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
to be updated
|
to be updated
|
||||||
```
|
```
|
||||||
|
|
||||||
Then users can use the TDengine CLI to connect the TDengine server. In a terminal, use:
|
Then users can use the TDengine CLI to connect the TDengine server. In a terminal, use:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
to be updated
|
taos
|
||||||
```
|
```
|
||||||
|
|
||||||
- To start the service after installation on macOS, double-click the /applications/TDengine to start the program, or in a terminal, use:
|
## 7.3 Run TDengine on MacOS
|
||||||
|
|
||||||
|
To start the service after installation on macOS, double-click the /applications/TDengine to start the program, or in a terminal, use:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo launchctl start com.tdengine.taosd
|
sudo launchctl start com.tdengine.taosd
|
||||||
|
@ -371,7 +282,7 @@ If TDengine CLI connects the server successfully, welcome messages and version i
|
||||||
|
|
||||||
# 8. Testing
|
# 8. Testing
|
||||||
|
|
||||||
- Run the TSIM test script
|
## 8.1 Run the TSIM test script
|
||||||
|
|
||||||
TSIM test framework is developed by c++ in the start-up period of TDengine, the test scripts are basic cases, you can run
|
TSIM test framework is developed by c++ in the start-up period of TDengine, the test scripts are basic cases, you can run
|
||||||
the script with below command:
|
the script with below command:
|
||||||
|
@ -381,7 +292,7 @@ If TDengine CLI connects the server successfully, welcome messages and version i
|
||||||
./test.sh -f tsim/db/basic1.sim
|
./test.sh -f tsim/db/basic1.sim
|
||||||
```
|
```
|
||||||
|
|
||||||
- Run the Python test script
|
## 8.2 Run the Python test script
|
||||||
|
|
||||||
Python test script includes almost all of the functions of TDengine, so some test case maybe fail cause the function only
|
Python test script includes almost all of the functions of TDengine, so some test case maybe fail cause the function only
|
||||||
work for TDengine enterprise version, you can run the script with below command:
|
work for TDengine enterprise version, you can run the script with below command:
|
||||||
|
@ -391,7 +302,7 @@ If TDengine CLI connects the server successfully, welcome messages and version i
|
||||||
python3 ./test.py -f 2-query/floor.py
|
python3 ./test.py -f 2-query/floor.py
|
||||||
```
|
```
|
||||||
|
|
||||||
- Run unittest
|
## 8.3 Run unittest
|
||||||
|
|
||||||
Unit test script is the smallest testable part and developed for some function, method or class of TDengine, you can run
|
Unit test script is the smallest testable part and developed for some function, method or class of TDengine, you can run
|
||||||
the script with below command:
|
the script with below command:
|
||||||
|
@ -401,7 +312,7 @@ If TDengine CLI connects the server successfully, welcome messages and version i
|
||||||
bash test.sh
|
bash test.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
- Smoke Testing
|
## 8.4 Smoke Testing
|
||||||
|
|
||||||
Smoke test script is known as sanity testing to ensure that the critical functionalities of TDengine, you can run the
|
Smoke test script is known as sanity testing to ensure that the critical functionalities of TDengine, you can run the
|
||||||
script with below command:
|
script with below command:
|
||||||
|
@ -411,51 +322,11 @@ If TDengine CLI connects the server successfully, welcome messages and version i
|
||||||
./test_smoking_selfhost.sh
|
./test_smoking_selfhost.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
- TSBS Test --replace
|
## Windows platform testing
|
||||||
|
|
||||||
The Time Series Benchmark Suite(TSBS) test script provides a standardized approach to evaluate the performance of various
|
|
||||||
time series databases, you can run the script with below command:
|
|
||||||
|
|
||||||
Clone the code
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd /root && git clone https://github.com/taosdata/tsbs.git && cd tsbs/scripts/tsdbComp
|
|
||||||
```
|
|
||||||
|
|
||||||
Modify IP and host of client and server in `test.ini`
|
|
||||||
```ini
|
|
||||||
clientIP="192.168.0.203" # client ip
|
|
||||||
clientHost="trd03" # client hostname
|
|
||||||
serverIP="192.168.0.204" # server ip
|
|
||||||
serverHost="trd04" # server hostname
|
|
||||||
```
|
|
||||||
|
|
||||||
Set up passwordless login between the client and server; otherwise, you'll need to configure the server password:
|
|
||||||
|
|
||||||
```ini
|
|
||||||
serverPass="taosdata123" # server root password
|
|
||||||
```
|
|
||||||
|
|
||||||
Run the following command to start the test:
|
|
||||||
```bash
|
|
||||||
nohup bash tsdbComparison.sh > test.log &
|
|
||||||
```
|
|
||||||
When the test is done, the result can be found in `/data2/` directory, which can also be configured in `test.ini`.
|
|
||||||
|
|
||||||
- Crash_gen Test
|
|
||||||
|
|
||||||
Crash_gen is a chaotic testing tool developed by TDengine, it can evaluate the resilience of TDengine through simulating
|
|
||||||
normal operation、intentional fault injection and their combination, you can run the script with below command:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd /root/TDengine/tests/pytest/ && ./crash_gen.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
Windows platform testing
|
|
||||||
|
|
||||||
to be updated...
|
to be updated...
|
||||||
|
|
||||||
MacOS platform testing
|
## MacOS platform testing
|
||||||
|
|
||||||
to be updated...
|
to be updated...
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue