diff --git a/tests/python_client/deploy/README.md b/tests/python_client/deploy/README.md index f98b0dcc28..5b34c1a972 100644 --- a/tests/python_client/deploy/README.md +++ b/tests/python_client/deploy/README.md @@ -1,6 +1,6 @@ -## overview +## Overview To test deployment by docker-compose(Both standalone and cluster) * re-install milvus to check data persistence @@ -19,7 +19,7 @@ To test deployment by docker-compose(Both standalone and cluster) 6. Build index 7. Search -## project structure +## Project structure ``` . ├── README.md @@ -38,7 +38,7 @@ To test deployment by docker-compose(Both standalone and cluster) └── run.sh # script to run all tasks ``` -## usage +## 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. @@ -55,4 +55,13 @@ run all tasks ```bash $ bash run.sh -p ${Password} # Password, the password of root" -```` \ No newline at end of file +``` + +## 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 +- [ ] Support helm deployment tests +- [ ] Cover more detail information in email notification