Environment Settings Reference#

This document lists all settings that can be set per environment. These changes are made through the API, the web-console 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.

auto_full_compile#
Type:

str

Default:

‘’

Periodically run a full compile following a cron-like time-to-run specification interpreted in UTC with format [sec] min hour dom month dow [year] (If only 6 values are provided, they are interpreted as min hour dom month dow year). A compile will be requested at the scheduled time. The actual compilation may have to wait in the compile queue for some time, depending on the size of the queue and the RECOMPILE_BACKOFF environment setting. This setting has no effect when server_compile is disabled.

autostart_agent_deploy_interval#
Type:

str

Default:

600

The deployment interval of the autostarted agents. Can be specified as a number of seconds or as a cron-like expression. 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:

str

Default:

86400

The repair interval of the autostarted agents. Can be specified as a number of seconds or as a cron-like expression. 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.

available_versions_to_keep#
Type:

int

Default:

100

The number of versions to keep stored in the database

enable_lsm_expert_mode#
Type:

bool

Default:

False

This setting enables lsm expert mode. When enabled, it will be possible to use the LSM expert mode API endpoints. This bypass many of the safety checks done by the Inmanta server. Use with caution.

environment_agent_trigger_method#
Type:

enum: push_incremental_deploy, push_full_deploy

Default:

push_incremental_deploy

The agent trigger method to use when no specific method is specified in the API call. This determines the behavior of the ‘Promote’ button. For auto deploy, agent_trigger_method_on_auto_deploy is used.

environment_metrics_retention#
Type:

int

Default:

8760

The number of hours that environment metrics have to be retained before they are cleaned up. Default=8760 hours (1 year). Set to 0 to disable automatic cleanups.

lsm_partial_compile#
Type:

bool

Default:

False

When this boolean is set to true, the compilation will be done using partial compiles, else full compiles will be done

notification_retention#
Type:

int

Default:

365

The number of days to retain notifications for

protected_environment#
Type:

bool

Default:

False

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

purge_on_delete#
Type:

bool

Default:

False

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.

recompile_backoff#
Type:

positive_float

Default:

0.1

The number of seconds to wait before the server may attempt to do a new recompile. Recompiles are triggered after facts updates for example.

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.