On this page

Automated Mod Updates

In this guide, you will:

Setup automated mod update from the Turbot registry.

Prerequisites

Turbot/Owner permissions at the Turbot resource level.
Familiarity with Guardrails console.

Log into the Guardrails console with provided local credentials or by using any SAML based login.

Step 2: Find Policy

Navigate to Policies tab, search for Auto Update text.

Select the Turbot > Mod > Auto Update policy, which will display a set of related policies, as shown below.

Settings	Description
Desired Version	The desired version of the mod, is usually calculated by matching Turbot > Mod > Auto Update > Version Range against mod versions currently available in the Turbot Registry. The desired version is then used by Turbot > Mod > Auto Update to determine if an update is available, and the target version to use.
Version Range	Specify the allowed range of versions for this mod. This version range is used to calculate Turbot > Mod > Desired Version, so the mod can be automatically updated per Turbot > Mod > Auto Update parent policy. The default value is set to `^{{MAJOR}`: The latest version in the same major release that is installed
Schedule	The period when Turbot is permitted to apply changes to Mod using Mod's Auto Update control. This is only used when Turbot > Mod > Auto Update parent policy is set to Enforce within Mod Change Window. See detailed information here

Important
The policy evaluation process checks against the Turbot > Mod > Desired Version policy, which is calculated from the Turbot > Mod > Version Range policy. If not set, it picks up the latest recommended version.

Step 3: Create Policy Setting

Select New Policy Setting to open the Create Policy Setting window.

Assign the policy values as Turbot for Resource.

Note
The policy is applied at the Turbot resource level.

Settings	Description
Check	Will alarm if the version is out of date.
Enforce	Will attempt to automatically update the mod as soon as a new version of the mod is available.
Enforce within Mod Change Window	Will schedule mod updates based on the specified UTC format time.

Step 4: Setting up Schedule

Select Turbot > Mod > Auto Update Schedule policy.

Create new schedule policy by selecting New Policy Setting.

Set the desired value in the schedule policy for Turbot > Mod > Auto Update control to check for and execute the mod update to the recommended version.

Note
Turbot assumes UTC. The format of this policy is a list of yaml object, each with a name, description, a start time, and duration (in hours).

Step 5: Review

Check if the above policies are reflected in Guardrails console.

Next Steps

Please see the following resources to learn more about Turbot Guardrails Enterprise:

Learn about Policy Exception
Learn about Updating Mod

Troubleshooting

Issue	Description	Guide
Further Assistance	If you continue to encounter issues, please open a ticket with us and attach the relevant information to assist you more efficiently.	Open Support Ticket