From 690a360439e2e373b32d72ac07a13b1d6a9ddf8d Mon Sep 17 00:00:00 2001 From: zhuwenxing Date: Thu, 16 Sep 2021 18:07:49 +0800 Subject: [PATCH] [skpi ci] Add how to contribute in chaos README (#8096) Signed-off-by: zhuwenxing --- tests/python_client/chaos/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/tests/python_client/chaos/README.md b/tests/python_client/chaos/README.md index 11cccd9bc9..1c7da5abec 100644 --- a/tests/python_client/chaos/README.md +++ b/tests/python_client/chaos/README.md @@ -63,4 +63,12 @@ still in planning ### Todo * pod_failure * container_kill -* network attack \ No newline at end of file +* network attack + +## How to contribute +* Get familiar with chaos engineering and [Chaos Mesh](https://chaos-mesh.org) +* Design chaos scenarios, preferring to pick from todo list +* Generate yaml file for your chaos scenarios. You can create a chaos experiment in chaos-dashboard, then download the yaml file of it. +* Add yaml file to chaos_objects dir and rename it as `chaos_${component_name}_${chaos_type}.yaml`. Make sure `kubectl apply -f ${your_chaos_yaml_file}` can take effect +* Add testcase in `testcases.yaml`. You should figure out the expectation of milvus during the chaos +* Run your added testcase according to `Manually` above and check whether it as your expectation \ No newline at end of file