milvus/tests/python_client/deploy/README.md
yanliang567 fcbd3a7b13
[skip e2e]Update test description (#14845)
Signed-off-by: yanliang567 <yanliang.qiao@zilliz.com>
2022-01-05 14:33:25 +08:00

68 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## Overview
To test deployment by docker-compose(Both standalone and cluster)
* re-install milvus to check data persistence
1. Deploy Milvus
2. Insert data
3. Build index
4. Search
5. Stop Milvus
6. Repeat from step #1
* upgrade milvus to check data compatibility
1. Deploy Milvus (Previous Release)
2. Insert data
3. Search
4. Stop Milvus
5. Deploy Milvus (Latest Release/Build)
6. Build index
7. Search
## Project structure
```
.
├── README.md
├── cluster # dir to deploy cluster
│ ├── logs # dir to save logs
│ └──docker-compose.yml
├── standalone # dir to deploy standalone
│ ├── logs # dir to save logs
│ └──docker-compose.yml
├── scripts
│ ├── action_after_upgrade.py
│ ├── action_before_upgrade.py
│ ├── action_reinstall.py
│ └── utils.py
├── cluster-values.yaml # config for helm deployment
├── test.sh # script to run a single task
└── run.sh # script to run all tasks
```
## Usage
Make sure you have installed `docker`,`docker-compose` and `pymilvus`!
For different version, you should modify the value of `latest_tag`, `latest_rc_tag` and `Release`. Password of root is needed for deleting volumes dir.
single test task
```bash
$ bash test.sh -m ${Mode} -t ${Task} -p ${Password}
# Mode, the mode of milvus deploy. standalone or cluster"
# Task, the task type of test. reinstall or upgrade
# Password, the password of root"
```
run all tasks
```bash
$ bash run.sh -p ${Password}
# Password, the password of root"
```
## Integrate deploy test into CI
Provides a way to periodically run docker-compose deployment tests through GitHub action[deploy-test](https://github.com/milvus-io/milvus/blob/master/.github/workflows/deploy-test.yaml)
- [x] Parallel testing for four deployment scenarios
- [x] Upload logs to artifacts for further debug
- [x] Email notification for test failure
- [x] Support helm deployment tests
- [x] Cover more detail information in email notification