Environment Settings Reference

This document lists all settings that can be set per environment. These changes are made through the API, the dashboard or the CLI tool.

The supported settings are:

agent_trigger_method_on_auto_deploy
Type

enum: push_incremental_deploy, push_full_deploy

Default

push_incremental_deploy

The agent trigger method to use when push_on_auto_deploy is enabled

auto_deploy
Type

bool

Default

True

When this boolean is set to true, the orchestrator will automatically release a new version that was compiled by the orchestrator itself.

autostart_agent_deploy_interval
Type

int

Default

600

The deployment interval of the autostarted agents. See also: config.agent-deploy-interval

autostart_agent_deploy_splay_time
Type

int

Default

10

The splay time on the deployment interval of the autostarted agents. See also: config.agent-deploy-splay-time

autostart_agent_interval
Type

int

Default

600

[DEPRECATED] Agent interval for autostarted agents in seconds

autostart_agent_map
Type

dict

Default

{‘internal’: ‘local:’}

A dict with key the name of agents that should be automatically started. The value is either an empty string or an agent map string. See also: config.agent-map

autostart_agent_repair_interval
Type

int

Default

86400

The repair interval of the autostarted agents. See also: config.agent-repair-interval

autostart_agent_repair_splay_time
Type

int

Default

600

The splay time on the repair interval of the autostarted agents. See also: config.agent-repair-splay-time

autostart_on_start
Type

bool

Default

True

Automatically start agents when the server starts instead of only just in time.

autostart_splay
Type

int

Default

10

[DEPRECATED] Splay time for autostarted agents.

protected_environment
Type

bool

Default

False

When set to true, this environment cannot be cleared or deleted.

purge_on_delete
Type

bool

Default

True

Enable purge on delete. When set to true, the server will detect the absence of resources with purge_on_delete set to true and automatically purges them.

push_on_auto_deploy
Type

bool

Default

True

Push a new version when it has been autodeployed.

resource_action_logs_retention
Type

int

Default

7

The number of days to retain resource-action logs

server_compile
Type

bool

Default

True

Allow the server to compile the configuration model.