Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jbristowe committed Dec 5, 2020
1 parent 858815c commit ddcc086
Show file tree
Hide file tree
Showing 11 changed files with 108 additions and 108 deletions.
42 changes: 21 additions & 21 deletions docs/data-sources/kubernetes_cluster_deployment_targets.md
Expand Up @@ -33,19 +33,19 @@ Provides information about existing Kubernetes cluster deployment targets.
### Read-only

- **id** (String, Read-only) A auto-generated identifier that includes the timestamp when this data source was last modified.
- **kubernetes_clusters** (Block List) A list of Kubernetes cluster deployment targets that match the filter(s). (see [below for nested schema](#nestedblock--kubernetes_clusters))
- **kubernetes_cluster_deployment_target** (Block List) A list of Kubernetes cluster deployment targets that match the filter(s). (see [below for nested schema](#nestedblock--kubernetes_cluster_deployment_target))

<a id="nestedblock--kubernetes_clusters"></a>
### Nested Schema for `kubernetes_clusters`
<a id="nestedblock--kubernetes_cluster_deployment_target"></a>
### Nested Schema for `kubernetes_cluster_deployment_target`

Read-only:

- **aws_account_authentication** (List of Object, Read-only) (see [below for nested schema](#nestedatt--kubernetes_clusters--aws_account_authentication))
- **azure_service_principal_authentication** (List of Object, Read-only) (see [below for nested schema](#nestedatt--kubernetes_clusters--azure_service_principal_authentication))
- **certificate_authentication** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--kubernetes_clusters--certificate_authentication))
- **aws_account_authentication** (List of Object, Read-only) (see [below for nested schema](#nestedatt--kubernetes_cluster_deployment_target--aws_account_authentication))
- **azure_service_principal_authentication** (List of Object, Read-only) (see [below for nested schema](#nestedatt--kubernetes_cluster_deployment_target--azure_service_principal_authentication))
- **certificate_authentication** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--kubernetes_cluster_deployment_target--certificate_authentication))
- **cluster_certificate** (String, Read-only)
- **cluster_url** (String, Read-only)
- **container** (List of Object, Read-only) (see [below for nested schema](#nestedatt--kubernetes_clusters--container))
- **container** (List of Object, Read-only) (see [below for nested schema](#nestedatt--kubernetes_cluster_deployment_target--container))
- **default_worker_pool_id** (String, Read-only)
- **environments** (List of String, Read-only) A list of environment IDs associated with this resource.
- **has_latest_calamari** (Boolean, Read-only)
Expand All @@ -70,12 +70,12 @@ Read-only:
- **tenanted_deployment_participation** (String, Read-only) The tenanted deployment mode of the resource. Valid account types are `Untenanted`, `TenantedOrUntenanted`, or `Tenanted`.
- **tenants** (List of String, Read-only) A list of tenant IDs associated with this resource.
- **thumbprint** (String, Read-only)
- **token_authentication** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--kubernetes_clusters--token_authentication))
- **token_authentication** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--kubernetes_cluster_deployment_target--token_authentication))
- **uri** (String, Read-only)
- **username_password_authentication** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--kubernetes_clusters--username_password_authentication))
- **username_password_authentication** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--kubernetes_cluster_deployment_target--username_password_authentication))

<a id="nestedatt--kubernetes_clusters--aws_account_authentication"></a>
### Nested Schema for `kubernetes_clusters.aws_account_authentication`
<a id="nestedatt--kubernetes_cluster_deployment_target--aws_account_authentication"></a>
### Nested Schema for `kubernetes_cluster_deployment_target.aws_account_authentication`

- **account_id** (String)
- **assume_role** (Boolean)
Expand All @@ -87,35 +87,35 @@ Read-only:
- **use_instance_role** (Boolean)


<a id="nestedatt--kubernetes_clusters--azure_service_principal_authentication"></a>
### Nested Schema for `kubernetes_clusters.azure_service_principal_authentication`
<a id="nestedatt--kubernetes_cluster_deployment_target--azure_service_principal_authentication"></a>
### Nested Schema for `kubernetes_cluster_deployment_target.azure_service_principal_authentication`

- **account_id** (String)
- **cluster_name** (String)
- **cluster_resource_group** (String)


<a id="nestedatt--kubernetes_clusters--certificate_authentication"></a>
### Nested Schema for `kubernetes_clusters.certificate_authentication`
<a id="nestedatt--kubernetes_cluster_deployment_target--certificate_authentication"></a>
### Nested Schema for `kubernetes_cluster_deployment_target.certificate_authentication`

- **client_certificate** (String)


<a id="nestedatt--kubernetes_clusters--container"></a>
### Nested Schema for `kubernetes_clusters.container`
<a id="nestedatt--kubernetes_cluster_deployment_target--container"></a>
### Nested Schema for `kubernetes_cluster_deployment_target.container`

- **feed_id** (String)
- **image** (String)


<a id="nestedatt--kubernetes_clusters--token_authentication"></a>
### Nested Schema for `kubernetes_clusters.token_authentication`
<a id="nestedatt--kubernetes_cluster_deployment_target--token_authentication"></a>
### Nested Schema for `kubernetes_cluster_deployment_target.token_authentication`

- **account_id** (String)


<a id="nestedatt--kubernetes_clusters--username_password_authentication"></a>
### Nested Schema for `kubernetes_clusters.username_password_authentication`
<a id="nestedatt--kubernetes_cluster_deployment_target--username_password_authentication"></a>
### Nested Schema for `kubernetes_cluster_deployment_target.username_password_authentication`

- **account_id** (String)

Expand Down
12 changes: 6 additions & 6 deletions docs/data-sources/listening_tentacle_deployment_targets.md
Expand Up @@ -52,10 +52,10 @@ data "octopusdeploy_listening_tentacle_deployment_targets" "listening_tentacle_d
### Read-only

- **id** (String, Read-only) A auto-generated identifier that includes the timestamp when this data source was last modified.
- **listening_tentacles** (Block List) A list of listening tentacle deployment targets that match the filter(s). (see [below for nested schema](#nestedblock--listening_tentacles))
- **listening_tentacle_deployment_target** (Block List) A list of listening tentacle deployment targets that match the filter(s). (see [below for nested schema](#nestedblock--listening_tentacle_deployment_target))

<a id="nestedblock--listening_tentacles"></a>
### Nested Schema for `listening_tentacles`
<a id="nestedblock--listening_tentacle_deployment_target"></a>
### Nested Schema for `listening_tentacle_deployment_target`

Read-only:

Expand All @@ -80,12 +80,12 @@ Read-only:
- **tenanted_deployment_participation** (String, Read-only) The tenanted deployment mode of the resource. Valid account types are `Untenanted`, `TenantedOrUntenanted`, or `Tenanted`.
- **tenants** (List of String, Read-only) A list of tenant IDs associated with this resource.
- **tentacle_url** (String, Read-only)
- **tentacle_version_details** (List of Object, Read-only) (see [below for nested schema](#nestedatt--listening_tentacles--tentacle_version_details))
- **tentacle_version_details** (List of Object, Read-only) (see [below for nested schema](#nestedatt--listening_tentacle_deployment_target--tentacle_version_details))
- **thumbprint** (String, Read-only)
- **uri** (String, Read-only)

<a id="nestedatt--listening_tentacles--tentacle_version_details"></a>
### Nested Schema for `listening_tentacles.tentacle_version_details`
<a id="nestedatt--listening_tentacle_deployment_target--tentacle_version_details"></a>
### Nested Schema for `listening_tentacle_deployment_target.tentacle_version_details`

- **upgrade_locked** (Boolean)
- **upgrade_required** (Boolean)
Expand Down
42 changes: 21 additions & 21 deletions docs/data-sources/machine_policies.md
Expand Up @@ -23,10 +23,10 @@ Provides information about existing machine policies.

### Read-only

- **machine_policies** (Block List) A list of machine policies that match the filter(s). (see [below for nested schema](#nestedblock--machine_policies))
- **machine_policy** (Block List) A list of machine policies that match the filter(s). (see [below for nested schema](#nestedblock--machine_policy))

<a id="nestedblock--machine_policies"></a>
### Nested Schema for `machine_policies`
<a id="nestedblock--machine_policy"></a>
### Nested Schema for `machine_policy`

Read-only:

Expand All @@ -37,55 +37,55 @@ Read-only:
- **description** (String, Read-only) The description of this resource.
- **id** (String, Read-only) The unique identifier for this resource.
- **is_default** (Boolean, Read-only)
- **machine_cleanup_policy** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--machine_policies--machine_cleanup_policy))
- **machine_connectivity_policy** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--machine_policies--machine_connectivity_policy))
- **machine_health_check_policy** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--machine_policies--machine_health_check_policy))
- **machine_update_policy** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--machine_policies--machine_update_policy))
- **machine_cleanup_policy** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--machine_policy--machine_cleanup_policy))
- **machine_connectivity_policy** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--machine_policy--machine_connectivity_policy))
- **machine_health_check_policy** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--machine_policy--machine_health_check_policy))
- **machine_update_policy** (Set of Object, Read-only) (see [below for nested schema](#nestedatt--machine_policy--machine_update_policy))
- **name** (String, Read-only) The name of this resource.
- **polling_request_maximum_message_processing_timeout** (Number, Read-only)
- **polling_request_queue_timeout** (Number, Read-only)
- **space_id** (String, Read-only) The space identifier associated with this resource.

<a id="nestedatt--machine_policies--machine_cleanup_policy"></a>
### Nested Schema for `machine_policies.machine_cleanup_policy`
<a id="nestedatt--machine_policy--machine_cleanup_policy"></a>
### Nested Schema for `machine_policy.machine_cleanup_policy`

- **delete_machines_behavior** (String)
- **delete_machines_elapsed_timespan** (Number)


<a id="nestedatt--machine_policies--machine_connectivity_policy"></a>
### Nested Schema for `machine_policies.machine_connectivity_policy`
<a id="nestedatt--machine_policy--machine_connectivity_policy"></a>
### Nested Schema for `machine_policy.machine_connectivity_policy`

- **machine_connectivity_behavior** (String)


<a id="nestedatt--machine_policies--machine_health_check_policy"></a>
### Nested Schema for `machine_policies.machine_health_check_policy`
<a id="nestedatt--machine_policy--machine_health_check_policy"></a>
### Nested Schema for `machine_policy.machine_health_check_policy`

- **bash_health_check_policy** (List of Object) (see [below for nested schema](#nestedobjatt--machine_policies--machine_health_check_policy--bash_health_check_policy))
- **bash_health_check_policy** (List of Object) (see [below for nested schema](#nestedobjatt--machine_policy--machine_health_check_policy--bash_health_check_policy))
- **health_check_cron** (String)
- **health_check_cron_timezone** (String)
- **health_check_interval** (Number)
- **health_check_type** (String)
- **powershell_health_check_policy** (List of Object) (see [below for nested schema](#nestedobjatt--machine_policies--machine_health_check_policy--powershell_health_check_policy))
- **powershell_health_check_policy** (List of Object) (see [below for nested schema](#nestedobjatt--machine_policy--machine_health_check_policy--powershell_health_check_policy))

<a id="nestedobjatt--machine_policies--machine_health_check_policy--bash_health_check_policy"></a>
### Nested Schema for `machine_policies.machine_health_check_policy.bash_health_check_policy`
<a id="nestedobjatt--machine_policy--machine_health_check_policy--bash_health_check_policy"></a>
### Nested Schema for `machine_policy.machine_health_check_policy.bash_health_check_policy`

- **run_type** (String)
- **script_body** (String)


<a id="nestedobjatt--machine_policies--machine_health_check_policy--powershell_health_check_policy"></a>
### Nested Schema for `machine_policies.machine_health_check_policy.powershell_health_check_policy`
<a id="nestedobjatt--machine_policy--machine_health_check_policy--powershell_health_check_policy"></a>
### Nested Schema for `machine_policy.machine_health_check_policy.powershell_health_check_policy`

- **run_type** (String)
- **script_body** (String)



<a id="nestedatt--machine_policies--machine_update_policy"></a>
### Nested Schema for `machine_policies.machine_update_policy`
<a id="nestedatt--machine_policy--machine_update_policy"></a>
### Nested Schema for `machine_policy.machine_update_policy`

- **calamari_update_behavior** (String)
- **tentacle_update_account_id** (String)
Expand Down
12 changes: 6 additions & 6 deletions docs/data-sources/offline_package_drop_deployment_targets.md
Expand Up @@ -33,15 +33,15 @@ Provides information about existing offline package drop deployment targets.
### Read-only

- **id** (String, Read-only) A auto-generated identifier that includes the timestamp when this data source was last modified.
- **offline_package_drops** (Block List) A list of offline package drop deployment targets that match the filter(s). (see [below for nested schema](#nestedblock--offline_package_drops))
- **offline_package_drop_deployment_target** (Block List) A list of offline package drop deployment targets that match the filter(s). (see [below for nested schema](#nestedblock--offline_package_drop_deployment_target))

<a id="nestedblock--offline_package_drops"></a>
### Nested Schema for `offline_package_drops`
<a id="nestedblock--offline_package_drop_deployment_target"></a>
### Nested Schema for `offline_package_drop_deployment_target`

Read-only:

- **applications_directory** (String, Read-only)
- **destination** (List of Object, Read-only) (see [below for nested schema](#nestedatt--offline_package_drops--destination))
- **destination** (List of Object, Read-only) (see [below for nested schema](#nestedatt--offline_package_drop_deployment_target--destination))
- **environments** (List of String, Read-only) A list of environment IDs associated with this resource.
- **has_latest_calamari** (Boolean, Read-only)
- **health_status** (String, Read-only) Represents the health status of this deployment target. Valid health statuses are `HasWarnings`, `Healthy`, `Unavailable`, `Unhealthy`, or `Unknown`.
Expand All @@ -64,8 +64,8 @@ Read-only:
- **uri** (String, Read-only)
- **working_directory** (String, Read-only)

<a id="nestedatt--offline_package_drops--destination"></a>
### Nested Schema for `offline_package_drops.destination`
<a id="nestedatt--offline_package_drop_deployment_target--destination"></a>
### Nested Schema for `offline_package_drop_deployment_target.destination`

- **destination_type** (String)
- **drop_folder_path** (String)
Expand Down
12 changes: 6 additions & 6 deletions docs/data-sources/polling_tentacle_deployment_targets.md
Expand Up @@ -33,10 +33,10 @@ Provides information about existing polling tentacle deployment targets.
### Read-only

- **id** (String, Read-only) A auto-generated identifier that includes the timestamp when this data source was last modified.
- **polling_tentacles** (Block List) A list of polling tentacle deployment targets that match the filter(s). (see [below for nested schema](#nestedblock--polling_tentacles))
- **polling_tentacle_deployment_target** (Block List) A list of polling tentacle deployment targets that match the filter(s). (see [below for nested schema](#nestedblock--polling_tentacle_deployment_target))

<a id="nestedblock--polling_tentacles"></a>
### Nested Schema for `polling_tentacles`
<a id="nestedblock--polling_tentacle_deployment_target"></a>
### Nested Schema for `polling_tentacle_deployment_target`

Read-only:

Expand All @@ -60,12 +60,12 @@ Read-only:
- **tenanted_deployment_participation** (String, Read-only) The tenanted deployment mode of the resource. Valid account types are `Untenanted`, `TenantedOrUntenanted`, or `Tenanted`.
- **tenants** (List of String, Read-only) A list of tenant IDs associated with this resource.
- **tentacle_url** (String, Read-only)
- **tentacle_version_details** (List of Object, Read-only) (see [below for nested schema](#nestedatt--polling_tentacles--tentacle_version_details))
- **tentacle_version_details** (List of Object, Read-only) (see [below for nested schema](#nestedatt--polling_tentacle_deployment_target--tentacle_version_details))
- **thumbprint** (String, Read-only)
- **uri** (String, Read-only)

<a id="nestedatt--polling_tentacles--tentacle_version_details"></a>
### Nested Schema for `polling_tentacles.tentacle_version_details`
<a id="nestedatt--polling_tentacle_deployment_target--tentacle_version_details"></a>
### Nested Schema for `polling_tentacle_deployment_target.tentacle_version_details`

- **upgrade_locked** (Boolean)
- **upgrade_required** (Boolean)
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/project_groups.md
Expand Up @@ -32,10 +32,10 @@ data "octopusdeploy_project_groups" "example" {
### Read-only

- **id** (String, Read-only) A auto-generated identifier that includes the timestamp when this data source was last modified.
- **project_groups** (Block List) A list of project groups that match the filter(s). (see [below for nested schema](#nestedblock--project_groups))
- **project_group** (Block List) A list of project groups that match the filter(s). (see [below for nested schema](#nestedblock--project_group))

<a id="nestedblock--project_groups"></a>
### Nested Schema for `project_groups`
<a id="nestedblock--project_group"></a>
### Nested Schema for `project_group`

Read-only:

Expand Down

0 comments on commit ddcc086

Please sign in to comment.