From abbb7d7d01f02369d495b19cba3f0d2f8263360b Mon Sep 17 00:00:00 2001 From: kruti Date: Wed, 12 Nov 2025 12:59:14 +0530 Subject: [PATCH 1/4] docs(nia-cts): updated CTS documentation for upcoming CTS release 0.9.0 Added new key for auto upgrade and updated behaviour of terraform_version key for the new versioning improvements made --- content/consul/v1.12.x/content/docs/nia/configuration.mdx | 5 +++-- content/consul/v1.13.x/content/docs/nia/configuration.mdx | 5 +++-- content/consul/v1.14.x/content/docs/nia/configuration.mdx | 5 +++-- content/consul/v1.15.x/content/docs/nia/configuration.mdx | 5 +++-- content/consul/v1.16.x/content/docs/nia/configuration.mdx | 5 +++-- content/consul/v1.17.x/content/docs/nia/configuration.mdx | 5 +++-- content/consul/v1.18.x/content/docs/nia/configuration.mdx | 6 ++++-- content/consul/v1.19.x/content/docs/nia/configuration.mdx | 5 +++-- content/consul/v1.20.x/content/docs/nia/configuration.mdx | 5 +++-- content/consul/v1.21.x/content/docs/reference/cts/index.mdx | 5 +++-- content/consul/v1.22.x/content/docs/reference/cts/index.mdx | 5 +++-- 11 files changed, 34 insertions(+), 22 deletions(-) diff --git a/content/consul/v1.12.x/content/docs/nia/configuration.mdx b/content/consul/v1.12.x/content/docs/nia/configuration.mdx index e1cbfb4796..2fca485c79 100644 --- a/content/consul/v1.12.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.12.x/content/docs/nia/configuration.mdx @@ -339,12 +339,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. + - `auto_upgrade_tf_version` - (bool: true) 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. ### Task Condition diff --git a/content/consul/v1.13.x/content/docs/nia/configuration.mdx b/content/consul/v1.13.x/content/docs/nia/configuration.mdx index 7cdf4aa4e4..bdca3817d6 100644 --- a/content/consul/v1.13.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.13.x/content/docs/nia/configuration.mdx @@ -339,12 +339,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. + - `auto_upgrade_tf_version` - (bool: true) 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. ### Task Condition diff --git a/content/consul/v1.14.x/content/docs/nia/configuration.mdx b/content/consul/v1.14.x/content/docs/nia/configuration.mdx index bd2f654d5a..fb46b9cb80 100644 --- a/content/consul/v1.14.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.14.x/content/docs/nia/configuration.mdx @@ -339,12 +339,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. + - `auto_upgrade_tf_version` - (bool: true) 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. ### Task Condition diff --git a/content/consul/v1.15.x/content/docs/nia/configuration.mdx b/content/consul/v1.15.x/content/docs/nia/configuration.mdx index 298e1b2b08..d908592b06 100644 --- a/content/consul/v1.15.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.15.x/content/docs/nia/configuration.mdx @@ -339,12 +339,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. + - `auto_upgrade_tf_version` - (bool: true) 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. ### Task Condition diff --git a/content/consul/v1.16.x/content/docs/nia/configuration.mdx b/content/consul/v1.16.x/content/docs/nia/configuration.mdx index 298e1b2b08..d908592b06 100644 --- a/content/consul/v1.16.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.16.x/content/docs/nia/configuration.mdx @@ -339,12 +339,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. + - `auto_upgrade_tf_version` - (bool: true) 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. ### Task Condition diff --git a/content/consul/v1.17.x/content/docs/nia/configuration.mdx b/content/consul/v1.17.x/content/docs/nia/configuration.mdx index ec53eccdad..a09ad81eea 100644 --- a/content/consul/v1.17.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.17.x/content/docs/nia/configuration.mdx @@ -339,12 +339,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. + - `auto_upgrade_tf_version` - (bool: true) 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. ### Task Condition diff --git a/content/consul/v1.18.x/content/docs/nia/configuration.mdx b/content/consul/v1.18.x/content/docs/nia/configuration.mdx index ec07f3474d..15c011d8cc 100644 --- a/content/consul/v1.18.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.18.x/content/docs/nia/configuration.mdx @@ -339,12 +339,14 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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 HCP Terraform workspace associated with the task. Defaults to the latest compatible version supported by the organization. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). +- `terraform_version` - (string) **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 HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). - `terraform_cloud_workspace` - (obj) Configures attributes of the HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use HCP Terraform as the Terraform execution platform. Only supports "remote" or "agent". - `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 HCP Terraform 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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. + - `auto_upgrade_tf_version` - (bool: true) 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. + ### Task Condition diff --git a/content/consul/v1.19.x/content/docs/nia/configuration.mdx b/content/consul/v1.19.x/content/docs/nia/configuration.mdx index ec07f3474d..0cd9811014 100644 --- a/content/consul/v1.19.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.19.x/content/docs/nia/configuration.mdx @@ -339,12 +339,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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 HCP Terraform workspace associated with the task. Defaults to the latest compatible version supported by the organization. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). +- `terraform_version` - (string) **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 HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). - `terraform_cloud_workspace` - (obj) Configures attributes of the HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use HCP Terraform as the Terraform execution platform. Only supports "remote" or "agent". - `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 HCP Terraform 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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. + - `auto_upgrade_tf_version` - (bool: true) 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. ### Task Condition diff --git a/content/consul/v1.20.x/content/docs/nia/configuration.mdx b/content/consul/v1.20.x/content/docs/nia/configuration.mdx index ec07f3474d..0cd9811014 100644 --- a/content/consul/v1.20.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.20.x/content/docs/nia/configuration.mdx @@ -339,12 +339,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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 HCP Terraform workspace associated with the task. Defaults to the latest compatible version supported by the organization. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). +- `terraform_version` - (string) **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 HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). - `terraform_cloud_workspace` - (obj) Configures attributes of the HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use HCP Terraform as the Terraform execution platform. Only supports "remote" or "agent". - `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 HCP Terraform 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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. + - `auto_upgrade_tf_version` - (bool: true) 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. ### Task Condition diff --git a/content/consul/v1.21.x/content/docs/reference/cts/index.mdx b/content/consul/v1.21.x/content/docs/reference/cts/index.mdx index 132baefcd0..515a3456a7 100644 --- a/content/consul/v1.21.x/content/docs/reference/cts/index.mdx +++ b/content/consul/v1.21.x/content/docs/reference/cts/index.mdx @@ -355,12 +355,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. Refer to [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `source_input` - (obj) **Deprecated in CTS 0.5.0 and will be removed in 0.8.0. Refer to 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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. + - `auto_upgrade_tf_version` - (bool: true) 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. ### Task condition diff --git a/content/consul/v1.22.x/content/docs/reference/cts/index.mdx b/content/consul/v1.22.x/content/docs/reference/cts/index.mdx index fa4fddaa43..92c73eea18 100644 --- a/content/consul/v1.22.x/content/docs/reference/cts/index.mdx +++ b/content/consul/v1.22.x/content/docs/reference/cts/index.mdx @@ -349,12 +349,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. Refer to [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `source_input` - (obj) **Deprecated in CTS 0.5.0 and will be removed in 0.8.0. Refer to 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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. + - `auto_upgrade_tf_version` - (bool: true) 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. ### Task condition From 9d3a3d7e694c1424336d1e5911f781d8587c77ca Mon Sep 17 00:00:00 2001 From: kruti Date: Thu, 13 Nov 2025 10:59:49 +0530 Subject: [PATCH 2/4] refactor(cts): added version information --- content/consul/v1.12.x/content/docs/nia/configuration.mdx | 4 ++-- content/consul/v1.13.x/content/docs/nia/configuration.mdx | 4 ++-- content/consul/v1.14.x/content/docs/nia/configuration.mdx | 4 ++-- content/consul/v1.15.x/content/docs/nia/configuration.mdx | 4 ++-- content/consul/v1.16.x/content/docs/nia/configuration.mdx | 4 ++-- content/consul/v1.17.x/content/docs/nia/configuration.mdx | 4 ++-- content/consul/v1.18.x/content/docs/nia/configuration.mdx | 5 ++--- content/consul/v1.19.x/content/docs/nia/configuration.mdx | 4 ++-- content/consul/v1.20.x/content/docs/nia/configuration.mdx | 4 ++-- content/consul/v1.21.x/content/docs/reference/cts/index.mdx | 4 ++-- content/consul/v1.22.x/content/docs/reference/cts/index.mdx | 4 ++-- 11 files changed, 22 insertions(+), 23 deletions(-) diff --git a/content/consul/v1.12.x/content/docs/nia/configuration.mdx b/content/consul/v1.12.x/content/docs/nia/configuration.mdx index 2fca485c79..043ab1e239 100644 --- a/content/consul/v1.12.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.12.x/content/docs/nia/configuration.mdx @@ -344,8 +344,8 @@ task { - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. - - `auto_upgrade_tf_version` - (bool: true) 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. + - `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. ### Task Condition diff --git a/content/consul/v1.13.x/content/docs/nia/configuration.mdx b/content/consul/v1.13.x/content/docs/nia/configuration.mdx index bdca3817d6..c54ab482df 100644 --- a/content/consul/v1.13.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.13.x/content/docs/nia/configuration.mdx @@ -344,8 +344,8 @@ task { - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. - - `auto_upgrade_tf_version` - (bool: true) 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. + - `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. ### Task Condition diff --git a/content/consul/v1.14.x/content/docs/nia/configuration.mdx b/content/consul/v1.14.x/content/docs/nia/configuration.mdx index fb46b9cb80..55b9ea2193 100644 --- a/content/consul/v1.14.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.14.x/content/docs/nia/configuration.mdx @@ -344,8 +344,8 @@ task { - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. - - `auto_upgrade_tf_version` - (bool: true) 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. + - `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. ### Task Condition diff --git a/content/consul/v1.15.x/content/docs/nia/configuration.mdx b/content/consul/v1.15.x/content/docs/nia/configuration.mdx index d908592b06..66da887892 100644 --- a/content/consul/v1.15.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.15.x/content/docs/nia/configuration.mdx @@ -344,8 +344,8 @@ task { - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. - - `auto_upgrade_tf_version` - (bool: true) 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. + - `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. ### Task Condition diff --git a/content/consul/v1.16.x/content/docs/nia/configuration.mdx b/content/consul/v1.16.x/content/docs/nia/configuration.mdx index d908592b06..66da887892 100644 --- a/content/consul/v1.16.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.16.x/content/docs/nia/configuration.mdx @@ -344,8 +344,8 @@ task { - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. - - `auto_upgrade_tf_version` - (bool: true) 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. + - `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. ### Task Condition diff --git a/content/consul/v1.17.x/content/docs/nia/configuration.mdx b/content/consul/v1.17.x/content/docs/nia/configuration.mdx index a09ad81eea..d4fbae2c98 100644 --- a/content/consul/v1.17.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.17.x/content/docs/nia/configuration.mdx @@ -344,8 +344,8 @@ task { - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. - - `auto_upgrade_tf_version` - (bool: true) 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. + - `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. ### Task Condition diff --git a/content/consul/v1.18.x/content/docs/nia/configuration.mdx b/content/consul/v1.18.x/content/docs/nia/configuration.mdx index 15c011d8cc..4fb13f6d59 100644 --- a/content/consul/v1.18.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.18.x/content/docs/nia/configuration.mdx @@ -344,9 +344,8 @@ task { - `execution_mode` - (string: "remote") The execution mode that determines whether to use HCP Terraform as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. - - `auto_upgrade_tf_version` - (bool: true) 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. - + - `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. ### Task Condition diff --git a/content/consul/v1.19.x/content/docs/nia/configuration.mdx b/content/consul/v1.19.x/content/docs/nia/configuration.mdx index 0cd9811014..4fb13f6d59 100644 --- a/content/consul/v1.19.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.19.x/content/docs/nia/configuration.mdx @@ -344,8 +344,8 @@ task { - `execution_mode` - (string: "remote") The execution mode that determines whether to use HCP Terraform as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. - - `auto_upgrade_tf_version` - (bool: true) 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. + - `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. ### Task Condition diff --git a/content/consul/v1.20.x/content/docs/nia/configuration.mdx b/content/consul/v1.20.x/content/docs/nia/configuration.mdx index 0cd9811014..4fb13f6d59 100644 --- a/content/consul/v1.20.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.20.x/content/docs/nia/configuration.mdx @@ -344,8 +344,8 @@ task { - `execution_mode` - (string: "remote") The execution mode that determines whether to use HCP Terraform as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. - - `auto_upgrade_tf_version` - (bool: true) 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. + - `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. ### Task Condition diff --git a/content/consul/v1.21.x/content/docs/reference/cts/index.mdx b/content/consul/v1.21.x/content/docs/reference/cts/index.mdx index 515a3456a7..9db0803229 100644 --- a/content/consul/v1.21.x/content/docs/reference/cts/index.mdx +++ b/content/consul/v1.21.x/content/docs/reference/cts/index.mdx @@ -360,8 +360,8 @@ task { - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. - - `auto_upgrade_tf_version` - (bool: true) 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. + - `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. ### Task condition diff --git a/content/consul/v1.22.x/content/docs/reference/cts/index.mdx b/content/consul/v1.22.x/content/docs/reference/cts/index.mdx index 92c73eea18..fb1aa5619c 100644 --- a/content/consul/v1.22.x/content/docs/reference/cts/index.mdx +++ b/content/consul/v1.22.x/content/docs/reference/cts/index.mdx @@ -354,8 +354,8 @@ task { - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. If omitted, CTS will use the existing workspace version if compatible, or upgrade to the nearest compatible version if not. - - `auto_upgrade_tf_version` - (bool: true) 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. + - `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. ### Task condition From 1cee1d7ef6eac43a42f83366529142b690456e85 Mon Sep 17 00:00:00 2001 From: kruti Date: Thu, 20 Nov 2025 11:05:43 +0530 Subject: [PATCH 3/4] refactor: addressed review comments --- content/consul/v1.18.x/content/docs/nia/configuration.mdx | 6 +++--- content/consul/v1.19.x/content/docs/nia/configuration.mdx | 6 +++--- content/consul/v1.20.x/content/docs/nia/configuration.mdx | 6 +++--- content/consul/v1.21.x/content/docs/reference/cts/index.mdx | 6 +++--- content/consul/v1.22.x/content/docs/reference/cts/index.mdx | 6 +++--- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/content/consul/v1.18.x/content/docs/nia/configuration.mdx b/content/consul/v1.18.x/content/docs/nia/configuration.mdx index 4fb13f6d59..bd508746e7 100644 --- a/content/consul/v1.18.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.18.x/content/docs/nia/configuration.mdx @@ -339,13 +339,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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 HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). +- `terraform_version` - (string) **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 HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). - `terraform_cloud_workspace` - (obj) Configures attributes of the HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use HCP Terraform as the Terraform execution platform. Only supports "remote" or "agent". - `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. **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. + - `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. + - `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. ### Task Condition diff --git a/content/consul/v1.19.x/content/docs/nia/configuration.mdx b/content/consul/v1.19.x/content/docs/nia/configuration.mdx index 4fb13f6d59..bd508746e7 100644 --- a/content/consul/v1.19.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.19.x/content/docs/nia/configuration.mdx @@ -339,13 +339,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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 HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). +- `terraform_version` - (string) **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 HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). - `terraform_cloud_workspace` - (obj) Configures attributes of the HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use HCP Terraform as the Terraform execution platform. Only supports "remote" or "agent". - `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. **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. + - `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. + - `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. ### Task Condition diff --git a/content/consul/v1.20.x/content/docs/nia/configuration.mdx b/content/consul/v1.20.x/content/docs/nia/configuration.mdx index 4fb13f6d59..bd508746e7 100644 --- a/content/consul/v1.20.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.20.x/content/docs/nia/configuration.mdx @@ -339,13 +339,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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 HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). +- `terraform_version` - (string) **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 HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver); otherwise, set the version within the [Terraform driver](#terraform-driver). - `terraform_cloud_workspace` - (obj) Configures attributes of the HCP Terraform workspace associated with the task. This option is only available when used with the [HCP Terraform driver](#hcp-terraform-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use HCP Terraform as the Terraform execution platform. Only supports "remote" or "agent". - `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. **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. + - `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. + - `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. ### Task Condition diff --git a/content/consul/v1.21.x/content/docs/reference/cts/index.mdx b/content/consul/v1.21.x/content/docs/reference/cts/index.mdx index 9db0803229..dbc536ff83 100644 --- a/content/consul/v1.21.x/content/docs/reference/cts/index.mdx +++ b/content/consul/v1.21.x/content/docs/reference/cts/index.mdx @@ -355,13 +355,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. Refer to [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `source_input` - (obj) **Deprecated in CTS 0.5.0 and will be removed in 0.8.0. Refer to 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) **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) **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). - `terraform_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. **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. + - `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. + - `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. ### Task condition diff --git a/content/consul/v1.22.x/content/docs/reference/cts/index.mdx b/content/consul/v1.22.x/content/docs/reference/cts/index.mdx index fb1aa5619c..b82ccdb87d 100644 --- a/content/consul/v1.22.x/content/docs/reference/cts/index.mdx +++ b/content/consul/v1.22.x/content/docs/reference/cts/index.mdx @@ -349,13 +349,13 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. Refer to [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `source_input` - (obj) **Deprecated in CTS 0.5.0 and will be removed in 0.8.0. Refer to 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) **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) **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). - `terraform_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. **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. + - `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. + - `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. ### Task condition From 536e25929eb3bf65068f0e52d79331d49cba7721 Mon Sep 17 00:00:00 2001 From: kruti Date: Thu, 20 Nov 2025 11:08:08 +0530 Subject: [PATCH 4/4] fix: removed backports to unsupported versions --- content/consul/v1.12.x/content/docs/nia/configuration.mdx | 5 ++--- content/consul/v1.13.x/content/docs/nia/configuration.mdx | 5 ++--- content/consul/v1.14.x/content/docs/nia/configuration.mdx | 5 ++--- content/consul/v1.15.x/content/docs/nia/configuration.mdx | 5 ++--- content/consul/v1.16.x/content/docs/nia/configuration.mdx | 5 ++--- content/consul/v1.17.x/content/docs/nia/configuration.mdx | 5 ++--- 6 files changed, 12 insertions(+), 18 deletions(-) diff --git a/content/consul/v1.12.x/content/docs/nia/configuration.mdx b/content/consul/v1.12.x/content/docs/nia/configuration.mdx index 043ab1e239..e1cbfb4796 100644 --- a/content/consul/v1.12.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.12.x/content/docs/nia/configuration.mdx @@ -339,13 +339,12 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. **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. + - `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. ### Task Condition diff --git a/content/consul/v1.13.x/content/docs/nia/configuration.mdx b/content/consul/v1.13.x/content/docs/nia/configuration.mdx index c54ab482df..7cdf4aa4e4 100644 --- a/content/consul/v1.13.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.13.x/content/docs/nia/configuration.mdx @@ -339,13 +339,12 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. **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. + - `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. ### Task Condition diff --git a/content/consul/v1.14.x/content/docs/nia/configuration.mdx b/content/consul/v1.14.x/content/docs/nia/configuration.mdx index 55b9ea2193..bd2f654d5a 100644 --- a/content/consul/v1.14.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.14.x/content/docs/nia/configuration.mdx @@ -339,13 +339,12 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. **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. + - `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. ### Task Condition diff --git a/content/consul/v1.15.x/content/docs/nia/configuration.mdx b/content/consul/v1.15.x/content/docs/nia/configuration.mdx index 66da887892..298e1b2b08 100644 --- a/content/consul/v1.15.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.15.x/content/docs/nia/configuration.mdx @@ -339,13 +339,12 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. **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. + - `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. ### Task Condition diff --git a/content/consul/v1.16.x/content/docs/nia/configuration.mdx b/content/consul/v1.16.x/content/docs/nia/configuration.mdx index 66da887892..298e1b2b08 100644 --- a/content/consul/v1.16.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.16.x/content/docs/nia/configuration.mdx @@ -339,13 +339,12 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. **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. + - `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. ### Task Condition diff --git a/content/consul/v1.17.x/content/docs/nia/configuration.mdx b/content/consul/v1.17.x/content/docs/nia/configuration.mdx index d4fbae2c98..ec53eccdad 100644 --- a/content/consul/v1.17.x/content/docs/nia/configuration.mdx +++ b/content/consul/v1.17.x/content/docs/nia/configuration.mdx @@ -339,13 +339,12 @@ task { - `condition` - (obj: required) The requirement that, when met, triggers CTS to execute the task. Only one `condition` may be configured per task. CTS supports different types of conditions, which each have their own configuration options. See [Task Condition](#task-condition) configuration for full details on configuration options for each condition type. - `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) **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) **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_cloud_workspace` - (obj) Configures attributes of the Terraform Cloud workspace associated with the task. This option is only available when used with the [Terraform Cloud driver](#terraform-cloud-driver). For global configurations of all workspaces, review [`driver.workspaces`](#workspaces). - `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent". - `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. **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. + - `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. ### Task Condition