Introduction
Throughout the lifecycle of a Terraform Enterprise instance, you may need to perform maintenance, such as upgrading to a newer version. Notifying the Terraform Enterprise support team of upcoming maintenance allows them to help prevent potential issues and have a reference of the maintenance plan. This enables the support team to begin troubleshooting more efficiently if an issue occurs.
Recommendation
To ensure the support team is aware of your planned maintenance, you should proactively provide them with the details of the work you will perform. The support team can then review the plan, offer feedback or suggestions, and use this information as a reference if you encounter an issue during the maintenance window.
If an issue occurs during the maintenance, you should open a new support case with specific details about the problem, referencing the proactive communication about the planned maintenance.
Information to Provide
When communicating your maintenance plan, include the following details:
- Date of the planned maintenance.
- Terraform Enterprise deployment environment (e.g., on-premises, specific cloud provider).
- Terraform Enterprise operational mode (e.g., External Services or Mounted Disk).
- Confirmation that you have taken proper snapshots or backups of the Terraform Enterprise instance.
- Confirmation that you have backed up any external services, such as PostgreSQL, blob storage, or an external Vault instance.
- The current Terraform Enterprise version.
- The target Terraform Enterprise version.
Providing any other additional information related to the upcoming maintenance is also beneficial.
Handling Multiple Issues
If multiple, unrelated issues occur during the planned maintenance, it is best practice to open separate support cases for each issue. This approach allows for better tracking and prevents details from being lost in a single communication thread.