Skip to content

Commit 2f32abc

Browse files
committed
refactor(cts): added version information
1 parent 664c334 commit 2f32abc

File tree

11 files changed

+22
-23
lines changed

11 files changed

+22
-23
lines changed

content/consul/v1.12.x/content/docs/nia/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,8 +344,8 @@ task {
344344
- `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent".
345345
- `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.
346346
- `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.
347-
- `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.
348-
- `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.
347+
- `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.
348+
- `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.
349349

350350
### Task Condition
351351

content/consul/v1.13.x/content/docs/nia/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,8 +344,8 @@ task {
344344
- `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent".
345345
- `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.
346346
- `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.
347-
- `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.
348-
- `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.
347+
- `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.
348+
- `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.
349349

350350
### Task Condition
351351

content/consul/v1.14.x/content/docs/nia/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,8 +344,8 @@ task {
344344
- `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent".
345345
- `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.
346346
- `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.
347-
- `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.
348-
- `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.
347+
- `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.
348+
- `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.
349349

350350
### Task Condition
351351

content/consul/v1.15.x/content/docs/nia/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,8 +344,8 @@ task {
344344
- `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent".
345345
- `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.
346346
- `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.
347-
- `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.
348-
- `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.
347+
- `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.
348+
- `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.
349349

350350
### Task Condition
351351

content/consul/v1.16.x/content/docs/nia/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,8 +344,8 @@ task {
344344
- `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent".
345345
- `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.
346346
- `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.
347-
- `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.
348-
- `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.
347+
- `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.
348+
- `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.
349349

350350
### Task Condition
351351

content/consul/v1.17.x/content/docs/nia/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,8 +344,8 @@ task {
344344
- `execution_mode` - (string: "remote") The execution mode that determines whether to use Terraform Cloud as the Terraform execution platform. Only supports "remote" or "agent".
345345
- `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.
346346
- `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.
347-
- `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.
348-
- `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.
347+
- `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.
348+
- `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.
349349

350350
### Task Condition
351351

content/consul/v1.18.x/content/docs/nia/configuration.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -344,9 +344,8 @@ task {
344344
- `execution_mode` - (string: "remote") The execution mode that determines whether to use HCP Terraform as the Terraform execution platform. Only supports "remote" or "agent".
345345
- `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.
346346
- `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.
347-
- `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.
348-
- `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.
349-
347+
- `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.
348+
- `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.
350349

351350
### Task Condition
352351

content/consul/v1.19.x/content/docs/nia/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,8 +344,8 @@ task {
344344
- `execution_mode` - (string: "remote") The execution mode that determines whether to use HCP Terraform as the Terraform execution platform. Only supports "remote" or "agent".
345345
- `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.
346346
- `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.
347-
- `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.
348-
- `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.
347+
- `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.
348+
- `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.
349349

350350
### Task Condition
351351

0 commit comments

Comments
 (0)