From 0f74167126e0fb4e3df21626b407749703419f17 Mon Sep 17 00:00:00 2001 From: suigh Date: Mon, 1 Nov 2021 21:51:08 +0800 Subject: [PATCH] add doc for scalability test (#45) Signed-off-by: suigh --- CONTRIBUTING.md | 9 +++++++++ test/scalability/README.md | 15 +++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 test/scalability/README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 00e0ff6e5..f9f1fdbc5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,6 +72,15 @@ kind load docker-image quay.io/open-cluster-management/placement:latest --name { make test-e2e ``` +Run scalability testing if your PR has impact on the scalability + +```shell +Deploy the placement controller with corresponding steps from [PLACEMENT Doc](https://github.com/open-cluster-management-io/placement#deploy-the-placement-controller) + + +make test-scalability +``` + ## Build images Make sure your code build passed. diff --git a/test/scalability/README.md b/test/scalability/README.md new file mode 100644 index 000000000..64bec493e --- /dev/null +++ b/test/scalability/README.md @@ -0,0 +1,15 @@ +# Scalability test + +## Motivation + +Add test cases for scalability, help developers to measure the impact of their fixes on scalability. + +## Design Details + +### Create a placement with many managedclusters + +This test case is used to check whether a placement with many managedclusters can be created within expected time or not. One placement with many managedclusters will be created, and there will be enough candidate managedclusters to ensure there will be competing among these candidates. + +### Create/update many placements with many managedclusters + +This test case is used to check whether many placements, each with many managedclusters, can be created/updated within expected time or not. Placements with many managedclusters will be created first to check time cost for creating, and then the count of managedclusters will be updated to update the placements, this is used to check the time cost for updating.