Enabled
The enabled directive in Terrateam allows you to enable or disable a repository. When a repository is disabled, Terrateam will ignore all events from that repository, effectively turning off Terrateam for that specific repository.
Configuration
Enabled is configured in the .terrateam/config.yml file under the enabled key. Here’s the default configuration:
enabled: trueEnabled options
The enabled key can be set to one of the following values:
| Value | Description |
|---|---|
true | (Default) Terrateam is enabled for the repository and will process events and perform Terraform operations as configured. |
false | Terrateam is disabled for the repository and will ignore all events, effectively turning off Terrateam for the repository. |
Examples
Enabling a repository
enabled: trueThis configuration will enable Terrateam for the repository, allowing it to process events and perform Terraform operations as configured.
Disabling a repository
enabled: falseThis configuration will disable Terrateam for the repository, causing it to ignore all events and effectively turning off Terrateam for the repository.
Considerations
When setting the enabled status for a repository, keep the following in mind:
- Disabling a repository can be useful when you need to temporarily stop Terrateam from processing events and performing Terraform operations, such as during maintenance or troubleshooting.
- When a repository is disabled, Terrateam will not process any events, including pull request creation, updates, and merges. This means that no plans or applies will be performed, and no comments will be added to pull requests.
- Disabling a repository does not affect any existing Terraform state or resources that have been provisioned by Terrateam. It simply prevents Terrateam from making any further changes to the infrastructure.
- If you need to disable Terrateam for a specific directory or workspace within a repository, you can use workflows and dirs configurations to selectively control where Terrateam operates.