Merge remote-tracking branch 'origin/main' into tmm/k8gent_worker

.github/workflows/docs.yml

@@ -0,0 +1,19 @@
+name: Validate Docs
+on:
+  push:
+    branches:
+      - '**'
+  workflow_dispatch:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-go@v3
+        with:
+          go-version: '1.22'
+      - run: go generate main.go
+      - name: Check for file changes
+        run: git diff --exit-code

docs/data-sources/accounts.md

@@ -26,7 +26,7 @@ data "octopusdeploy_accounts" "example" {
 
 ### Optional
 
-- `account_type` (String) A filter to search by a list of account types.  Valid account types are `AmazonWebServicesAccount`, `AmazonWebServicesRoleAccount`, `AzureServicePrincipal`, `AzureSubscription`, `None`, `SshKeyPair`, `Token`, or `UsernamePassword`.
+- `account_type` (String) A filter to search by a list of account types.  Valid account types are `AmazonWebServicesAccount`, `AmazonWebServicesRoleAccount`, `AmazonWebServicesOidcAccount`, `AzureServicePrincipal`, `AzureSubscription`, `None`, `SshKeyPair`, `Token`, or `UsernamePassword`.
 - `ids` (List of String) A filter to search by a list of IDs.
 - `partial_name` (String) A filter to search by the partial match of a name.
 - `skip` (Number) A filter to specify the number of items to skip in the response.

docs/data-sources/azure_cloud_service_deployment_targets.md

@@ -45,44 +45,44 @@ data "octopusdeploy_azure_cloud_service_deployment_targets" "example" {
 
 ### Read-Only
 
-- `azure_cloud_service_deployment_targets` (Block List) A list of Azure cloud service deployment targets that match the filter(s). (see [below for nested schema](#nestedblock--azure_cloud_service_deployment_targets))
+- `azure_cloud_service_deployment_targets` (List of Object) A list of Azure cloud service deployment targets that match the filter(s). (see [below for nested schema](#nestedatt--azure_cloud_service_deployment_targets))
 - `id` (String) An auto-generated identifier that includes the timestamp when this data source was last modified.
 
-<a id="nestedblock--azure_cloud_service_deployment_targets"></a>
+<a id="nestedatt--azure_cloud_service_deployment_targets"></a>
 ### Nested Schema for `azure_cloud_service_deployment_targets`
 
 Read-Only:
 
 - `account_id` (String)
 - `cloud_service_name` (String)
 - `default_worker_pool_id` (String)
-- `endpoint` (List of Object) (see [below for nested schema](#nestedatt--azure_cloud_service_deployment_targets--endpoint))
-- `environments` (List of String) A list of environment IDs associated with this resource.
+- `endpoint` (List of Object) (see [below for nested schema](#nestedobjatt--azure_cloud_service_deployment_targets--endpoint))
+- `environments` (List of String)
 - `has_latest_calamari` (Boolean)
-- `health_status` (String) Represents the health status of this deployment target. Valid health statuses are `HasWarnings`, `Healthy`, `Unavailable`, `Unhealthy`, or `Unknown`.
-- `id` (String) The unique ID for this resource.
+- `health_status` (String)
+- `id` (String)
 - `is_disabled` (Boolean)
 - `is_in_process` (Boolean)
 - `machine_policy_id` (String)
-- `name` (String) The name of this resource.
+- `name` (String)
 - `operating_system` (String)
 - `roles` (List of String)
 - `shell_name` (String)
 - `shell_version` (String)
 - `slot` (String)
-- `space_id` (String) The space ID associated with this resource.
-- `status` (String) The status of this resource. Valid statuses are `CalamariNeedsUpgrade`, `Disabled`, `NeedsUpgrade`, `Offline`, `Online`, or `Unknown`.
-- `status_summary` (String) A summary elaborating on the status of this resource.
+- `space_id` (String)
+- `status` (String)
+- `status_summary` (String)
 - `storage_account_name` (String)
 - `swap_if_possible` (Boolean)
-- `tenant_tags` (List of String) A list of tenant tags associated with this resource.
-- `tenanted_deployment_participation` (String) The tenanted deployment mode of the resource. Valid account types are `Untenanted`, `TenantedOrUntenanted`, or `Tenanted`.
-- `tenants` (List of String) A list of tenant IDs associated with this resource.
+- `tenant_tags` (List of String)
+- `tenanted_deployment_participation` (String)
+- `tenants` (List of String)
 - `thumbprint` (String)
 - `uri` (String)
 - `use_current_instance_count` (Boolean)
 
-<a id="nestedatt--azure_cloud_service_deployment_targets--endpoint"></a>
+<a id="nestedobjatt--azure_cloud_service_deployment_targets--endpoint"></a>
 ### Nested Schema for `azure_cloud_service_deployment_targets.endpoint`
 
 Read-Only:

docs/data-sources/azure_service_fabric_cluster_deployment_targets.md

@@ -45,47 +45,47 @@ data "octopusdeploy_azure_service_fabric_cluster_deployment_targets" "example" {
 
 ### Read-Only
 
-- `azure_service_fabric_cluster_deployment_targets` (Block List) A list of Azure service fabric cluster deployment targets that match the filter(s). (see [below for nested schema](#nestedblock--azure_service_fabric_cluster_deployment_targets))
+- `azure_service_fabric_cluster_deployment_targets` (List of Object) A list of Azure service fabric cluster deployment targets that match the filter(s). (see [below for nested schema](#nestedatt--azure_service_fabric_cluster_deployment_targets))
 - `id` (String) An auto-generated identifier that includes the timestamp when this data source was last modified.
 
-<a id="nestedblock--azure_service_fabric_cluster_deployment_targets"></a>
+<a id="nestedatt--azure_service_fabric_cluster_deployment_targets"></a>
 ### Nested Schema for `azure_service_fabric_cluster_deployment_targets`
 
 Read-Only:
 
 - `aad_client_credential_secret` (String)
 - `aad_credential_type` (String)
-- `aad_user_credential_password` (String, Sensitive)
+- `aad_user_credential_password` (String)
 - `aad_user_credential_username` (String)
 - `certificate_store_location` (String)
 - `certificate_store_name` (String)
 - `client_certificate_variable` (String)
 - `connection_endpoint` (String)
-- `endpoint` (List of Object) (see [below for nested schema](#nestedatt--azure_service_fabric_cluster_deployment_targets--endpoint))
-- `environments` (List of String) A list of environment IDs associated with this resource.
+- `endpoint` (List of Object) (see [below for nested schema](#nestedobjatt--azure_service_fabric_cluster_deployment_targets--endpoint))
+- `environments` (List of String)
 - `has_latest_calamari` (Boolean)
-- `health_status` (String) Represents the health status of this deployment target. Valid health statuses are `HasWarnings`, `Healthy`, `Unavailable`, `Unhealthy`, or `Unknown`.
-- `id` (String) The unique ID for this resource.
+- `health_status` (String)
+- `id` (String)
 - `is_disabled` (Boolean)
 - `is_in_process` (Boolean)
 - `machine_policy_id` (String)
-- `name` (String) The name of this resource.
+- `name` (String)
 - `operating_system` (String)
 - `roles` (List of String)
 - `security_mode` (String)
 - `server_certificate_thumbprint` (String)
 - `shell_name` (String)
 - `shell_version` (String)
-- `space_id` (String) The space ID associated with this resource.
-- `status` (String) The status of this resource. Valid statuses are `CalamariNeedsUpgrade`, `Disabled`, `NeedsUpgrade`, `Offline`, `Online`, or `Unknown`.
-- `status_summary` (String) A summary elaborating on the status of this resource.
-- `tenant_tags` (List of String) A list of tenant tags associated with this resource.
-- `tenanted_deployment_participation` (String) The tenanted deployment mode of the resource. Valid account types are `Untenanted`, `TenantedOrUntenanted`, or `Tenanted`.
-- `tenants` (List of String) A list of tenant IDs associated with this resource.
+- `space_id` (String)
+- `status` (String)
+- `status_summary` (String)
+- `tenant_tags` (List of String)
+- `tenanted_deployment_participation` (String)
+- `tenants` (List of String)
 - `thumbprint` (String)
 - `uri` (String)
 
-<a id="nestedatt--azure_service_fabric_cluster_deployment_targets--endpoint"></a>
+<a id="nestedobjatt--azure_service_fabric_cluster_deployment_targets--endpoint"></a>
 ### Nested Schema for `azure_service_fabric_cluster_deployment_targets.endpoint`
 
 Read-Only:

docs/data-sources/azure_web_app_deployment_targets.md

@@ -45,41 +45,41 @@ data "octopusdeploy_azure_web_app_deployment_targets" "example" {
 
 ### Read-Only
 
-- `azure_web_app_deployment_targets` (Block List) A list of Azure web app deployment targets that match the filter(s). (see [below for nested schema](#nestedblock--azure_web_app_deployment_targets))
+- `azure_web_app_deployment_targets` (List of Object) A list of Azure web app deployment targets that match the filter(s). (see [below for nested schema](#nestedatt--azure_web_app_deployment_targets))
 - `id` (String) An auto-generated identifier that includes the timestamp when this data source was last modified.
 
-<a id="nestedblock--azure_web_app_deployment_targets"></a>
+<a id="nestedatt--azure_web_app_deployment_targets"></a>
 ### Nested Schema for `azure_web_app_deployment_targets`
 
 Read-Only:
 
 - `account_id` (String)
-- `endpoint` (List of Object) (see [below for nested schema](#nestedatt--azure_web_app_deployment_targets--endpoint))
-- `environments` (List of String) A list of environment IDs associated with this resource.
+- `endpoint` (List of Object) (see [below for nested schema](#nestedobjatt--azure_web_app_deployment_targets--endpoint))
+- `environments` (List of String)
 - `has_latest_calamari` (Boolean)
-- `health_status` (String) Represents the health status of this deployment target. Valid health statuses are `HasWarnings`, `Healthy`, `Unavailable`, `Unhealthy`, or `Unknown`.
-- `id` (String) The unique ID for this resource.
+- `health_status` (String)
+- `id` (String)
 - `is_disabled` (Boolean)
 - `is_in_process` (Boolean)
 - `machine_policy_id` (String)
-- `name` (String) The name of this resource.
+- `name` (String)
 - `operating_system` (String)
 - `resource_group_name` (String)
 - `roles` (List of String)
 - `shell_name` (String)
 - `shell_version` (String)
-- `space_id` (String) The space ID associated with this resource.
-- `status` (String) The status of this resource. Valid statuses are `CalamariNeedsUpgrade`, `Disabled`, `NeedsUpgrade`, `Offline`, `Online`, or `Unknown`.
-- `status_summary` (String) A summary elaborating on the status of this resource.
-- `tenant_tags` (List of String) A list of tenant tags associated with this resource.
-- `tenanted_deployment_participation` (String) The tenanted deployment mode of the resource. Valid account types are `Untenanted`, `TenantedOrUntenanted`, or `Tenanted`.
-- `tenants` (List of String) A list of tenant IDs associated with this resource.
+- `space_id` (String)
+- `status` (String)
+- `status_summary` (String)
+- `tenant_tags` (List of String)
+- `tenanted_deployment_participation` (String)
+- `tenants` (List of String)
 - `thumbprint` (String)
 - `uri` (String)
 - `web_app_name` (String)
 - `web_app_slot_name` (String)
 
-<a id="nestedatt--azure_web_app_deployment_targets--endpoint"></a>
+<a id="nestedobjatt--azure_web_app_deployment_targets--endpoint"></a>
 ### Nested Schema for `azure_web_app_deployment_targets.endpoint`
 
 Read-Only:

docs/data-sources/certificates.md

@@ -40,29 +40,29 @@ data "octopusdeploy_certificates" "example" {
 
 ### Read-Only
 
-- `certificates` (Block List) A list of certificates that match the filter(s). (see [below for nested schema](#nestedblock--certificates))
+- `certificates` (List of Object) A list of certificates that match the filter(s). (see [below for nested schema](#nestedatt--certificates))
 - `id` (String) An auto-generated identifier that includes the timestamp when this data source was last modified.
 
-<a id="nestedblock--certificates"></a>
+<a id="nestedatt--certificates"></a>
 ### Nested Schema for `certificates`
 
 Read-Only:
 
 - `archived` (String)
-- `certificate_data` (String, Sensitive) The encoded data of the certificate.
-- `certificate_data_format` (String) Specifies the archive file format used for storing cryptography objects in the certificate. Valid formats are `Der`, `Pem`, `Pkcs12`, or `Unknown`.
-- `environments` (List of String) A list of environment IDs associated with this resource.
-- `has_private_key` (Boolean) Indicates if the certificate has a private key.
-- `id` (String) The unique ID for this resource.
-- `is_expired` (Boolean) Indicates if the certificate has expired.
+- `certificate_data` (String)
+- `certificate_data_format` (String)
+- `environments` (List of String)
+- `has_private_key` (Boolean)
+- `id` (String)
+- `is_expired` (Boolean)
 - `issuer_common_name` (String)
 - `issuer_distinguished_name` (String)
 - `issuer_organization` (String)
-- `name` (String) The name of this resource.
+- `name` (String)
 - `not_after` (String)
 - `not_before` (String)
 - `notes` (String)
-- `password` (String, Sensitive) The password associated with this resource.
+- `password` (String)
 - `replaced_by` (String)
 - `self_signed` (Boolean)
 - `serial_number` (String)
@@ -72,9 +72,9 @@ Read-Only:
 - `subject_common_name` (String)
 - `subject_distinguished_name` (String)
 - `subject_organization` (String)
-- `tenant_tags` (List of String) A list of tenant tags associated with this resource.
-- `tenanted_deployment_participation` (String) The tenanted deployment mode of the resource. Valid account types are `Untenanted`, `TenantedOrUntenanted`, or `Tenanted`.
-- `tenants` (List of String) A list of tenant IDs associated with this resource.
+- `tenant_tags` (List of String)
+- `tenanted_deployment_participation` (String)
+- `tenants` (List of String)
 - `thumbprint` (String)
 - `version` (Number)
 

docs/data-sources/channels.md

@@ -34,25 +34,25 @@ data "octopusdeploy_channels" "example" {
 
 ### Read-Only
 
-- `channels` (Block List) A channel that matches the specified filter(s). (see [below for nested schema](#nestedblock--channels))
+- `channels` (List of Object) A channel that matches the specified filter(s). (see [below for nested schema](#nestedatt--channels))
 - `id` (String) The ID of this resource.
 
-<a id="nestedblock--channels"></a>
+<a id="nestedatt--channels"></a>
 ### Nested Schema for `channels`
 
 Read-Only:
 
-- `description` (String) The description of this channel.
-- `id` (String) The unique ID for this resource.
-- `is_default` (Boolean) Indicates if this is the default channel for the associated project.
-- `lifecycle_id` (String) The lifecycle ID associated with this channel.
-- `name` (String) The name of this resource.
-- `project_id` (String) The project ID associated with this channel.
-- `rule` (List of Object) A list of rules associated with this channel. (see [below for nested schema](#nestedatt--channels--rule))
-- `space_id` (String) The space ID associated with this resource.
-- `tenant_tags` (List of String) A list of tenant tags associated with this resource.
-
-<a id="nestedatt--channels--rule"></a>
+- `description` (String)
+- `id` (String)
+- `is_default` (Boolean)
+- `lifecycle_id` (String)
+- `name` (String)
+- `project_id` (String)
+- `rule` (List of Object) (see [below for nested schema](#nestedobjatt--channels--rule))
+- `space_id` (String)
+- `tenant_tags` (List of String)
+
+<a id="nestedobjatt--channels--rule"></a>
 ### Nested Schema for `channels.rule`
 
 Read-Only:

docs/data-sources/cloud_region_deployment_targets.md

@@ -46,38 +46,38 @@ data "octopusdeploy_cloud_region_deployment_targets" "example" {
 
 ### Read-Only
 
-- `cloud_region_deployment_targets` (Block List) A list of cloud region deployment targets that match the filter(s). (see [below for nested schema](#nestedblock--cloud_region_deployment_targets))
+- `cloud_region_deployment_targets` (List of Object) A list of cloud region deployment targets that match the filter(s). (see [below for nested schema](#nestedatt--cloud_region_deployment_targets))
 - `id` (String) An auto-generated identifier that includes the timestamp when this data source was last modified.
 
-<a id="nestedblock--cloud_region_deployment_targets"></a>
+<a id="nestedatt--cloud_region_deployment_targets"></a>
 ### Nested Schema for `cloud_region_deployment_targets`
 
 Read-Only:
 
 - `default_worker_pool_id` (String)
-- `endpoint` (List of Object) (see [below for nested schema](#nestedatt--cloud_region_deployment_targets--endpoint))
-- `environments` (List of String) A list of environment IDs associated with this resource.
+- `endpoint` (List of Object) (see [below for nested schema](#nestedobjatt--cloud_region_deployment_targets--endpoint))
+- `environments` (List of String)
 - `has_latest_calamari` (Boolean)
-- `health_status` (String) Represents the health status of this deployment target. Valid health statuses are `HasWarnings`, `Healthy`, `Unavailable`, `Unhealthy`, or `Unknown`.
-- `id` (String) The unique ID for this resource.
+- `health_status` (String)
+- `id` (String)
 - `is_disabled` (Boolean)
 - `is_in_process` (Boolean)
 - `machine_policy_id` (String)
-- `name` (String) The name of this resource.
+- `name` (String)
 - `operating_system` (String)
 - `roles` (List of String)
 - `shell_name` (String)
 - `shell_version` (String)
-- `space_id` (String) The space ID associated with this resource.
-- `status` (String) The status of this resource. Valid statuses are `CalamariNeedsUpgrade`, `Disabled`, `NeedsUpgrade`, `Offline`, `Online`, or `Unknown`.
-- `status_summary` (String) A summary elaborating on the status of this resource.
-- `tenant_tags` (List of String) A list of tenant tags associated with this resource.
-- `tenanted_deployment_participation` (String) The tenanted deployment mode of the resource. Valid account types are `Untenanted`, `TenantedOrUntenanted`, or `Tenanted`.
-- `tenants` (List of String) A list of tenant IDs associated with this resource.
+- `space_id` (String)
+- `status` (String)
+- `status_summary` (String)
+- `tenant_tags` (List of String)
+- `tenanted_deployment_participation` (String)
+- `tenants` (List of String)
 - `thumbprint` (String)
 - `uri` (String)
 
-<a id="nestedatt--cloud_region_deployment_targets--endpoint"></a>
+<a id="nestedobjatt--cloud_region_deployment_targets--endpoint"></a>
 ### Nested Schema for `cloud_region_deployment_targets.endpoint`
 
 Read-Only: