Knobs

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:

  1. (optional) the database. Can be changed in runtine with artemis-cli knob command.
  2. the environment variable. Cannot be changed in runtime, only when components starts.
  3. the default value. Cannot be changed because it is part of the source code.
KnobCastEnvironment variableDefaultEditable?
actor.default-max-backoffintARTEMIS_ACTOR_DEFAULT_MAX_BACKOFF60no
The biggest possible delay, in seconds, before the next attempt to run a failed task.
actor.default-min-backoffintARTEMIS_ACTOR_DEFAULT_MIN_BACKOFF15no
The lowest possible delay, in seconds, before the next attempt to run a failed task.
actor.default-prioritycast_priorityARTEMIS_ACTOR_DEFAULT_PRIORITYDEFAULTno
Task priority ("HIGH", "DEFAULT", "LOW" or any positive integer).
actor.default-queuecast_queueARTEMIS_ACTOR_DEFAULT_QUEUEdefaultno
Task queue ("default", "periodic", "pool-data-refresh" or any other string).
actor.default-retries-countintARTEMIS_ACTOR_DEFAULT_RETRIES5no
A number of time a failing task get retried. Serves as a default value for tasks without custom setting.
actor.default-singleton-deadlineintARTEMIS_ACTOR_DEFAULT_SINGLETON_DEADLINE300no
The biggest possible deadline for a singleton task, in seconds.
actor.delay-uniform-spreadintARTEMIS_ACTOR_DELAY_UNIFORM_SPREAD5no
A range, in seconds, by which can a task delay be modified before use.
actor.dispatch-preparing.delayintARTEMIS_ACTOR_DISPATCH_PREPARE_DELAY60no
A delay, in second, between successful acquire of a cloud instance and dispatching of post-acquire preparation tasks.
actor.guest-request-watchdog.dispatch.delayintARTEMIS_ACTOR_GUEST_REQUEST_WATCHDOG_DISPATCH_DELAY600yes
actor.guest-request-watchdog.dispatch.delay:$entitynameARTEMIS_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.periodintARTEMIS_ACTOR_GUEST_REQUEST_WATCHDOG_DISPATCH_PERIOD3600yes
actor.guest-request-watchdog.dispatch.period:$entitynameARTEMIS_ACTOR_GUEST_REQUEST_WATCHDOG_DISPATCH_PERIOD_$entityname
A delay, in seconds, after which new guest request watchdog task is scheduled.
actor.kickstart-wait.initial-delayintARTEMIS_PREPARE_KICKSTART_WAIT_INITIAL_DELAY300yes
actor.kickstart-wait.initial-delay:$entitynameARTEMIS_PREPARE_KICKSTART_WAIT_INITIAL_DELAY_$entityname
Delay before attempting to check the kickstart installation completion.
actor.kickstart-wait.retry-delayintARTEMIS_PREPARE_KICKSTART_WAIT_RETRY_DELAY120yes
actor.kickstart-wait.retry-delay:$entitynameARTEMIS_PREPARE_KICKSTART_WAIT_RETRY_DELAY_$entityname
Delay between kickstart installation completion checks.
actor.kickstart.boot-installer-script-filepathstrARTEMIS_PREPARE_KICKSTART_BOOT_INSTALLER_SCRIPT_FILEPATHartemis-kickstart-kexec.shno
Script to prepare and boot the installer image.
actor.kickstart.compose-repo-mappingstrARTEMIS_PREPARE_KICKSTART_COMPOSE_REPO_MAPPING_FILEPATHartemis-kickstart-compose-repo-map.yamlno
Map of compose names to source repo name for installation.
actor.kickstart.ssh-timeoutintARTEMIS_PREPARE_KICKSTART_SSH_TIMEOUT15yes
actor.kickstart.ssh-timeout:$entitynameARTEMIS_PREPARE_KICKSTART_SSH_TIMEOUT_$entityname
Kickstart installation SSH connection timeout.
actor.kickstart.templatestrARTEMIS_PREPARE_KICKSTART_TEMPLATE_FILEPATHartemis-kickstart.ks.j2no
Kickstart config template path.
actor.offload-tasksboolARTEMIS_OFFLOAD_TASKSyesno
When enabled, tasks will run in their own threads.
actor.refresh-pool-avoid-groups-hostnames.schedulestrARTEMIS_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.schedulestrARTEMIS_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.schedulestrARTEMIS_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.schedulestrARTEMIS_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-timeoutintARTEMIS_SHELVED_GUEST_WATCHDOG_SSH_CONNECT_TIMEOUT15yes
actor.shelved-guest-watchdog.connect-timeout:$entitynameARTEMIS_SHELVED_GUEST_WATCHDOG_SSH_CONNECT_TIMEOUT_$entityname
Shelved guest watchdog SSH connection timeout.
actor.shelved-guest-watchdog.dispatch.delayintARTEMIS_ACTOR_SHELVED_GUEST_WATCHDOG_DISPATCH_PERIOD600no
A delay, in seconds, between watchdog runs.
actor.verify-ssh.connect-timeoutintARTEMIS_PREPARE_VERIFY_SSH_CONNECT_TIMEOUT15yes
actor.verify-ssh.connect-timeout:$entitynameARTEMIS_PREPARE_VERIFY_SSH_CONNECT_TIMEOUT_$entityname
Prepare stage SSH timeout.
actor.worker-ping.schedulestrARTEMIS_ACTOR_WORKER_PING_SCHEDULE*/5 * * * *no
When to run worker ping task, as a Cron-like specification.
api.enable-authenticationboolARTEMIS_ENABLE_AUTHENTICATIONnono
If enabled, API requests must pass authentication by providing proper username and token.
api.enable-authorizationboolARTEMIS_ENABLE_AUTHORIZATIONnono
If enabled, API requests must pass authorization by providing username with privileges high enough for the requested action.
api.engine.debugboolARTEMIS_API_ENGINE_DEBUGnono
Run engine with a debugging enabled.
api.engine.reload-on-changeboolARTEMIS_API_ENGINE_RELOAD_ON_CHANGEnono
Reload API server when its code changes.
api.engine.reload.request-limitintARTEMIS_API_ENGINE_RELOAD_REQUESTS_LIMIT0no
Reload a worker process after serving this number of requests.
api.engine.reload.request-limit.spreadintARTEMIS_API_ENGINE_RELOAD_REQUESTS_LIMIT_SPREAD0no
A range by which is number of requests randomized.
api.processesintARTEMIS_API_PROCESSES1no
Number of processes to spawn for servicing API requests.
api.profiling.enabledboolARTEMIS_API_ENABLE_PROFILINGnono
If enabled, API server will profile handling of each request, emitting a summary into log.
api.profiling.limitintARTEMIS_API_PROFILING_LIMIT20no
How many functions should be included in the summary.
api.threadsintARTEMIS_API_THREADS1no
Number of threads to spawn in each process for servicing API requests.
aws.logs.console.dump.blob.update-tickintARTEMIS_AWS_LOGS_CONSOLE_LATEST_BLOB_UPDATE_TICK300no
How long, in seconds, to take between updating guest console log.
aws.logs.console.interactive.urlstrARTEMIS_AWS_LOGS_CONSOLE_INTERACTIVE_URLhttps://console.aws.amazon.com/ec2/v2/connect/ec2-user/{instance_id}?connection-type=isc&serial-port=0no
Templated URL of serial console of an AWS EC2 instance.
aws.mapping.environment-to-image.pattern-map.filepathstrARTEMIS_AWS_ENVIRONMENT_TO_IMAGE_MAPPING_FILEPATHartemis-image-map-aws.yamlno
aws.mapping.environment-to-image.pattern-map.filepath:$entitynameARTEMIS_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.needlestrARTEMIS_AWS_ENVIRONMENT_TO_IMAGE_MAPPING_NEEDLE{{ os.compose }}no
aws.mapping.environment-to-image.pattern-map.needle:$entitynameARTEMIS_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.templatestrARTEMIS_AWS_GUEST_SECURITY_GROUP_NAME_TEMPLATE{{ TAGS.ArtemisGuestLabel }}-{{ GUESTNAME }}no
aws.mapping.guest-security-group-name.template:$entitynameARTEMIS_AWS_GUEST_SECURITY_GROUP_NAME_TEMPLATE_$entityname
A pattern for guest security group name.
aws.pending-timeoutintARTEMIS_AWS_PENDING_TIMEOUT600no
How long, in seconds, is an instance allowed to stay in pending state until cancelled and reprovisioned.
aws.remove-security-group.delayintARTEMIS_AWS_REMOVE_SECURITY_GROUP_DELAY150no
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-timeoutintARTEMIS_AWS_SPOT_OPEN_TIMEOUT60no
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-tickintARTEMIS_AZURE_LOGS_CONSOLE_LATEST_BLOB_UPDATE_TICK300no
How long, in seconds, to take between updating guest console log.
azure.mapping.environment-to-image.pattern-map.filepathstrARTEMIS_AZURE_ENVIRONMENT_TO_IMAGE_MAPPING_FILEPATHartemis-image-map-azure.yamlno
azure.mapping.environment-to-image.pattern-map.filepath:$entitynameARTEMIS_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.needlestrARTEMIS_AZURE_ENVIRONMENT_TO_IMAGE_MAPPING_NEEDLE{{ os.compose }}no
azure.mapping.environment-to-image.pattern-map.needle:$entitynameARTEMIS_AZURE_ENVIRONMENT_TO_IMAGE_MAPPING_NEEDLE_$entityname
A pattern for needle to match in environment to image mapping file.
azure.mapping.resource-group-name.templatestrARTEMIS_AZURE_RESOURCE_GROUP_NAME_TEMPLATE{{ TAGS.ArtemisGuestLabel }}-{{ GUESTNAME }}no
azure.mapping.resource-group-name.template:$entitynameARTEMIS_AZURE_RESOURCE_GROUP_NAME_TEMPLATE_$entityname
A pattern for guest resource group name
beaker.guest-watchdog.ssh.connect-timeoutintARTEMIS_BEAKER_GUEST_WATCHDOG_SSH_CONNECT_TIMEOUT15yes
beaker.guest-watchdog.ssh.connect-timeout:$entitynameARTEMIS_BEAKER_GUEST_WATCHDOG_SSH_CONNECT_TIMEOUT_$entityname
Guest watchdog SSH timeout.
beaker.job.whiteboard.templatestrARTEMIS_BEAKER_JOB_WHITEBOARD_TEMPLATE[artemis] [{{ DEPLOYMENT }}] {{ GUESTNAME }}no
beaker.job.whiteboard.template:$entitynameARTEMIS_BEAKER_JOB_WHITEBOARD_TEMPLATE_$entityname
A template for Beaker job whiteboard.
beaker.mapping.environment-to-image.patternstrARTEMIS_BEAKER_ENVIRONMENT_TO_IMAGE_MAPPING_PATTERN(?P<distro>[;]+)(?:;variant=(?P<variant>[a-zA-Z]+);?)?$no
beaker.mapping.environment-to-image.pattern:$entitynameARTEMIS_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.filepathstrARTEMIS_BEAKER_ENVIRONMENT_TO_IMAGE_MAPPING_FILEPATHartemis-image-map-beaker.yamlno
beaker.mapping.environment-to-image.pattern-map.filepath:$entitynameARTEMIS_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.needlestrARTEMIS_BEAKER_ENVIRONMENT_TO_IMAGE_MAPPING_NEEDLE{{ os.compose }}no
beaker.mapping.environment-to-image.pattern-map.needle:$entitynameARTEMIS_BEAKER_ENVIRONMENT_TO_IMAGE_MAPPING_NEEDLE_$entityname
A pattern for needle to match in environment to image mapping file.
beaker.reservation.durationintARTEMIS_BEAKER_RESERVATION_DURATION86400no
A time, in seconds, for which the guest would be initially reserved.
beaker.reservation.extension.command-templatestrARTEMIS_BEAKER_RESERVATION_EXTENSION_COMMAND_TEMPLATE`echo {{ (EXTENSION_TIME / 3600)int }}