diff --git a/.gitignore b/.gitignore index 56f405d09..e58971d63 100644 --- a/.gitignore +++ b/.gitignore @@ -57,3 +57,5 @@ tfe-releases-repos.json # copy-cloud-docs-for-tfe action .github/actions/copy-cloud-docs-for-tfe/node_modules + +.idea diff --git a/content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/opa-versions.mdx b/content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/opa-versions.mdx index 63effadd7..f8722756e 100644 --- a/content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/opa-versions.mdx +++ b/content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/opa-versions.mdx @@ -79,15 +79,30 @@ curl \ "type": "opa-versions", "attributes": { "version": "0.55.0", - "url": "https://github.com/open-policy-agent/opa/releases/download/v0.55.0/opa_linux_arm64_static", - "sha": "d19603df4ab619e98cc515084f62b839464ee5bff61383d1df7724db8a7027a9", + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.55.0/opa_linux_amd64_static", + "sha": "388af161328871b943306f1ba7948658810a9fcf9c3c0a27bdfac6e8086617a9", "deprecated": false, "deprecated-reason": null, "official": true, "enabled": true, "beta": false, "usage": 0, - "created-at": "2023-08-23T22:34:24.561Z" + "created-at": "2023-08-23T22:34:24.561Z", + , + "archs": [ + { + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.55.0/opa_linux_arm64_static", + "sha": "d19603df4ab619e98cc515084f62b839464ee5bff61383d1df7724db8a7027a9", + "os": "linux", + "arch": "arm64" + }, + { + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.55.0/opa_linux_amd64_static", + "sha": "388af161328871b943306f1ba7948658810a9fcf9c3c0a27bdfac6e8086617a9", + "os": "linux", + "arch": "amd64" + } + ] } }, { @@ -95,15 +110,29 @@ curl \ "type": "opa-versions", "attributes": { "version": "0.54.0", - "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static", - "sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8", + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static", + "sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3", "deprecated": false, "deprecated-reason": null, "official": true, "enabled": true, "beta": false, "usage": 2, - "created-at": "2023-08-23T22:34:24.561Z" + "created-at": "2023-08-23T22:34:24.561Z", + "archs": [ + { + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static", + "sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8", + "os": "linux", + "arch": "arm64" + }, + { + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static", + "sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3", + "os": "linux", + "arch": "amd64", + } + ] } } ], @@ -142,17 +171,24 @@ This POST endpoint requires a JSON object with the following properties as a req Properties without a default value are required. -| Key path | Type | Default | Description | -| ----------------------------------- | ------ | ------- | ----------------------------------------------------------------------------------------------------------- | -| `data.type` | string | | Must be `"opa-versions"`. | -| `data.attributes.version` | string | | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). | -| `data.attributes.url` | string | | The URL where you can download the 64-bit Linux binary of this version. | -| `data.attributes.sha` | string | | The SHA-256 checksum of the OPA binary. | -| `data.attributes.deprecated` | bool | `false` | Whether or not this version of OPA is deprecated. | -| `data.attributes.deprecated-reason` | string | `null` | Additional context about why a version of OPA is deprecated. Field is null unless deprecated is `true`. | -| `data.attributes.official` | bool | `false` | Whether or not this is an official release of OPA. | -| `data.attributes.enabled` | bool | `true` | Whether or not this version of OPA is enabled for use in HCP Terraform. | -| `data.attributes.beta` | bool | `false` | Whether or not this version of OPA is a beta pre-release. | +We recommend setting the URL and SHA-256 checksum of an OPA binary in the `archs[n].url` and `archs[n].sha` fields. + +| Key path | Type | Default | Description | +| ----------------------------------- | ------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `data.type` | string | | Must be `"opa-versions"`. | +| `data.attributes.version` | string | | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). | +| `data.attributes.url` | string | | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. | +| `data.attributes.sha` | string | | The SHA-256 checksum of the Linux amd64 OPA binary. This field is under review. We recommend using the `archs[n].sha` field instead. | +| `data.attributes.deprecated` | bool | `false` | Whether or not this version of OPA is deprecated. | +| `data.attributes.deprecated-reason` | string | `null` | Additional context about why a version of OPA is deprecated. Field is null unless deprecated is `true`. | +| `data.attributes.official` | bool | `false` | Whether or not this is an official release of OPA. | +| `data.attributes.enabled` | bool | `true` | Whether or not this version of OPA is enabled for use in HCP Terraform. | +| `data.attributes.beta` | bool | `false` | Whether or not this version of OPA is a beta pre-release. | +| `data.attributes.archs` | array | | An array of architecture objects. | +| `data.attributes.archs[n].url` | string | | The URL where you can download the 64-bit Linux binary of this version. We recommend using this field to set the URL instead of the `url` field. | +| `data.attributes.archs[n].sha` | string | | The SHA-256 checksum of the OPA binary. We recommend using this field to set the checksum instead of the `sha` field. | +| `data.attributes.archs[n].os` | string |`"linux"`| OPA version operating system. | +| `data.attributes.archs[n].arch` | string |`"amd64"`| OPA version architecture. | ### Sample Payload @@ -162,11 +198,23 @@ Properties without a default value are required. "type": "opa-versions", "attributes": { "version": "0.11.8", - "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static", - "sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8", "official": true, "enabled": true, - "beta": false + "beta": false, + "archs": [ + { + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static", + "sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8", + "os": "linux", + "arch": "arm64" + }, + { + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static", + "sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3", + "os": "linux", + "arch": "amd64" + } + ] } } } @@ -192,15 +240,29 @@ curl \ "type": "opa-versions", "attributes": { "version": "0.54.0", - "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static", - "sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8", + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static", + "sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3", "official": true, "deprecated": false, "deprecated-reason": null, "enabled": true, "beta": false, "usage": 0, - "created-at": "2023-08-23T22:34:24.561Z" + "created-at": "2023-08-23T22:34:24.561Z", + "archs": [ + { + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static", + "sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8", + "os": "linux", + "arch": "arm64" + }, + { + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static", + "sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3", + "os": "linux", + "arch": "amd64" + } + ] } } } @@ -237,15 +299,29 @@ curl \ "type": "opa-versions", "attributes": { "version": "0.54.0", - "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static", - "sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8", + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static", + "sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3", "official": true, "deprecated": false, "deprecated-reason": null, "enabled": true, "beta": false, "usage": 0, - "created-at": "2023-08-23T22:34:24.561Z" + "created-at": "2023-08-23T22:34:24.561Z", + "archs": [ + { + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static", + "sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8", + "os": "linux", + "arch": "arm64" + }, + { + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static", + "sha": "633829141f8d6706ac24e0b84393d7730a975a17cc4a15790bf7fad959a28ec3", + "os": "linux", + "arch": "amd64", + } + ] } } } @@ -271,17 +347,26 @@ This PATCH endpoint requires a JSON object with the following properties as a re Properties without a default value are required. -| Key path | Type | Default | Description | -| ----------------------------------- | ------ | ---------------- | ----------------------------------------------------------------------------------------------------- | -| `data.type` | string | | Must be `"opa-versions"`. | -| `data.attributes.version` | string | (previous value) | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). | -| `data.attributes.url` | string | (previous value) | The URL where you can download the 64-bit Linux binary of this version. | -| `data.attributes.sha` | string | (previous value) | The SHA-256 checksum of the OPA binary. | -| `data.attributes.official` | bool | (previous value) | Whether or not this is an official release of OPA. | -| `data.attributes.deprecated` | bool | (previous value) | Whether or not this version of OPA is deprecated. | -| `data.attributes.deprecated-reason` | string | (previous value) | Additional context about why a version of OPA is deprecated. | -| `data.attributes.enabled` | bool | (previous value) | Whether or not this version of OPA is enabled for use in HCP Terraform. | -| `data.attributes.beta` | bool | (previous value) | Whether or not this version of OPA is a beta pre-release. | +We recommend setting the URL and SHA-256 checksum of an OPA binary in the `archs[n].url` and `archs[n].sha` fields. + +| Key path | Type | Default | Description | +| ----------------------------------- | ------ | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `data.type` | string | | Must be `"opa-versions"`. | +| `data.attributes.version` | string | (previous value) | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). | +| `data.attributes.url` | string | (previous value) | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. | +| `data.attributes.sha` | string | (previous value) | The SHA-256 checksum of the Linux amd64 OPA binary. This field is under review. We recommend using the `archs[n].sha` field instead. | +| `data.attributes.official` | bool | (previous value) | Whether or not this is an official release of OPA. | +| `data.attributes.deprecated` | bool | (previous value) | Whether or not this version of OPA is deprecated. | +| `data.attributes.deprecated-reason` | string | (previous value) | Additional context about why a version of OPA is deprecated. | +| `data.attributes.enabled` | bool | (previous value) | Whether or not this version of OPA is enabled for use in HCP Terraform. | +| `data.attributes.beta` | bool | (previous value) | Whether or not this version of OPA is a beta pre-release. | +| `data.attributes.archs` | array | | An array of architecture objects. | +| `data.attributes.archs[n].url` | string | | The URL where you can download the 64-bit Linux binary of this version. We recommend using this field to set the URL instead of the `url` field. | +| `data.attributes.archs[n].sha` | string | | The SHA-256 checksum of the OPA binary. We recommend using this field to set the checksum instead of the `sha` field. | +| `data.attributes.archs[n].os` | string |`"linux"`| OPA version operating system. | +| `data.attributes.archs[n].arch` | string |`"amd64"`| OPA version architecture. | + + ### Sample Payload @@ -291,7 +376,21 @@ Properties without a default value are required. "type": "opa-versions", "attributes": { "deprecated": true, - "deprecated-reason": "A bug was discovered in this version of OPA. Please upgrade as soon as possible" + "deprecated-reason": "A bug was discovered in this version of OPA. Please upgrade as soon as possible", + "archs": [ + { + "os": "linux", + "arch": "arm64", + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static", + "sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8" + }, + { + "os": "linux", + "arch": "amd64", + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static", + "sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8" + } + ] } } } @@ -325,7 +424,21 @@ curl \ "enabled": true, "beta": false, "usage": 0, - "created-at": "2023-08-23T22:34:24.561Z" + "created-at": "2023-08-23T22:34:24.561Z", + "archs": [ + { + "os": "linux", + "arch": "arm64", + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_arm64_static", + "sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8" + }, + { + "os": "linux", + "arch": "amd64", + "url": "https://github.com/open-policy-agent/opa/releases/download/v0.54.0/opa_linux_amd64_static", + "sha": "883e22c082508e2f95ba25333559ba8a5c38c9c5ef667314e132c9d8451450d8" + } + ] } } } diff --git a/content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/sentinel-versions.mdx b/content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/sentinel-versions.mdx index 74c34ff62..e636ae88c 100644 --- a/content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/sentinel-versions.mdx +++ b/content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/sentinel-versions.mdx @@ -91,7 +91,21 @@ curl \ "enabled": true, "beta": false, "usage": 0, - "created-at": "2023-08-23T22:34:24.561Z" + "created-at": "2023-08-23T22:34:24.561Z", + "archs": [ + { + "url": "https://releases.hashicorp.com/sentinel/0.22.1/sentinel_0.22.1_linux_amd64.zip", + "sha": "0a4a2b2baf46bfeb81d5137b2656b159ccc881487df3bebacd350ea48b53e76c", + "os": "linux", + "arch": "amd64" + }, + { + "url": "https://releases.hashicorp.com/sentinel/0.21.1/sentinel_0.21.1_linux_arm64.zip", + "sha": "30cae26f232ec12bc1312e3a017d5d60fd304ff8ced16594627bba7ac0942db3", + "os": "linux", + "arch": "arm64" + } + ] } } ], @@ -130,17 +144,24 @@ This POST endpoint requires a JSON object with the following properties as a req Properties without a default value are required. -| Key path | Type | Default | Description | -| ----------------------------------- | ------ | ------- | ------------------------------------------------------------------------------------------------------------ | -| `data.type` | string | | Must be `"sentinel-versions"`. | -| `data.attributes.version` | string | | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). | -| `data.attributes.url` | string | | The URL where you can download the 64-bit Linux binary of this version. | -| `data.attributes.sha` | string | | The SHA-256 checksum of the compressed Sentinel binary. | -| `data.attributes.deprecated` | bool | `false` | Whether or not this version of Sentinel is deprecated. | -| `data.attributes.deprecated-reason` | string | `null` | Additional context about why a version of Sentinel is deprecated. Field is null unless deprecated is `true`. | -| `data.attributes.official` | bool | `false` | Whether or not this is an official release of Sentinel. | -| `data.attributes.enabled` | bool | `true` | Whether or not this version of Sentinel is enabled for use in HCP Terraform. | -| `data.attributes.beta` | bool | `false` | Whether or not this version of Sentinel is a beta pre-release. | +We recommend setting the URL and SHA-256 checksum of a Sentinel binary in the `archs[n].url` and `archs[n].sha` fields. + +| Key path | Type | Default | Description | +| ----------------------------------- | ------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `data.type` | string | | Must be `"sentinel-versions"`. | +| `data.attributes.version` | string | | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). | +| `data.attributes.url` | string | | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. | +| `data.attributes.sha` | string | | The SHA-256 checksum of the Linux amd64 Sentinel binary. This field is under review. We recommend using the `archs[n].sha` field instead. | +| `data.attributes.deprecated` | bool | `false` | Whether or not this version of Sentinel is deprecated. | +| `data.attributes.deprecated-reason` | string | `null` | Additional context about why a version of Sentinel is deprecated. Field is null unless deprecated is `true`. | +| `data.attributes.official` | bool | `false` | Whether or not this is an official release of Sentinel. | +| `data.attributes.enabled` | bool | `true` | Whether or not this version of Sentinel is enabled for use in HCP Terraform. | +| `data.attributes.beta` | bool | `false` | Whether or not this version of Sentinel is a beta pre-release. | +| `data.attributes.archs` | array | | An array of architecture objects. | +| `data.attributes.archs[n].url` | string | | The URL where you can download the 64-bit Linux binary of this version. We recommend using this field to set the URL instead of the `url` field. | +| `data.attributes.archs[n].sha` | string | | The SHA-256 checksum of the Sentinel binary. We recommend using this field to set the checksum instead of the `sha` field. | +| `data.attributes.archs[n].os` | string |`"linux"`| Sentinel version operating system. | +| `data.attributes.archs[n].arch` | string |`"amd64"`| Sentinel version architecture. | ### Sample Payload @@ -150,11 +171,23 @@ Properties without a default value are required. "type": "sentinel-versions", "attributes": { "version": "0.22.1", - "url": "https://releases.hashicorp.com/sentinel/0.22.1/sentinel_0.22.1_linux_amd64.zip", - "sha": "0a4a2b2baf46bfeb81d5137b2656b159ccc881487df3bebacd350ea48b53e76c", "official": true, "enabled": true, - "beta": false + "beta": false, + "archs": [ + { + "url": "https://releases.hashicorp.com/sentinel/0.22.1/sentinel_0.22.1_linux_amd64.zip", + "sha": "0a4a2b2baf46bfeb81d5137b2656b159ccc881487df3bebacd350ea48b53e76c", + "os": "linux", + "arch": "amd64" + }, + { + "url": "https://releases.hashicorp.com/sentinel/0.21.1/sentinel_0.21.1_linux_arm64.zip", + "sha": "30cae26f232ec12bc1312e3a017d5d60fd304ff8ced16594627bba7ac0942db3", + "os": "linux", + "arch": "arm64" + } + ] } } } @@ -188,7 +221,21 @@ curl \ "enabled": true, "beta": false, "usage": 0, - "created-at": "2023-08-23T22:34:24.561Z" + "created-at": "2023-08-23T22:34:24.561Z", + "archs": [ + { + "url": "https://releases.hashicorp.com/sentinel/0.22.1/sentinel_0.22.1_linux_amd64.zip", + "sha": "0a4a2b2baf46bfeb81d5137b2656b159ccc881487df3bebacd350ea48b53e76c", + "os": "linux", + "arch": "amd64" + }, + { + "url": "https://releases.hashicorp.com/sentinel/0.21.1/sentinel_0.21.1_linux_arm64.zip", + "sha": "30cae26f232ec12bc1312e3a017d5d60fd304ff8ced16594627bba7ac0942db3", + "os": "linux", + "arch": "arm64" + } + ] } } } @@ -233,7 +280,21 @@ curl \ "enabled": true, "beta": false, "usage": 0, - "created-at": "2023-08-23T22:34:24.561Z" + "created-at": "2023-08-23T22:34:24.561Z", + "archs": [ + { + "url": "https://releases.hashicorp.com/sentinel/0.22.1/sentinel_0.22.1_linux_amd64.zip", + "sha": "0a4a2b2baf46bfeb81d5137b2656b159ccc881487df3bebacd350ea48b53e76c", + "os": "linux", + "arch": "amd64" + }, + { + "url": "https://releases.hashicorp.com/sentinel/0.21.1/sentinel_0.21.1_linux_arm64.zip", + "sha": "30cae26f232ec12bc1312e3a017d5d60fd304ff8ced16594627bba7ac0942db3", + "os": "linux", + "arch": "arm64" + } + ] } } } @@ -259,17 +320,25 @@ This PATCH endpoint requires a JSON object with the following properties as a re Properties without a default value are required. -| Key path | Type | Default | Description | -| ----------------------------------- | ------ | ---------------- | --------------------------------------------------------------------------------------------------- | -| `data.type` | string | | Must be `"sentinel-versions"`. | -| `data.attributes.version` | string | (previous value) | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"`, `"0.12.20-beta1"`). | -| `data.attributes.url` | string | (previous value) | The URL you can download the 64-bit Linux binary of this version. | -| `data.attributes.sha` | string | (previous value) | The SHA-256 checksum of the compressed Sentinel binary. | -| `data.attributes.official` | bool | (previous value) | Whether or not this is an official release of Sentinel. | -| `data.attributes.deprecated` | bool | (previous value) | Whether or not this version of Sentinel is deprecated. | -| `data.attributes.deprecated-reason` | string | (previous value) | Additional context about why a version of Sentinel is deprecated. | -| `data.attributes.enabled` | bool | (previous value) | Whether or not this version of Sentinel is enabled for use in HCP Terraform. | -| `data.attributes.beta` | bool | (previous value) | Whether or not this version of Sentinel is a beta pre-release. | +We recommend setting the URL and SHA-256 checksum of a Sentinel binary in the `archs[n].url` and `archs[n].sha` fields. + +| Key path | Type | Default | Description | +| ----------------------------------- | ------ | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `data.type` | string | | Must be `"sentinel-versions"`. | +| `data.attributes.version` | string | (previous value) | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). | +| `data.attributes.url` | string | (previous value) | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. | +| `data.attributes.sha` | string | (previous value) | The SHA-256 checksum of the Linux amd64 Sentinel binary. This field is under review. We recommend using the `archs[n].sha` field instead. | +| `data.attributes.official` | bool | (previous value) | Whether or not this is an official release of Sentinel. | +| `data.attributes.deprecated` | bool | (previous value) | Whether or not this version of Sentinel is deprecated. | +| `data.attributes.deprecated-reason` | string | (previous value) | Additional context about why a version of Sentinel is deprecated. | +| `data.attributes.enabled` | bool | (previous value) | Whether or not this version of Sentinel is enabled for use in HCP Terraform. | +| `data.attributes.beta` | bool | (previous value) | Whether or not this version of Sentinel is a beta pre-release. | +| `data.attributes.archs` | array | | An array of architecture objects. | +| `data.attributes.archs[n].url` | string | | The URL where you can download the 64-bit Linux binary of this version. We recommend using this field to set the URL instead of the `url` field. | +| `data.attributes.archs[n].sha` | string | | The SHA-256 checksum of the Sentinel binary. We recommend using this field to set the checksum instead of the `sha` field. | +| `data.attributes.archs[n].os` | string |`"linux"`| Sentinel version operating system. | +| `data.attributes.archs[n].arch` | string |`"amd64"`| Sentinel version architecture. | + ### Sample Payload @@ -313,7 +382,21 @@ curl \ "enabled": true, "beta": false, "usage": 0, - "created-at": "2023-08-23T22:34:24.561Z" + "created-at": "2023-08-23T22:34:24.561Z", + "archs": [ + { + "url": "https://releases.hashicorp.com/sentinel/0.22.1/sentinel_0.22.1_linux_amd64.zip", + "sha": "0a4a2b2baf46bfeb81d5137b2656b159ccc881487df3bebacd350ea48b53e76c", + "os": "linux", + "arch": "amd64" + }, + { + "url": "https://releases.hashicorp.com/sentinel/0.21.1/sentinel_0.21.1_linux_arm64.zip", + "sha": "30cae26f232ec12bc1312e3a017d5d60fd304ff8ced16594627bba7ac0942db3", + "os": "linux", + "arch": "arm64" + } + ] } } } @@ -343,4 +426,4 @@ curl \ --header "Content-Type: application/vnd.api+json" \ --request DELETE \ https://app.terraform.io/api/v2/admin/sentinel-versions/tool-L4oe7rNwn7J4E5Yr -``` +``` \ No newline at end of file diff --git a/content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/terraform-versions.mdx b/content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/terraform-versions.mdx index d96eeff06..9f360d29d 100644 --- a/content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/terraform-versions.mdx +++ b/content/terraform-enterprise/v202506-1/docs/enterprise/api-docs/admin/terraform-versions.mdx @@ -92,24 +92,36 @@ curl \ "enabled": true, "beta": false, "usage": 0, - "created-at": "2018-08-15T22:34:24.561Z" + "created-at": "2018-08-15T22:34:24.561Z", + "archs": [ + { + "url": "https://releases.hashicorp.com/terraform/0.11.8/terraform_0.11.8_linux_amd64.zip", + "sha": "84ccfb8e13b5fce63051294f787885b76a1fedef6bdbecf51c5e586c9e20c9b7", + "os": "linux", + "arch": "amd64" + } + ] } }, { - "id": "tool-qcbYn12vuRKPgPpy", - "type": "terraform-versions", - "attributes": { - "version": "0.11.7", - "url": "https://releases.hashicorp.com/terraform/0.11.7/terraform_0.11.7_linux_amd64.zip", - "sha": "6b8ce67647a59b2a3f70199c304abca0ddec0e49fd060944c26f666298e23418", - "deprecated": false, - "deprecated-reason": null, - "official": true, - "enabled": true, - "beta": false, - "usage": 2, - "created-at": null - } + "version": "0.14.6", + "official": true, + "enabled": true, + "beta": false, + "archs": [ + { + "url": "https://releases.hashicorp.com/terraform/0.14.6/terraform_0.14.6_linux_amd64.zip", + "sha": "63a5a45edde435fa3f278c86ce96346ee7f6b204ea949734f26f963b7dbc1074", + "os": "linux", + "arch": "amd64" + }, + { + "url": "https://releases.hashicorp.com/terraform/0.14.6/terraform_0.14.6_linux_arm64.zip", + "sha": "512791e0a6185b7a895cfe112c289d5d2fb816112406772134343bbe4f1f4a63", + "os": "linux", + "arch": "arm64" + } + ] } ], "links": { @@ -147,17 +159,24 @@ This POST endpoint requires a JSON object with the following properties as a req Properties without a default value are required. -| Key path | Type | Default | Description | -| ----------------------------------- | ------ | ------- | ----------------------------------------------------------------------------------------------------------- | -| `data.type` | string | | Must be `"terraform-versions"` | -| `data.attributes.version` | string | | A semantic version string in N.N.N or N.N.N-bundleName format (e.g. `"0.11.0"`, `"0.12.20-beta1"`.) | -| `data.attributes.url` | string | | The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded | -| `data.attributes.sha` | string | | The SHA-256 checksum of the compressed Terraform binary | -| `data.attributes.deprecated` | bool | `false` | Whether or not this version of Terraform is deprecated | -| `data.attributes.deprecated-reason` | string | `null` | Additional context about why a version of Terraform is deprecated. Field is null unless deprecated is true. | -| `data.attributes.official` | bool | `false` | Whether or not this is an official release of Terraform | -| `data.attributes.enabled` | bool | `true` | Whether or not this version of Terraform is enabled for use in HCP Terraform | -| `data.attributes.beta` | bool | `false` | Whether or not this version of Terraform is a beta pre-release | +We recommend setting the URL and SHA-256 checksum of a Terraform binary in the `archs[n].url` and `archs[n].sha` fields. + +| Key path | Type | Default | Description | +| ----------------------------------- | ------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `data.type` | string | | Must be `"terraform-versions"`. | +| `data.attributes.version` | string | | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). | +| `data.attributes.url` | string | | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. | +| `data.attributes.sha` | string | | The SHA-256 checksum of the Linux amd64 Terraform binary. This field is under review. We recommend using the `archs[n].sha` field instead. | +| `data.attributes.deprecated` | bool | `false` | Whether or not this version of Terraform is deprecated. | +| `data.attributes.deprecated-reason` | string | `null` | Additional context about why a version of Terraform is deprecated. Field is null unless deprecated is `true`. | +| `data.attributes.official` | bool | `false` | Whether or not this is an official release of Terraform. | +| `data.attributes.enabled` | bool | `true` | Whether or not this version of Terraform is enabled for use in HCP Terraform. | +| `data.attributes.beta` | bool | `false` | Whether or not this version of Terraform is a beta pre-release. | +| `data.attributes.archs` | array | | An array of architecture objects. | +| `data.attributes.archs[n].url` | string | | The URL where you can download the 64-bit Linux binary of this version. We recommend using this field to set the URL instead of the `url` field. | +| `data.attributes.archs[n].sha` | string | | The SHA-256 checksum of the Terraform binary. We recommend using this field to set the checksum instead of the `sha` field. | +| `data.attributes.archs[n].os` | string |`"linux"`| Terraform version operating system. | +| `data.attributes.archs[n].arch` | string |`"amd64"`| Terraform version architecture. | ### Sample Payload @@ -166,12 +185,24 @@ Properties without a default value are required. "data": { "type": "terraform-versions", "attributes": { - "version": "0.11.8", - "url": "https://releases.hashicorp.com/terraform/0.11.8/terraform_0.11.8_linux_amd64.zip", - "sha": "84ccfb8e13b5fce63051294f787885b76a1fedef6bdbecf51c5e586c9e20c9b7", + "version": "0.14.6", "official": true, "enabled": true, - "beta": false + "beta": false, + "archs": [ + { + "url": "https://releases.hashicorp.com/terraform/0.14.6/terraform_0.14.6_linux_amd64.zip", + "sha": "63a5a45edde435fa3f278c86ce96346ee7f6b204ea949734f26f963b7dbc1074", + "os": "linux", + "arch": "amd64" + }, + { + "url": "https://releases.hashicorp.com/terraform/0.14.6/terraform_0.14.6_linux_arm64.zip", + "sha": "512791e0a6185b7a895cfe112c289d5d2fb816112406772134343bbe4f1f4a63", + "os": "linux", + "arch": "arm64" + } + ] } } } @@ -196,16 +227,30 @@ curl \ "id": "tool-L4oe7rNwn7J4E5Yr", "type": "terraform-versions", "attributes": { - "version": "0.11.8", - "url": "https://releases.hashicorp.com/terraform/0.11.8/terraform_0.11.8_linux_amd64.zip", - "sha": "84ccfb8e13b5fce63051294f787885b76a1fedef6bdbecf51c5e586c9e20c9b7", + "version": "0.14.6", + "url": "https://releases.hashicorp.com/terraform/0.14.6/terraform_0.14.6_linux_amd64.zip", + "sha": "63a5a45edde435fa3f278c86ce96346ee7f6b204ea949734f26f963b7dbc1074", "official": true, "deprecated": false, "deprecated-reason": null, "enabled": true, "beta": false, "usage": 0, - "created-at": "2018-08-15T22:34:24.561Z" + "created-at": "2018-08-15T22:34:24.561Z", + "archs": [ + { + "url": "https://releases.hashicorp.com/terraform/0.14.6/terraform_0.14.6_linux_amd64.zip", + "sha": "63a5a45edde435fa3f278c86ce96346ee7f6b204ea949734f26f963b7dbc1074", + "os": "linux", + "arch": "amd64" + }, + { + "url": "https://releases.hashicorp.com/terraform/0.14.6/terraform_0.14.6_linux_arm64.zip", + "sha": "512791e0a6185b7a895cfe112c289d5d2fb816112406772134343bbe4f1f4a63", + "os": "linux", + "arch": "arm64" + } + ] } } } @@ -241,16 +286,30 @@ curl \ "id": "tool-L4oe7rNwn7J4E5Yr", "type": "terraform-versions", "attributes": { - "version": "0.11.8", - "url": "https://releases.hashicorp.com/terraform/0.11.8/terraform_0.11.8_linux_amd64.zip", - "sha": "84ccfb8e13b5fce63051294f787885b76a1fedef6bdbecf51c5e586c9e20c9b7", + "version": "0.14.6", + "url": "https://releases.hashicorp.com/terraform/0.14.6/terraform_0.14.6_linux_amd64.zip", + "sha": "63a5a45edde435fa3f278c86ce96346ee7f6b204ea949734f26f963b7dbc1074", "official": true, "deprecated": false, "deprecated-reason": null, "enabled": true, "beta": false, "usage": 0, - "created-at": "2018-08-15T22:34:24.561Z" + "created-at": "2018-08-15T22:34:24.561Z", + "archs": [ + { + "url": "https://releases.hashicorp.com/terraform/0.14.6/terraform_0.14.6_linux_amd64.zip", + "sha": "63a5a45edde435fa3f278c86ce96346ee7f6b204ea949734f26f963b7dbc1074", + "os": "linux", + "arch": "amd64" + }, + { + "url": "https://releases.hashicorp.com/terraform/0.14.6/terraform_0.14.6_linux_arm64.zip", + "sha": "512791e0a6185b7a895cfe112c289d5d2fb816112406772134343bbe4f1f4a63", + "os": "linux", + "arch": "arm64" + } + ] } } } @@ -276,17 +335,24 @@ This PATCH endpoint requires a JSON object with the following properties as a re Properties without a default value are required. -| Key path | Type | Default | Description | -| ----------------------------------- | ------ | ---------------- | --------------------------------------------------------------------------------------------------- | -| `data.type` | string | | Must be `"terraform-versions"` | -| `data.attributes.version` | string | (previous value) | A semantic version string in N.N.N or N.N.N-bundleName format (e.g. `"0.11.0"`, `"0.12.20-beta1"`.) | -| `data.attributes.url` | string | (previous value) | The URL where a ZIP-compressed 64-bit Linux binary of this version can be downloaded | -| `data.attributes.sha` | string | (previous value) | The SHA-256 checksum of the compressed Terraform binary | -| `data.attributes.official` | bool | (previous value) | Whether or not this is an official release of Terraform | -| `data.attributes.deprecated` | bool | (previous value) | Whether or not this version of Terraform is deprecated | -| `data.attributes.deprecated-reason` | string | (previous value) | Additional context about why a version of Terraform is deprecated. | -| `data.attributes.enabled` | bool | (previous value) | Whether or not this version of Terraform is enabled for use in HCP Terraform | -| `data.attributes.beta` | bool | (previous value) | Whether or not this version of Terraform is a beta pre-release | +We recommend setting the URL and SHA-256 checksum of a Terraform binary in the `archs[n].url` and `archs[n].sha` fields. + +| Key path | Type | Default | Description | +| ----------------------------------- | ------ | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `data.type` | string | | Must be `"terraform-versions"`. | +| `data.attributes.version` | string | (previous value) | A semantic version string in N.N.N or N.N.N-bundleName format (`"0.11.0"` or `"0.12.20-beta1"`). | +| `data.attributes.url` | string | (previous value) | The URL where you can download the Linux amd64 binary of this version. This field is under review. We recommend using the `archs[n].url` field instead. | +| `data.attributes.sha` | string | (previous value) | The SHA-256 checksum of the Linux amd64 Terraform binary. This field is under review. We recommend using the `archs[n].sha` field instead. | +| `data.attributes.official` | bool | (previous value) | Whether or not this is an official release of Terraform. | +| `data.attributes.deprecated` | bool | (previous value) | Whether or not this version of Terraform is deprecated. | +| `data.attributes.deprecated-reason` | string | (previous value) | Additional context about why a version of Terraform is deprecated. | +| `data.attributes.enabled` | bool | (previous value) | Whether or not this version of Terraform is enabled for use in HCP Terraform. | +| `data.attributes.beta` | bool | (previous value) | Whether or not this version of Terraform is a beta pre-release. | +| `data.attributes.archs` | array | | An array of architecture objects. | +| `data.attributes.archs[n].url` | string | | The URL where you can download the 64-bit Linux binary of this version. We recommend using this field to set the URL instead of the `url` field. | +| `data.attributes.archs[n].sha` | string | | The SHA-256 checksum of the Terraform binary. We recommend using this field to set the checksum instead of the `sha` field. | +| `data.attributes.archs[n].os` | string |`"linux"`| Terraform version operating system. | +| `data.attributes.archs[n].arch` | string |`"amd64"`| Terraform version architecture. | ### Sample Payload @@ -321,16 +387,30 @@ curl \ "id": "tool-L4oe7rNwn7J4E5Yr", "type": "terraform-versions", "attributes": { - "version": "0.11.8", - "url": "https://releases.hashicorp.com/terraform/0.11.8/terraform_0.11.8_linux_amd64.zip", - "sha": "84ccfb8e13b5fce63051294f787885b76a1fedef6bdbecf51c5e586c9e20c9b7", + "version": "0.14.6", + "url": "https://releases.hashicorp.com/terraform/0.14.6/terraform_0.14.6_linux_amd64.zip", + "sha": "63a5a45edde435fa3f278c86ce96346ee7f6b204ea949734f26f963b7dbc1074", "official": true, "deprecated": true, "deprecated-reason": "A bug was discovered in this version of Terraform. Please upgrade as soon as possible", "enabled": true, "beta": false, "usage": 0, - "created-at": "2018-08-15T22:34:24.561Z" + "created-at": "2018-08-15T22:34:24.561Z", + "archs": [ + { + "url": "https://releases.hashicorp.com/terraform/0.14.6/terraform_0.14.6_linux_amd64.zip", + "sha": "63a5a45edde435fa3f278c86ce96346ee7f6b204ea949734f26f963b7dbc1074", + "os": "linux", + "arch": "amd64" + }, + { + "url": "https://releases.hashicorp.com/terraform/0.14.6/terraform_0.14.6_linux_arm64.zip", + "sha": "512791e0a6185b7a895cfe112c289d5d2fb816112406772134343bbe4f1f4a63", + "os": "linux", + "arch": "arm64" + } + ] } } } @@ -360,4 +440,4 @@ curl \ --header "Content-Type: application/vnd.api+json" \ --request DELETE \ https://app.terraform.io/api/v2/admin/terraform-versions/tool-L4oe7rNwn7J4E5Yr -``` +``` \ No newline at end of file diff --git a/content/terraform-enterprise/v202506-1/docs/enterprise/application-administration/opa-tool-versions.mdx b/content/terraform-enterprise/v202506-1/docs/enterprise/application-administration/opa-tool-versions.mdx index e3eb94ab2..fae0ff407 100644 --- a/content/terraform-enterprise/v202506-1/docs/enterprise/application-administration/opa-tool-versions.mdx +++ b/content/terraform-enterprise/v202506-1/docs/enterprise/application-administration/opa-tool-versions.mdx @@ -23,6 +23,7 @@ You must have one of the following user roles to access the **OPA Versions** pag 1. Click **Add OPA version**. 1. In the **Version** text box, enter the version number you want to add, for example `0.44.0`. 1. Enable the **Enable this version** option. +1. In the **OS Architecture** drop-down list, select `Linux amd64`. 1. In the **URL** text box, enter `https://github.com/open-policy-agent/opa/releases/download/v0.44.0/opa_linux_amd64_static`. 1. In the **SHA256 Checksum** text box, enter `5ddb21d3fcfca130a47a42e730c05f055c68af6c1b37465879f6c59b10527eae`. 1. Click **Add OPA version** to complete the setup. diff --git a/content/terraform-enterprise/v202506-1/docs/enterprise/application-administration/sentinel-tool-versions.mdx b/content/terraform-enterprise/v202506-1/docs/enterprise/application-administration/sentinel-tool-versions.mdx index 1ed6a1039..8abe06d95 100644 --- a/content/terraform-enterprise/v202506-1/docs/enterprise/application-administration/sentinel-tool-versions.mdx +++ b/content/terraform-enterprise/v202506-1/docs/enterprise/application-administration/sentinel-tool-versions.mdx @@ -23,6 +23,7 @@ You must have one of the following user roles to access the **Sentinel Versions* 1. Click **Add Sentinel version**. 1. Enter `0.24.2` for **Version**. 1. Check the **Enable this version** box. +1. In the **OS Architecture** drop-down list, select `Linux amd64`. 1. Enter `https://releases.hashicorp.com/sentinel/0.24.2/sentinel_0.24.2_linux_amd64.zip` for the **URL**. 1. Enter `a17aad9797e7b9b0072c887c2e761703e2bee742ff327011ccec5e6686fc5b8b` as your **SHA256 Checksum**. 1. Click **Add Sentinel version**.