To allow control of its behavior, Artemis works with a concept of "knobs". A knob is a named value that affects Artemis in some way, and it is possible to change the value by a maintainer. Value of each knob is provided by two or more sources:
artemis-cli knob
command.Knob | Cast | Environment variable | Default | Editable? |
---|---|---|---|---|
actor.default-max-backoff | int | ARTEMIS_ACTOR_DEFAULT_MAX_BACKOFF | 60 | no |
The biggest possible delay, in seconds, before the next attempt to run a failed task. | ||||
actor.default-min-backoff | int | ARTEMIS_ACTOR_DEFAULT_MIN_BACKOFF | 15 | no |
The lowest possible delay, in seconds, before the next attempt to run a failed task. | ||||
actor.default-priority | cast_priority | ARTEMIS_ACTOR_DEFAULT_PRIORITY | DEFAULT | no |
Task priority ("HIGH", "DEFAULT", "LOW" or any positive integer). | ||||
actor.default-queue | cast_queue | ARTEMIS_ACTOR_DEFAULT_QUEUE | default | no |
Task queue ("default", "periodic", "pool-data-refresh" or any other string). | ||||
actor.default-retries-count | int | ARTEMIS_ACTOR_DEFAULT_RETRIES | 5 | no |
A number of time a failing task get retried. Serves as a default value for tasks without custom setting. | ||||
actor.default-singleton-deadline | int | ARTEMIS_ACTOR_DEFAULT_SINGLETON_DEADLINE | 300 | no |
The biggest possible deadline for a singleton task, in seconds. | ||||
actor.delay-uniform-spread | int | ARTEMIS_ACTOR_DELAY_UNIFORM_SPREAD | 5 | no |
A range, in seconds, by which can a task delay be modified before use. | ||||
actor.dispatch-preparing.delay | int | ARTEMIS_ACTOR_DISPATCH_PREPARE_DELAY | 60 | no |
A delay, in second, between successful acquire of a cloud instance and dispatching of post-acquire preparation tasks. | ||||
actor.guest-request-watchdog.dispatch.delay | int | ARTEMIS_ACTOR_GUEST_REQUEST_WATCHDOG_DISPATCH_DELAY | 600 | yes |
actor.guest-request-watchdog.dispatch.delay:$entityname | ARTEMIS_ACTOR_GUEST_REQUEST_WATCHDOG_DISPATCH_DELAY_$entityname | |||
A delay, in seconds, between successful provisioning and dispatching of guest request watchdog tasks. | ||||
actor.guest-request-watchdog.dispatch.period | int | ARTEMIS_ACTOR_GUEST_REQUEST_WATCHDOG_DISPATCH_PERIOD | 3600 | yes |
actor.guest-request-watchdog.dispatch.period:$entityname | ARTEMIS_ACTOR_GUEST_REQUEST_WATCHDOG_DISPATCH_PERIOD_$entityname | |||
A delay, in seconds, after which new guest request watchdog task is scheduled. | ||||
actor.kickstart-wait.initial-delay | int | ARTEMIS_PREPARE_KICKSTART_WAIT_INITIAL_DELAY | 300 | yes |
actor.kickstart-wait.initial-delay:$entityname | ARTEMIS_PREPARE_KICKSTART_WAIT_INITIAL_DELAY_$entityname | |||
Delay before attempting to check the kickstart installation completion. | ||||
actor.kickstart-wait.retry-delay | int | ARTEMIS_PREPARE_KICKSTART_WAIT_RETRY_DELAY | 120 | yes |
actor.kickstart-wait.retry-delay:$entityname | ARTEMIS_PREPARE_KICKSTART_WAIT_RETRY_DELAY_$entityname | |||
Delay between kickstart installation completion checks. | ||||
actor.kickstart.boot-installer-script-filepath | str | ARTEMIS_PREPARE_KICKSTART_BOOT_INSTALLER_SCRIPT_FILEPATH | artemis-kickstart-kexec.sh | no |
Script to prepare and boot the installer image. | ||||
actor.kickstart.compose-repo-mapping | str | ARTEMIS_PREPARE_KICKSTART_COMPOSE_REPO_MAPPING_FILEPATH | artemis-kickstart-compose-repo-map.yaml | no |
Map of compose names to source repo name for installation. | ||||
actor.kickstart.ssh-timeout | int | ARTEMIS_PREPARE_KICKSTART_SSH_TIMEOUT | 15 | yes |
actor.kickstart.ssh-timeout:$entityname | ARTEMIS_PREPARE_KICKSTART_SSH_TIMEOUT_$entityname | |||
Kickstart installation SSH connection timeout. | ||||
actor.kickstart.template | str | ARTEMIS_PREPARE_KICKSTART_TEMPLATE_FILEPATH | artemis-kickstart.ks.j2 | no |
Kickstart config template path. | ||||
actor.offload-tasks | bool | ARTEMIS_OFFLOAD_TASKS | yes | no |
When enabled, tasks will run in their own threads. | ||||
actor.refresh-pool-avoid-groups-hostnames.schedule | str | ARTEMIS_ACTOR_REFRESH_POOL_AVOID_GROUPS_HOSTNAMES_SCHEDULE | */5 * * * * | no |
When to run refresh of Beaker avoid groups hostnames, as a Cron-like specification. | ||||
actor.refresh-pool-flavor-info.schedule | str | ARTEMIS_ACTOR_REFRESH_POOL_FLAVOR_INFO_SCHEDULE | */5 * * * * | no |
When to run OpenStack flavor info refresh task, as a Cron-like specification. | ||||
actor.refresh-pool-image-info.schedule | str | ARTEMIS_ACTOR_REFRESH_POOL_IMAGE_INFO_SCHEDULE | */5 * * * * | no |
When to run pool image info refresh task, as a Cron-like specification. | ||||
actor.refresh-pool-resources-metrics.schedule | str | ARTEMIS_ACTOR_REFRESH_POOL_RESOURCES_METRICS_SCHEDULE | * * * * * | no |
When to run pool image info refresh task, as a Cron-like specification. | ||||
actor.shelved-guest-watchdog.connect-timeout | int | ARTEMIS_SHELVED_GUEST_WATCHDOG_SSH_CONNECT_TIMEOUT | 15 | yes |
actor.shelved-guest-watchdog.connect-timeout:$entityname | ARTEMIS_SHELVED_GUEST_WATCHDOG_SSH_CONNECT_TIMEOUT_$entityname | |||
Shelved guest watchdog SSH connection timeout. | ||||
actor.shelved-guest-watchdog.dispatch.delay | int | ARTEMIS_ACTOR_SHELVED_GUEST_WATCHDOG_DISPATCH_PERIOD | 600 | no |
A delay, in seconds, between watchdog runs. | ||||
actor.verify-ssh.connect-timeout | int | ARTEMIS_PREPARE_VERIFY_SSH_CONNECT_TIMEOUT | 15 | yes |
actor.verify-ssh.connect-timeout:$entityname | ARTEMIS_PREPARE_VERIFY_SSH_CONNECT_TIMEOUT_$entityname | |||
Prepare stage SSH timeout. | ||||
actor.worker-ping.schedule | str | ARTEMIS_ACTOR_WORKER_PING_SCHEDULE | */5 * * * * | no |
When to run worker ping task, as a Cron-like specification. | ||||
api.enable-authentication | bool | ARTEMIS_ENABLE_AUTHENTICATION | no | no |
If enabled, API requests must pass authentication by providing proper username and token. | ||||
api.enable-authorization | bool | ARTEMIS_ENABLE_AUTHORIZATION | no | no |
If enabled, API requests must pass authorization by providing username with privileges high enough for the requested action. | ||||
api.engine.debug | bool | ARTEMIS_API_ENGINE_DEBUG | no | no |
Run engine with a debugging enabled. | ||||
api.engine.reload-on-change | bool | ARTEMIS_API_ENGINE_RELOAD_ON_CHANGE | no | no |
Reload API server when its code changes. | ||||
api.engine.reload.request-limit | int | ARTEMIS_API_ENGINE_RELOAD_REQUESTS_LIMIT | 0 | no |
Reload a worker process after serving this number of requests. | ||||
api.engine.reload.request-limit.spread | int | ARTEMIS_API_ENGINE_RELOAD_REQUESTS_LIMIT_SPREAD | 0 | no |
A range by which is number of requests randomized. | ||||
api.processes | int | ARTEMIS_API_PROCESSES | 1 | no |
Number of processes to spawn for servicing API requests. | ||||
api.profiling.enabled | bool | ARTEMIS_API_ENABLE_PROFILING | no | no |
If enabled, API server will profile handling of each request, emitting a summary into log. | ||||
api.profiling.limit | int | ARTEMIS_API_PROFILING_LIMIT | 20 | no |
How many functions should be included in the summary. | ||||
api.threads | int | ARTEMIS_API_THREADS | 1 | no |
Number of threads to spawn in each process for servicing API requests. | ||||
aws.logs.console.dump.blob.update-tick | int | ARTEMIS_AWS_LOGS_CONSOLE_LATEST_BLOB_UPDATE_TICK | 300 | no |
How long, in seconds, to take between updating guest console log. | ||||
aws.logs.console.interactive.url | str | ARTEMIS_AWS_LOGS_CONSOLE_INTERACTIVE_URL | https://console.aws.amazon.com/ec2/v2/connect/ec2-user/{instance_id}?connection-type=isc&serial-port=0 | no |
Templated URL of serial console of an AWS EC2 instance. | ||||
aws.mapping.environment-to-image.pattern-map.filepath | str | ARTEMIS_AWS_ENVIRONMENT_TO_IMAGE_MAPPING_FILEPATH | artemis-image-map-aws.yaml | no |
aws.mapping.environment-to-image.pattern-map.filepath:$entityname | ARTEMIS_AWS_ENVIRONMENT_TO_IMAGE_MAPPING_FILEPATH_$entityname | |||
Path to a pattern map file with environment to image mapping. | ||||
aws.mapping.environment-to-image.pattern-map.needle | str | ARTEMIS_AWS_ENVIRONMENT_TO_IMAGE_MAPPING_NEEDLE | {{ os.compose }} | no |
aws.mapping.environment-to-image.pattern-map.needle:$entityname | ARTEMIS_AWS_ENVIRONMENT_TO_IMAGE_MAPPING_NEEDLE_$entityname | |||
A pattern for needle to match in environment to image mapping file. | ||||
aws.mapping.guest-security-group-name.template | str | ARTEMIS_AWS_GUEST_SECURITY_GROUP_NAME_TEMPLATE | {{ TAGS.ArtemisGuestLabel }}-{{ GUESTNAME }} | no |
aws.mapping.guest-security-group-name.template:$entityname | ARTEMIS_AWS_GUEST_SECURITY_GROUP_NAME_TEMPLATE_$entityname | |||
A pattern for guest security group name. | ||||
aws.pending-timeout | int | ARTEMIS_AWS_PENDING_TIMEOUT | 600 | no |
How long, in seconds, is an instance allowed to stay in pending state until cancelled and reprovisioned. | ||||
aws.remove-security-group.delay | int | ARTEMIS_AWS_REMOVE_SECURITY_GROUP_DELAY | 150 | no |
A delay, in seconds, between scheduling the guest security group clean up task in aws and actual attempt to clean up the resource. | ||||
aws.spot-open-timeout | int | ARTEMIS_AWS_SPOT_OPEN_TIMEOUT | 60 | no |
How long, in seconds, is an spot instance request allowed to stay in open state
until cancelled and reprovisioned. | ||||
azure.logs.console.dump.blob.update-tick | int | ARTEMIS_AZURE_LOGS_CONSOLE_LATEST_BLOB_UPDATE_TICK | 300 | no |
How long, in seconds, to take between updating guest console log. | ||||
azure.mapping.environment-to-image.pattern-map.filepath | str | ARTEMIS_AZURE_ENVIRONMENT_TO_IMAGE_MAPPING_FILEPATH | artemis-image-map-azure.yaml | no |
azure.mapping.environment-to-image.pattern-map.filepath:$entityname | ARTEMIS_AZURE_ENVIRONMENT_TO_IMAGE_MAPPING_FILEPATH_$entityname | |||
Path to a pattern map file with environment to image mapping. | ||||
azure.mapping.environment-to-image.pattern-map.needle | str | ARTEMIS_AZURE_ENVIRONMENT_TO_IMAGE_MAPPING_NEEDLE | {{ os.compose }} | no |
azure.mapping.environment-to-image.pattern-map.needle:$entityname | ARTEMIS_AZURE_ENVIRONMENT_TO_IMAGE_MAPPING_NEEDLE_$entityname | |||
A pattern for needle to match in environment to image mapping file. | ||||
azure.mapping.resource-group-name.template | str | ARTEMIS_AZURE_RESOURCE_GROUP_NAME_TEMPLATE | {{ TAGS.ArtemisGuestLabel }}-{{ GUESTNAME }} | no |
azure.mapping.resource-group-name.template:$entityname | ARTEMIS_AZURE_RESOURCE_GROUP_NAME_TEMPLATE_$entityname | |||
A pattern for guest resource group name | ||||
beaker.guest-watchdog.ssh.connect-timeout | int | ARTEMIS_BEAKER_GUEST_WATCHDOG_SSH_CONNECT_TIMEOUT | 15 | yes |
beaker.guest-watchdog.ssh.connect-timeout:$entityname | ARTEMIS_BEAKER_GUEST_WATCHDOG_SSH_CONNECT_TIMEOUT_$entityname | |||
Guest watchdog SSH timeout. | ||||
beaker.job.whiteboard.template | str | ARTEMIS_BEAKER_JOB_WHITEBOARD_TEMPLATE | [artemis] [{{ DEPLOYMENT }}] {{ GUESTNAME }} | no |
beaker.job.whiteboard.template:$entityname | ARTEMIS_BEAKER_JOB_WHITEBOARD_TEMPLATE_$entityname | |||
A template for Beaker job whiteboard. | ||||
beaker.mapping.environment-to-image.pattern | str | ARTEMIS_BEAKER_ENVIRONMENT_TO_IMAGE_MAPPING_PATTERN | (?P<distro>[;]+)(?:;variant=(?P<variant>[a-zA-Z]+);?)?$ | no |
beaker.mapping.environment-to-image.pattern:$entityname | ARTEMIS_BEAKER_ENVIRONMENT_TO_IMAGE_MAPPING_PATTERN_$entityname | |||
A pattern for extracting distro and other components from the right side of the image mapping file. | ||||
beaker.mapping.environment-to-image.pattern-map.filepath | str | ARTEMIS_BEAKER_ENVIRONMENT_TO_IMAGE_MAPPING_FILEPATH | artemis-image-map-beaker.yaml | no |
beaker.mapping.environment-to-image.pattern-map.filepath:$entityname | ARTEMIS_BEAKER_ENVIRONMENT_TO_IMAGE_MAPPING_FILEPATH_$entityname | |||
Path to a pattern map file with environment to image mapping. | ||||
beaker.mapping.environment-to-image.pattern-map.needle | str | ARTEMIS_BEAKER_ENVIRONMENT_TO_IMAGE_MAPPING_NEEDLE | {{ os.compose }} | no |
beaker.mapping.environment-to-image.pattern-map.needle:$entityname | ARTEMIS_BEAKER_ENVIRONMENT_TO_IMAGE_MAPPING_NEEDLE_$entityname | |||
A pattern for needle to match in environment to image mapping file. | ||||
beaker.reservation.duration | int | ARTEMIS_BEAKER_RESERVATION_DURATION | 86400 | no |
A time, in seconds, for which the guest would be initially reserved. | ||||
beaker.reservation.extension.command-template | str | ARTEMIS_BEAKER_RESERVATION_EXTENSION_COMMAND_TEMPLATE | `echo {{ (EXTENSION_TIME / 3600) | int }} |