document acceptance test a bit

cloudfoundry · Mar 22, 2024 · 7a1c758 · 7a1c758
1 parent 459641b
commit 7a1c758
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/src/acceptance/app/dynamic_policy_test.go b/src/acceptance/app/dynamic_policy_test.go
@@ -266,12 +266,13 @@ var _ = Describe("AutoScaler dynamic policy", func() {
 			// and the CPU entitlements per share configured in ci/operations/set-cpu-entitlement-per-share.yaml.
 			// if any of these dependencies change, the test may need some adjustments as well.
 			//
-			// diego cell = 8 CPU 32GB RAM
-			// total shares = 1024 * 32[gb host ram] / 8[upper limit of app memory] = 4096
-			// CPU entitlement per share = 8[number host CPUs] * 100/ 4096[total shares] = 0,1953
-			// CPU entitlement = 4096[total shares] / (32[gb host ram] * 1024) * (1[app memory in GB] * 1024) * 0,1953 ~= 25%
+			// the following shows the calculations this test is based on:
+			//   - diego cell = 8 CPU 32GB RAM
+			//   - total shares = 1024 * 32[gb host ram] / 8[upper limit of app memory] = 4096
+			//   - CPU entitlement per share = 8[number host CPUs] * 100/ 4096[total shares] = 0,1953
+			//   - CPU entitlement = 4096[total shares] / (32[gb host ram] * 1024) * (1[app memory in GB] * 1024) * 0,1953 ~= 25%
 			//
-			// 1GB app memory results in a maximum cpu entitlement of 25%.
+			// in a nutshell: 1GB app memory results in a maximum cpu entitlement of 25%,
 			// this means that cpuutil will be 100% if app cpu is at 25%.
 
 			SetAppMemory(cfg, appName, "1GB")