Skip to content

Commit

Permalink
[ST] Env configuration of execution
Browse files Browse the repository at this point in the history 
Signed-off-by: David Kornel <kornys@outlook.com>
  • Loading branch information
@kornys
kornys committed Feb 13, 2024
1 parent dbcb208 commit bed2674
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 63 deletions.
66 changes: 37 additions & 29 deletions development-docs/TESTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -308,35 +308,43 @@ ST_CONFIG_PATH="path/to/config/file/config.yaml" mvn verify ...

All environment variables are defined in [Environment](systemtest/src/main/java/io/strimzi/systemtest/Environment.java) class:

| Name | Description | Default |
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------|
| DOCKER_ORG | Specify the organization/repo containing the image used in system tests | strimzi |
| DOCKER_TAG | Specify the image tags used in system tests | latest |
| DOCKER_REGISTRY | Specify the docker registry used in system tests | quay.io |
| BRIDGE_IMAGE | Specify the Kafka bridge image used in system tests | quay.io/strimzi/kafka-bridge:latest |
| TEST_LOG_DIR | Directory for storing logs collected during the tests | ../systemtest/target/logs/ |
| ST_KAFKA_VERSION | Kafka version used in images during the system tests | 2.3.0 |
| ST_CONFIG_PATH | Path to file where environment variables are defined in yaml format | ../systemtest/config.yaml |
| STRIMZI_LOG_LEVEL | Log level for the cluster operator | DEBUG |
| STRIMZI_COMPONENTS_LOG_LEVEL | Log level for the components | INFO |
| KUBERNETES_DOMAIN | Cluster domain | .nip.io |
| TEST_CLUSTER_CONTEXT | context which will be used to reach the cluster* | currently active Kubernetes context |
| TEST_CLUSTER_USER | Default user which will be used for command-line admin operations | developer |
| SKIP_TEARDOWN | Variable for skip teardown phase for more debug if needed | false |
| OPERATOR_IMAGE_PULL_POLICY | Image Pull Policy for Operator image | Always |
| COMPONENTS_IMAGE_PULL_POLICY | Image Pull Policy for Kafka, Bridge, etc. | IfNotPresent |
| STRIMZI_TEST_LOG_LEVEL | Log level for system tests | INFO |
| STRIMZI_TEST_ROOT_LOG_LEVEL | Root Log level for system tests | DEBUG |
| STRIMZI_RBAC_SCOPE | Set to 'CLUSTER' or 'NAMESPACE' to deploy the operator with ClusterRole or Roles, respectively | cluster |
| OLM_OPERATOR_NAME | Operator name in manifests CSV | strimzi |
| OLM_SOURCE_NAME | CatalogSource name which contains desired operator | strimzi-source |
| OLM_APP_BUNDLE_PREFIX | CSV bundle name | strimzi |
| OLM_OPERATOR_VERSION | Version of the operator which will be installed | v0.16.2 |
| DEFAULT_TO_DENY_NETWORK_POLICIES | Determines how will be network policies set - to deny-all (true) or allow-all (false) | true |
| STRIMZI_EXEC_MAX_LOG_OUTPUT_CHARACTERS | Set maximum count of characters printed from [Executor](test/src/main/java/io/strimzi/test/executor/Exec.java) stdout and stderr | 20000 |
| CLUSTER_OPERATOR_INSTALL_TYPE | Specify how the CO will be deployed. `OLM` option will install operator via OLM, and you just need to set other `OLM` env variables. | bundle |
| CONNECT_BUILD_IMAGE_PATH | Specify the registry together with org used by KafkaConnect build. For example `quay.io/strimzi/custom-connect-build` | empty |
| CONNECT_BUILD_REGISTRY_SECRET | Specify the registry secret used by KafkaConnect build. It has to be k8s secret deployed in `default` namespace and systemtests will handle the rest. | empty |
| Name | Description | Default |
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------|
| DOCKER_ORG | Specify the organization/repo containing the image used in system tests | strimzi |
| DOCKER_TAG | Specify the image tags used in system tests | latest |
| DOCKER_REGISTRY | Specify the docker registry used in system tests | quay.io |
| BRIDGE_IMAGE | Specify the Kafka bridge image used in system tests | quay.io/strimzi/kafka-bridge:latest |
| TEST_LOG_DIR | Directory for storing logs collected during the tests | ../systemtest/target/logs/ |
| ST_KAFKA_VERSION | Kafka version used in images during the system tests | 3.6.0 |
| ST_CONFIG_PATH | Path to file where environment variables are defined in yaml format | ../systemtest/config.yaml |
| STRIMZI_FEATURE_GATES | Strimzi feature gates | empty |
| STRIMZI_LOG_LEVEL | Log level for the cluster operator | DEBUG |
| STRIMZI_COMPONENTS_LOG_LEVEL | Log level for the components | INFO |
| STRIMZI_USE_KRAFT_IN_TESTS | Enable kraft mode | false |
| KUBERNETES_DOMAIN | Cluster domain | .nip.io |
| TEST_CLUSTER_CONTEXT | context which will be used to reach the cluster* | currently active Kubernetes context |
| TEST_CLUSTER_USER | Default user which will be used for command-line admin operations | developer |
| TEST_CLIENTS_IMAGE | Image with strimzi test clients | quay.io/strimzi-test-clients/test-clients:0.6.0-kafka-3.6.0 |
| TEST_CLIENTS_VERSION | Version of strimzi test clients | 0.6.0 |
| SCRAPER_IMAGE_ENV | Scraper image | quay.io/strimzi/kafka:latest-kafka-3.6.1 |
| SKIP_TEARDOWN | Variable for skip teardown phase for more debug if needed | false |
| OPERATOR_IMAGE_PULL_POLICY | Image Pull Policy for Operator image | Always |
| COMPONENTS_IMAGE_PULL_POLICY | Image Pull Policy for Kafka, Bridge, etc. | IfNotPresent |
| SYSTEM_TEST_STRIMZI_IMAGE_PULL_SECRET | Image pull secret | "" |
| STRIMZI_TEST_LOG_LEVEL | Log level for system tests | INFO |
| STRIMZI_TEST_ROOT_LOG_LEVEL | Root Log level for system tests | DEBUG |
| STRIMZI_RBAC_SCOPE | Set to 'CLUSTER' or 'NAMESPACE' to deploy the operator with ClusterRole or Roles, respectively | cluster |
| OLM_OPERATOR_NAME | Operator name in manifests CSV | strimzi |
| OLM_SOURCE_NAME | CatalogSource name which contains desired operator | strimzi-source |
| OLM_APP_BUNDLE_PREFIX | CSV bundle name | strimzi |
| OLM_OPERATOR_VERSION | Version of the operator which will be installed | v0.16.2 |
| DEFAULT_TO_DENY_NETWORK_POLICIES | Determines how will be network policies set - to deny-all (true) or allow-all (false) | true |
| STRIMZI_EXEC_MAX_LOG_OUTPUT_CHARACTERS | Set maximum count of characters printed from [Executor](test/src/main/java/io/strimzi/test/executor/Exec.java) stdout and stderr | 20000 |
| RESOURCE_ALLOCATION_STRATEGY | Set memory allocation for strimzi pod set | SHARE_MEMORY_FOR_ALL_COMPONENTS |
| CLUSTER_OPERATOR_INSTALL_TYPE | Specify how the CO will be deployed. `OLM` option will install operator via OLM, and you just need to set other `OLM` env variables. | bundle |
| CONNECT_BUILD_IMAGE_PATH | Specify the registry together with org used by KafkaConnect build. For example `quay.io/strimzi/custom-connect-build` | empty |
| CONNECT_BUILD_REGISTRY_SECRET | Specify the registry secret used by KafkaConnect build. It has to be k8s secret deployed in `default` namespace and systemtests will handle the rest. | empty |
| CONNECT_IMAGE_WITH_FILE_SINK_PLUGIN | Connect image | empty |

If you want to use your images with a different tag or from a separate repository, you can use `DOCKER_REGISTRY`, `DOCKER_ORG` and `DOCKER_TAG` environment variables.

Expand Down

0 comments on commit bed2674

Please sign in to comment.