Skip to content

Commit

Permalink
docs: add MAX_UPLOAD_FILE_SIZE_MB env var description (#595)
Browse files Browse the repository at this point in the history 
Co-authored-by: Alexey Shein <[email protected]>
  • Loading branch information
@conf
Alexey Shein and conf authored Apr 13, 2022
1 parent ef7773b commit c47b253
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions docs/devguide/docs/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,19 @@ during runtime with the /config endpoint, please check the API reference for mor
Below are variables Predator can be configured with.

## General
| Environment Variable | Configuration key | Description | Configurable from UI/API | Default value |
|-------------------------------------------------|---------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------- |---------------------------- |----------------------------- |
| INTERNAL_ADDRESS | internal_address | The local ip address of your machine | ✓ | |
| RUNNER_DOCKER_IMAGE | runner_docker_image | The predator-runner docker image that will run the test | ✓ | zooz/predator-runner:$LATEST_TAGGED_VERSION |
| RUNNER_CPU | runner_cpu | Number of CPU use by the each runner | ✓ | 1 |
| RUNNER_MEMORY | runner_memory | Max memory to use by each runner | ✓ | 256 |
| DEFAULT_EMAIL_ADDRESS | default_email_address | Default email to send final report to, address can be configured | ✓ | |
| ALLOW_INSECURE_TLS | allow_insecure_tls | If true, don't fail requests on unverified server certificate errors | ✓ | false |
| DELAY_RUNNER_MS | delay_runner_ms | Delay the predator runner from sending http requests (ms) | ✓ | |
| INTERVAL_CLEANUP_FINISHED_CONTAINERS_MS | interval_cleanup_finished_containers_ms | Interval (in ms) to search and delete finished tests containers. Value of 0 means no auto clearing enabled | ✓ | 0 |
| CUSTOM_RUNNER_DEFINITION | custom_runner_definition | Custom json that will be merged with the kubernetes/metronome predator runner job definition. See FAQ for usage examples. | API | |
| STREAMING_EXCLUDED_ATTRIBUTES | streaming_excluded_attributes | Attribute names to exclude from being produced in the resource to streaming platform | API | |
| Environment Variable | Configuration key | Description | Configurable from UI/API | Default value |
|-------------------------------------------------|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|---------------------------- |-----------------------------------------------|
| INTERNAL_ADDRESS | internal_address | The local ip address of your machine | ✓ | |
| RUNNER_DOCKER_IMAGE | runner_docker_image | The predator-runner docker image that will run the test | ✓ | zooz/predator-runner:$LATEST_TAGGED_VERSION |
| RUNNER_CPU | runner_cpu | Number of CPU use by the each runner | ✓ | 1 |
| RUNNER_MEMORY | runner_memory | Max memory to use by each runner | ✓ | 256 |
| DEFAULT_EMAIL_ADDRESS | default_email_address | Default email to send final report to, address can be configured | ✓ | |
| ALLOW_INSECURE_TLS | allow_insecure_tls | If true, don't fail requests on unverified server certificate errors | ✓ | false |
| DELAY_RUNNER_MS | delay_runner_ms | Delay the predator runner from sending http requests (ms) | ✓ | |
| INTERVAL_CLEANUP_FINISHED_CONTAINERS_MS | interval_cleanup_finished_containers_ms | Interval (in ms) to search and delete finished tests containers. Value of 0 means no auto clearing enabled | ✓ | 0 |
| CUSTOM_RUNNER_DEFINITION | custom_runner_definition | Custom json that will be merged with the kubernetes/metronome predator runner job definition. See FAQ for usage examples. | API | |
| STREAMING_EXCLUDED_ATTRIBUTES | streaming_excluded_attributes | Attribute names to exclude from being produced in the resource to streaming platform | API | |
| MAX_UPLOAD_FILE_SIZE_MB | | Maximum file size (in megabytes) that is allowed for uploading CSV files | | 10 |

!!! TIP "Note"
RUNNER_DOCKER_IMAGE (`zooz/predator-runner:$TAGGED_VERSION`) should match the Predator's version running in order to be fully compatible with all features.
Expand Down

0 comments on commit c47b253

Please sign in to comment.