docs(nia-cts): updated documentation for upcoming CTS release 0.9.0 #1286
+15
−10
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Vercel Previews Deployed
|
Contributor
Broken Link CheckerNo broken links found! 🎉 |
krutibaraiya
changed the title
boruszak
requested changes
Nov 17, 2025
Contributor
boruszak
left a comment
boruszak
left a comment
There was a problem hiding this comment.
I left suggestions for the three specifications to align with style guidelines. Please apply these suggestions to all version backports in the PR.
On the topic of backports - can you confirm that you want to backport this change all the way back to v1.12.x? Typically we only backport to currently supported versions (currently v1.18.x), but if there are known Enterprise users on v1.12.x of Consul, then backporting that far would be appropriate.
| - `source_input` - (obj) **Deprecated in CTS 0.5.0 and will be removed in 0.8.0. See the `module_input` block instead.** | ||
| - `module_input` - (obj) Specifies a Consul object containing values or metadata to be provided to the Terraform Module. The `module_input` block defines any extra module inputs needed for task execution. This is in addition to any module input provided by the `condition` block or `services` field (deprecated). Multiple `module_input` blocks can be configured per task. [Task Module Input](#task-module-input) configuration for full details on usage and restrictions. | ||
| - `terraform_version` - (string) <EnterpriseAlert inline /> **Deprecated in CTS 0.6.0 and will be removed in 0.8.0. Review `terraform_cloud_workspace.terraform_version` instead.** The version of Terraform to use for the Terraform Cloud workspace associated with the task. Defaults to the latest compatible version supported by the organization. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). | ||
| - `terraform_version` - (string) <EnterpriseAlert inline /> **Deprecated in CTS 0.6.0 and will be removed in 0.8.0. Review `terraform_cloud_workspace.terraform_version` instead.** The version of Terraform to use for the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). |
Contributor
There was a problem hiding this comment.
Suggested change
| - `terraform_version` - (string) <EnterpriseAlert inline /> **Deprecated in CTS 0.6.0 and will be removed in 0.8.0. Review `terraform_cloud_workspace.terraform_version` instead.** The version of Terraform to use for the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). | |
| - `terraform_version` - (string) <EnterpriseAlert inline /> **Deprecated in CTS 0.6.0 and removed in 0.8.0. Use `terraform_cloud_workspace.terraform_version` instead.** The version of Terraform to use for the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). |
| - `agent_pool_id` - (string) Only supported if `execution_mode` is set to "agent". The ID of the agent pool that should run the Terraform workloads. Either `agent_pool_id` or `agent_pool_name` are required if `execution_mode` is set to "agent". `agent_pool_id` takes precedence over `agent_pool_name` if both are provided. | ||
| - `agent_pool_name` - (string) Only supported if `execution_mode` is set to "agent". The name of the agent pool that should run the Terraform workloads. Only supported if `execution_mode` is set to "agent". Either `agent_pool_id` or `agent_pool_name` are required. `agent_pool_id` takes precedence over `agent_pool_name` if both are provided. | ||
| - `terraform_version` - (string) The version of Terraform to use for the Terraform Cloud workspace associated with the task. Defaults to the latest compatible version supported by the organization. | ||
| - `terraform_version` - (string) The version of Terraform to use for the Terraform Cloud workspace associated with the task. **For CTS v0.9.0 and later** - if omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. **For CTS versions prior to v0.9.0** - Defaults to the latest compatible version supported by the organization. |
Contributor
There was a problem hiding this comment.
Suggested change
| - `terraform_version` - (string) The version of Terraform to use for the Terraform Cloud workspace associated with the task. **For CTS v0.9.0 and later** - if omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. **For CTS versions prior to v0.9.0** - Defaults to the latest compatible version supported by the organization. | |
| - `terraform_version` - (string) The version of Terraform to use for the Terraform Cloud workspace associated with the task. Beginning with v0.9.0, you can omit this configuration and CTS will either use the existing workspace version if compatible, or upgrade the workspace version to a compatible version. In prior versions, this parameter defaults to the latest compatible version supported by the organization. |
| - `agent_pool_name` - (string) Only supported if `execution_mode` is set to "agent". The name of the agent pool that should run the Terraform workloads. Only supported if `execution_mode` is set to "agent". Either `agent_pool_id` or `agent_pool_name` are required. `agent_pool_id` takes precedence over `agent_pool_name` if both are provided. | ||
| - `terraform_version` - (string) The version of Terraform to use for the Terraform Cloud workspace associated with the task. Defaults to the latest compatible version supported by the organization. | ||
| - `terraform_version` - (string) The version of Terraform to use for the Terraform Cloud workspace associated with the task. **For CTS v0.9.0 and later** - if omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. **For CTS versions prior to v0.9.0** - Defaults to the latest compatible version supported by the organization. | ||
| - `auto_upgrade_tf_version` - (bool: true) **Available in CTS v0.9.0 and later** When set to true, CTS automatically upgrades an incompatible Terraform version in the workspace to the nearest compatible version. When set to false, CTS does not upgrade automatically and fails with an error if the workspace Terraform version is incompatible. The default is true if unspecified for backward compatibility. |
Contributor
There was a problem hiding this comment.
Suggested change
| - `auto_upgrade_tf_version` - (bool: true) **Available in CTS v0.9.0 and later** When set to true, CTS automatically upgrades an incompatible Terraform version in the workspace to the nearest compatible version. When set to false, CTS does not upgrade automatically and fails with an error if the workspace Terraform version is incompatible. The default is true if unspecified for backward compatibility. | |
| - `auto_upgrade_tf_version` - (bool: true) Available in CTS v0.9.0 and later. When set to true, CTS automatically upgrades an incompatible Terraform version in the workspace to the nearest compatible version. When set to false, CTS does not upgrade automatically and fails with an error if the workspace Terraform version is incompatible. If unspecified, this parameter defaults to `true` for backward compatibility. |
Added new key for auto upgrade and updated behaviour of terraform_version key for the new versioning improvements made
krutibaraiya
force-pushed
the
CSL-12733/cts-version-config
branch
from
2f32abc to
9d3a3d7
Compare
krutibaraiya
force-pushed
the
CSL-12733/cts-version-config
branch
from
17a87c0 to
536e259
Compare
Member
Author
|
@boruszak Thanks! I have removed the backports to unsupported versions, and made the suggested changes for versions till 1.18.x |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added new key for auto upgrade and updated behaviour of terraform_version key for the new versioning improvements made
Description
🎫 [Jira ticket]
Update CTS-enterprise documentation with the improvements to be introduced in v0.9.0 (Release date ~ 21st November 2025), as below:
auto_upgrade_tf_versionto let users have a control over automatic Terraform version upgrades in their workspacesDetails can be found in the RFC
Requested review scope:
Review urgency:
All updates:
I have:
labelapplied (hcp+product name)Content checklist (optional)
Please do these things before requesting a review. I have:
hashicorp-education/teamNameto any additional code or example repos as repo admin