[system test] [doc] cruise control package (strimzi#10615)

Signed-off-by: see-quick <maros.orsak159@gmail.com>
Signed-off-by: Maros Orsak <maros.orsak159@gmail.com>
Co-authored-by: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com>

development-docs/systemtests/io.strimzi.systemtest.cruisecontrol.CruiseControlApiST.md

@@ -0,0 +1,52 @@
+# CruiseControlApiST
+
+**Description:** This test suite verifies that Cruise Control's basic API requests function correctly
+
+**Before tests execution steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Deploy the cluster operator | Cluster operator is deployed |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+
+<hr style="border:1px solid">
+
+## testCruiseControlAPIUsers
+
+**Description:** This test case verifies the creation and usage of Cruise Control's API users.
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Create broker and controller KafkaNodePools | Both KafkaNodePools are successfully created |
+| 2. | Create Secret containing the `arnost: heslo, USER` in the `.key` field | Secret is correctly created |
+| 3. | Deploy Kafka with Cruise Control containing configuration for the CC API users, with reference to the Secret (and its `.key` value) created in previous step | Kafka cluster with Cruise Control are deployed, the CC API users configuration is applied |
+| 4. | Do request to Cruise Control's API, specifically to `/state` endpoint with `arnost:heslo` user | Request is successful and response contains information about state of the Cruise Control |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+
+
+## testCruiseControlBasicAPIRequestsWithSecurityDisabled
+
+**Description:** Test that verifies Cruise Control's basic API requests function correctly with security features disabled.
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Create broker and controller KafkaNodePools | Both KafkaNodePools are successfully created |
+| 2. | Disable Cruise Control security and SSL in configuration | Configuration map is set with security and SSL disabled |
+| 3. | Create required Kafka and Cruise Control resources with disabled security | Kafka and Cruise Control resources are deployed without enabling security |
+| 4. | Call the Cruise Control state endpoint using HTTP without credentials | Cruise Control state response is received with HTTP status code 200 |
+| 5. | Verify the Cruise Control state response | Response indicates Cruise Control is RUNNING with NO_TASK_IN_PROGRESS |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+

development-docs/systemtests/io.strimzi.systemtest.cruisecontrol.CruiseControlConfigurationST.md

@@ -0,0 +1,58 @@
+# CruiseControlConfigurationST
+
+**Description:** This test suite, verify configuration of the Cruise Control component.
+
+**Before tests execution steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Set up the Cluster Operator | Cluster Operator is installed and running |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+
+<hr style="border:1px solid">
+
+## testConfigurationUpdate
+
+**Description:** Test verifying configuration update for Cruise Control and ensuring Kafka Pods did not roll unnecessarily.
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Create broker and controller KafkaNodePools | Both KafkaNodePools are successfully created |
+| 2. | Create and wait for Kafka with Cruise Control | Kafka and Cruise Control are deployed successfully |
+| 3. | Take initial snapshots of Kafka and Cruise Control deployments | Snapshots of current deployments are stored |
+| 4. | Update Cruise Control configuration with new performance tuning options | Configuration update initiated |
+| 5. | Verify Cruise Control Pod rolls after configuration change | Cruise Control Pod restarts to apply new configurations |
+| 6. | Verify Kafka Pods did not roll after configuration change | Kafka Pods remain unchanged |
+| 7. | Verify new configurations are applied to Cruise Control in Kafka CR | New configurations are correctly applied |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+
+
+## testDeployAndUnDeployCruiseControl
+
+**Description:** Deploy and subsequently remove Cruise Control from Kafka cluster to verify system stability and correctness of configuration management.
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Create broker and controller KafkaNodePools | Both KafkaNodePools are successfully created |
+| 2. | Deploy Kafka with Cruise Control | Kafka cluster with Cruise Control is deployed |
+| 3. | Take a snapshot of broker pods | Snapshot of the current broker pods is taken |
+| 4. | Remove Cruise Control from Kafka | Cruise Control is removed from Kafka and configuration is updated |
+| 5. | Verify Cruise Control is removed | No Cruise Control related pods or configurations are found |
+| 6. | Create Admin client to verify Cruise Control topics | Admin client is created and Cruise Control topics are verified to exist |
+| 7. | Re-add Cruise Control to Kafka | Cruise Control is added back to Kafka |
+| 8. | Verify Cruise Control and related configurations | Cruise Control and its configurations are verified to be present |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+

development-docs/systemtests/io.strimzi.systemtest.cruisecontrol.CruiseControlST.md

@@ -0,0 +1,200 @@
+# CruiseControlST
+
+**Description:** This test suite validates the functionality and behavior of Cruise Control across multiple Kafka scenarios. It ensures correct operation under various configurations and conditions.
+
+**Before tests execution steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Deploy cluster operator with default installation | Cluster operator is deployed and running |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+
+<hr style="border:1px solid">
+
+## testAutoCreationOfCruiseControlTopicsWithResources
+
+**Description:** Test verifying the automatic creation and configuration of Cruise Control topics with resources.
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Create broker and controller KafkaNodePools | Both KafkaNodePools are successfully created |
+| 2. | Set up Kafka brokers and Cruise Control with necessary configurations | Resources are created with the desired configurations |
+| 3. | Validate Cruise Control pod's memory resource limits and JVM options | Memory limits and JVM options are correctly set on the Cruise Control pod |
+| 4. | Create a Kafka topic and an AdminClient | Kafka topic and AdminClient are successfully created |
+| 5. | Verify Cruise Control topics are present | Cruise Control topics are found present in the configuration |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+
+
+## testCruiseControlChangesFromRebalancingtoProposalReadyWhenSpecUpdated
+
+**Description:** Test that ensures Cruise Control transitions from Rebalancing to ProposalReady state when the KafkaRebalance spec is updated.
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Create broker and controller KafkaNodePools | Both KafkaNodePools are successfully created |
+| 2. | Create Kafka cluster with Cruise Control | Kafka cluster with Cruise Control is created and running |
+| 3. | Create KafkaRebalance resource | KafkaRebalance resource is created and running |
+| 4. | Wait until KafkaRebalance is in ProposalReady state | KafkaRebalance reaches ProposalReady state |
+| 5. | Annotate KafkaRebalance with 'approve' | KafkaRebalance is annotated with approval |
+| 6. | Update KafkaRebalance spec to configure replication throttle | KafkaRebalance resource's spec is updated |
+| 7. | Wait until KafkaRebalance returns to ProposalReady state | KafkaRebalance re-enters ProposalReady state following the update |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+
+
+## testCruiseControlDuringBrokerScaleUpAndDown
+
+**Description:** Testing the behavior of Cruise Control during both scaling up and down of Kafka brokers using node pools.
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Create broker and controller KafkaNodePools | Both KafkaNodePools are successfully created |
+| 2. | Create initial Kafka cluster setup with Cruise Control and topic | Kafka cluster, topic, and scraper pod are created successfully |
+| 3. | Scale Kafka up to a higher number of brokers | Kafka brokers are scaled up to the specified number of replicas |
+| 4. | Create a KafkaRebalance resource with add_brokers mode | KafkaRebalance proposal is ready and processed for adding brokers |
+| 5. | Check the topic's replicas on the new brokers | Topic has replicas on one of the newly added brokers |
+| 6. | Create a KafkaRebalance resource with remove_brokers mode | KafkaRebalance proposal is ready and processed for removing brokers |
+| 7. | Check the topic's replicas only on initial brokers | Topic replicas are only on the initial set of brokers |
+| 8. | Scale Kafka down to the initial number of brokers | Kafka brokers are scaled down to the original number of replicas |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+
+
+## testCruiseControlIntraBrokerBalancing
+
+**Description:** Test ensuring the intra-broker disk balancing with Cruise Control works as expected.
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Initialize JBOD storage configuration | JBOD storage with specific disk sizes are initialized |
+| 2. | Create Kafka broker and controller pools using the initialized storage | Kafka broker and controller pools are created and available |
+| 3. | Deploy Kafka with Cruise Control enabled | Kafka deployment with Cruise Control is successfully created |
+| 4. | Create Kafka Rebalance resource with disk rebalancing configured | Kafka Rebalance resource is created and configured for disk balancing |
+| 5. | Wait for the Kafka Rebalance to reach the ProposalReady state | Kafka Rebalance resource reaches the ProposalReady state |
+| 6. | Check the status of the Kafka Rebalance for intra-broker disk balancing | The 'provisionStatus' in the optimization result is 'UNDECIDED' |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+
+
+## testCruiseControlReplicaMovementStrategy
+
+**Description:** Test that verifies the configuration and application of custom Cruise Control replica movement strategies.
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Create broker and controller KafkaNodePools | Both KafkaNodePools are successfully created |
+| 2. | Create Kafka and Cruise Control resources | Kafka and Cruise Control resources are created and deployed |
+| 3. | Verify default Cruise Control replica movement strategy | Default replica movement strategy is verified in the configuration |
+| 4. | Update Cruise Control configuration with non-default replica movement strategies | Cruise Control configuration is updated with new strategies |
+| 5. | Ensure that Cruise Control pod is rolled due to configuration change | Cruise Control pod is rolled and new configuration is applied |
+| 6. | Verify the updated Cruise Control configuration | Updated replica movement strategies are verified in Cruise Control configuration |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+
+
+## testCruiseControlTopicExclusion
+
+**Description:** Verify that Kafka Cruise Control excludes specified topics and includes others.
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Set topic names | Topic names are set |
+| 2. | Create broker and controller KafkaNodePools | Both KafkaNodePools are successfully created |
+| 3. | Deploy Kafka with Cruise Control enabled | Kafka cluster with Cruise Control is deployed |
+| 4. | Create topics to be excluded and included | Topics 'excluded-topic-1', 'excluded-topic-2', and 'included-topic' are created |
+| 5. | Create KafkaRebalance resource excluding specific topics | KafkaRebalance resource is created with 'excluded-.*' topics pattern |
+| 6. | Wait for KafkaRebalance to reach ProposalReady state | KafkaRebalance reaches the ProposalReady state |
+| 7. | Check optimization result for excluded and included topics | Excluded topics are in the optimization result and included topic is not |
+| 8. | Approve the KafkaRebalance proposal | KafkaRebalance proposal is approved |
+| 9. | Wait for KafkaRebalance to reach Ready state | KafkaRebalance reaches the Ready state |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+
+
+## testCruiseControlWithRebalanceResourceAndRefreshAnnotation
+
+**Description:** Using Kafka cluster within a single namespace to test Cruise Control with rebalance resource and refresh annotation.
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Create broker and controller KafkaNodePools | Both KafkaNodePools are successfully created |
+| 2. | Create Kafka cluster | Kafka cluster with ephemeral storage is created and available |
+| 3. | Deploy Kafka Rebalance resource | Kafka Rebalance resource is deployed and in NotReady state |
+| 4. | Enable Cruise Control with optimized configuration | Cruise Control is enabled and configured |
+| 5. | Perform rolling update on broker pods | All broker pods have rolled successfully |
+| 6. | Execute rebalance process | Rebalancing process executed successfully |
+| 7. | Annotate Kafka Rebalance resource with 'refresh' | Kafka Rebalance resource is annotated with 'refresh' and reaches ProposalReady state |
+| 8. | Execute rebalance process again | Rebalancing process re-executed successfully |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+
+
+## testCruiseControlWithSingleNodeKafka
+
+**Description:** Test verifying that Cruise Control cannot be deployed with a Kafka cluster that has only one broker and ensuring that increasing the broker count resolves the configuration error.
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Set up the error message | Error message is set |
+| 2. | Create broker and controller KafkaNodePools | Both KafkaNodePools are successfully created |
+| 3. | Deploy single-node Kafka with Cruise Control | Kafka and Cruise Control deployment initiated |
+| 4. | Verify that the Kafka status contains the error message related to single-node configuration | Error message confirmed in Kafka status |
+| 5. | Increase the Kafka nodes to 3 | Kafka node count increased to 3 |
+| 6. | Check that the Kafka status no longer contains the single-node error message | Error message resolved |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+
+
+## testKafkaRebalanceAutoApprovalMechanism
+
+**Description:** Test the Kafka Rebalance auto-approval mechanism.
+
+**Steps:**
+
+| Step | Action | Result |
+| - | - | - |
+| 1. | Create broker and controller KafkaNodePools | Both KafkaNodePools are successfully created |
+| 2. | Deploy Kafka cluster with Cruise Control | Kafka cluster with Cruise Control is deployed |
+| 3. | Create KafkaRebalance resource with auto-approval enabled | KafkaRebalance resource with auto-approval is created |
+| 4. | Perform re-balancing process with auto-approval | Re-balancing process completes successfully with auto-approval |
+
+**Labels:**
+
+* [cruise-control](labels/cruise-control.md)
+

development-docs/systemtests/labels/cruise-control.md

@@ -0,0 +1,24 @@
+# **Cruise Control**
+
+## Description
+
+These tests validate the Cruise Control component within the Strimzi ecosystem, ensuring efficient resource utilization and cluster balancing for Kafka clusters. 
+Cruise Control provides automated workload balancing and optimization, enabling better performance and resilience in Kafka deployments. 
+These tests cover scenarios such as configuration changes, resource scaling, security settings, and integration with Kafka Rebalance operations. 
+Ensuring the correctness of Cruise Control behavior under different configurations and workloads is critical for maintaining optimal cluster performance and reliability.
+
+<!-- generated part -->
+**Tests:**
+- [testAutoCreationOfCruiseControlTopicsWithResources](../io.strimzi.systemtest.cruisecontrol.CruiseControlST.md)
+- [testConfigurationUpdate](../io.strimzi.systemtest.cruisecontrol.CruiseControlConfigurationST.md)
+- [testCruiseControlWithSingleNodeKafka](../io.strimzi.systemtest.cruisecontrol.CruiseControlST.md)
+- [testKafkaRebalanceAutoApprovalMechanism](../io.strimzi.systemtest.cruisecontrol.CruiseControlST.md)
+- [testCruiseControlDuringBrokerScaleUpAndDown](../io.strimzi.systemtest.cruisecontrol.CruiseControlST.md)
+- [testCruiseControlWithRebalanceResourceAndRefreshAnnotation](../io.strimzi.systemtest.cruisecontrol.CruiseControlST.md)
+- [testCruiseControlAPIUsers](../io.strimzi.systemtest.cruisecontrol.CruiseControlApiST.md)
+- [testCruiseControlChangesFromRebalancingtoProposalReadyWhenSpecUpdated](../io.strimzi.systemtest.cruisecontrol.CruiseControlST.md)
+- [testCruiseControlIntraBrokerBalancing](../io.strimzi.systemtest.cruisecontrol.CruiseControlST.md)
+- [testDeployAndUnDeployCruiseControl](../io.strimzi.systemtest.cruisecontrol.CruiseControlConfigurationST.md)
+- [testCruiseControlReplicaMovementStrategy](../io.strimzi.systemtest.cruisecontrol.CruiseControlST.md)
+- [testCruiseControlBasicAPIRequestsWithSecurityDisabled](../io.strimzi.systemtest.cruisecontrol.CruiseControlApiST.md)
+- [testCruiseControlTopicExclusion](../io.strimzi.systemtest.cruisecontrol.CruiseControlST.md)