From 7621985fb954f21159e5719dab03159fba377acd Mon Sep 17 00:00:00 2001 From: Ben Pearce Date: Tue, 12 Dec 2023 16:41:07 +1000 Subject: [PATCH] updated docs (#583) --- .../cloud_region_deployment_targets.md | 102 +++++++++++++++++ docs/index.md | 25 ++--- docs/resources/artifactory_generic_feed.md | 50 +++++++++ docs/resources/azure_openid_connect.md | 40 +++++++ docs/resources/certificate.md | 2 +- .../cloud_region_deployment_target.md | 105 ++++++++++++++++++ docs/resources/docker_container_registry.md | 2 +- docs/resources/project.md | 5 +- 8 files changed, 310 insertions(+), 21 deletions(-) create mode 100644 docs/resources/artifactory_generic_feed.md create mode 100644 docs/resources/azure_openid_connect.md diff --git a/docs/data-sources/cloud_region_deployment_targets.md b/docs/data-sources/cloud_region_deployment_targets.md index 9e16196ec..e2a27a053 100644 --- a/docs/data-sources/cloud_region_deployment_targets.md +++ b/docs/data-sources/cloud_region_deployment_targets.md @@ -55,6 +55,7 @@ data "octopusdeploy_cloud_region_deployment_targets" "example" { 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. - `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`. @@ -75,3 +76,104 @@ Read-Only: - `tenants` (List of String) A list of tenant IDs associated with this resource. - `thumbprint` (String) - `uri` (String) + + +### Nested Schema for `cloud_region_deployment_targets.endpoint` + +Read-Only: + +- `aad_client_credential_secret` (String) +- `aad_credential_type` (String) +- `aad_user_credential_username` (String) +- `account_id` (String) +- `applications_directory` (String) +- `authentication` (Set of Object) (see [below for nested schema](#nestedobjatt--cloud_region_deployment_targets--endpoint--authentication)) +- `certificate_signature_algorithm` (String) +- `certificate_store_location` (String) +- `certificate_store_name` (String) +- `client_certificate_variable` (String) +- `cloud_service_name` (String) +- `cluster_certificate` (String) +- `cluster_certificate_path` (String) +- `cluster_url` (String) +- `communication_style` (String) +- `connection_endpoint` (String) +- `container` (List of Object) (see [below for nested schema](#nestedobjatt--cloud_region_deployment_targets--endpoint--container)) +- `default_worker_pool_id` (String) +- `destination` (List of Object) (see [below for nested schema](#nestedobjatt--cloud_region_deployment_targets--endpoint--destination)) +- `dot_net_core_platform` (String) +- `fingerprint` (String) +- `host` (String) +- `id` (String) +- `namespace` (String) +- `port` (Number) +- `proxy_id` (String) +- `resource_group_name` (String) +- `running_in_container` (Boolean) +- `security_mode` (String) +- `server_certificate_thumbprint` (String) +- `skip_tls_verification` (Boolean) +- `slot` (String) +- `storage_account_name` (String) +- `swap_if_possible` (Boolean) +- `tentacle_version_details` (List of Object) (see [below for nested schema](#nestedobjatt--cloud_region_deployment_targets--endpoint--tentacle_version_details)) +- `thumbprint` (String) +- `uri` (String) +- `use_current_instance_count` (Boolean) +- `web_app_name` (String) +- `web_app_slot_name` (String) +- `working_directory` (String) + + +### Nested Schema for `cloud_region_deployment_targets.endpoint.authentication` + +Read-Only: + +- `account_id` (String) +- `admin_login` (String) +- `assume_role` (Boolean) +- `assume_role_external_id` (String) +- `assume_role_session_duration` (Number) +- `assumed_role_arn` (String) +- `assumed_role_session` (String) +- `authentication_type` (String) +- `client_certificate` (String) +- `cluster_name` (String) +- `cluster_resource_group` (String) +- `impersonate_service_account` (Boolean) +- `project` (String) +- `region` (String) +- `service_account_emails` (String) +- `token_path` (String) +- `use_instance_role` (Boolean) +- `use_vm_service_account` (Boolean) +- `zone` (String) + + + +### Nested Schema for `cloud_region_deployment_targets.endpoint.container` + +Read-Only: + +- `feed_id` (String) +- `image` (String) + + + +### Nested Schema for `cloud_region_deployment_targets.endpoint.destination` + +Read-Only: + +- `destination_type` (String) +- `drop_folder_path` (String) + + + +### Nested Schema for `cloud_region_deployment_targets.endpoint.tentacle_version_details` + +Read-Only: + +- `upgrade_locked` (Boolean) +- `upgrade_required` (Boolean) +- `upgrade_suggested` (Boolean) +- `version` (String) diff --git a/docs/index.md b/docs/index.md index 4d054c49e..e1e2fe956 100644 --- a/docs/index.md +++ b/docs/index.md @@ -69,7 +69,7 @@ provider "octopusdeploy" { ### Multiple Spaces -To manage resources in multiple spaces you can use multiple instances of the provider with [aliases](https://www.terraform.io/docs/configuration/providers.html#alias-multiple-provider-instances) like so: +To manage resources in multiple spaces you can specify the space_id on the resource directly: ```terraform provider "octopusdeploy" "unscoped" { @@ -82,25 +82,11 @@ data "octopusdeploy_space" "support" { name = "Support" } -provider "octopusdeploy" { - alias = "space_support" - address = "https://octopus.example.com" - api_key = "API-XXXXXXXXXXXXX" - space_id = data.octopusdeploy_space.support.id -} - data "octopusdeploy_space" "dev" { provider = octopusdeploy.unscoped name = "Product Development" } -provider "octopusdeploy" { - alias = "space_product_development" - address = "https://octopus.example.com" - api_key = "API-XXXXXXXXXXXXX" - space_id = data.octopusdeploy_space.dev.id -} - /* This resource will use the default provider and the default space */ @@ -113,7 +99,7 @@ This resource will use the provider aliased as "space_support" which is scoped to the space with the name, "support". */ resource "octopusdeploy_environment" "Env2" { - provider = "octopusdeploy.space_support" + space_id = data.octopusdeploy_space.support.id name = "TestEnv2" } @@ -122,7 +108,7 @@ This resource will use the provider aliased as "space_product_development" which is scoped to the space named "Product Development". */ resource "octopusdeploy_environment" "Env3" { - provider = "octopusdeploy.space_product_development" + space_id = data.octopusdeploy_space.dev.id name = "TestEnv3" } ``` @@ -130,8 +116,11 @@ resource "octopusdeploy_environment" "Env3" { ## Schema -### Optional +### Required - `address` (String) The endpoint of the Octopus REST API - `api_key` (String) The API key to use with the Octopus REST API + +### Optional + - `space_id` (String) The space ID to target \ No newline at end of file diff --git a/docs/resources/artifactory_generic_feed.md b/docs/resources/artifactory_generic_feed.md new file mode 100644 index 000000000..3d46c6eec --- /dev/null +++ b/docs/resources/artifactory_generic_feed.md @@ -0,0 +1,50 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "octopusdeploy_artifactory_generic_feed Resource - terraform-provider-octopusdeploy" +subcategory: "" +description: |- + This resource manages a Artifactory Generic feed in Octopus Deploy. +--- + +# octopusdeploy_artifactory_generic_feed (Resource) + +This resource manages a Artifactory Generic feed in Octopus Deploy. + +## Example Usage + +```terraform +resource "octopusdeploy_artifactory_generic_feed" "example" { + feed_uri = "https://example.jfrog.io/" + password = "test-password" + name = "Test Artifactory Generic Feed (OK to Delete)" + username = "test-username" + repository = "repo" + layout_regex = "this is regex" +} +``` + + +## Schema + +### Required + +- `feed_uri` (String) +- `name` (String) A short, memorable, unique name for this feed. Example: ACME Builds. +- `repository` (String) + +### Optional + +- `id` (String) The unique ID for this resource. +- `layout_regex` (String) +- `package_acquisition_location_options` (List of String) +- `password` (String, Sensitive) The password associated with this resource. +- `space_id` (String) The space ID associated with this resource. +- `username` (String, Sensitive) The username associated with this resource. + +## Import + +Import is supported using the following syntax: + +```shell +terraform import [options] octopusdeploy_artifactory_generic_feed. +``` diff --git a/docs/resources/azure_openid_connect.md b/docs/resources/azure_openid_connect.md new file mode 100644 index 000000000..b2f1a7325 --- /dev/null +++ b/docs/resources/azure_openid_connect.md @@ -0,0 +1,40 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "octopusdeploy_azure_openid_connect Resource - terraform-provider-octopusdeploy" +subcategory: "" +description: |- + This resource manages Azure OpenID Connect accounts in Octopus Deploy. +--- + +# octopusdeploy_azure_openid_connect (Resource) + +This resource manages Azure OpenID Connect accounts in Octopus Deploy. + + + + +## Schema + +### Required + +- `application_id` (String) The application ID of this resource. +- `name` (String) The name of this resource. +- `subscription_id` (String) The subscription ID of this resource. +- `tenant_id` (String) The tenant ID of this resource. + +### Optional + +- `account_test_subject_keys` (List of String) +- `audience` (String) +- `authentication_endpoint` (String) The authentication endpoint URI for this resource. +- `azure_environment` (String) The Azure environment associated with this resource. Valid Azure environments are `AzureCloud`, `AzureChinaCloud`, `AzureGermanCloud`, or `AzureUSGovernment`. +- `description` (String) The description of this Azure OpenID Connect account. +- `environments` (List of String) A list of environment IDs associated with this resource. +- `execution_subject_keys` (List of String) +- `health_subject_keys` (List of String) +- `id` (String) The unique ID for this resource. +- `resource_manager_endpoint` (String) The resource manager endpoint URI for this resource. +- `space_id` (String) The space ID associated with 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. diff --git a/docs/resources/certificate.md b/docs/resources/certificate.md index 704e98cd8..cc209d355 100644 --- a/docs/resources/certificate.md +++ b/docs/resources/certificate.md @@ -27,7 +27,6 @@ resource "octopusdeploy_certificate" "example" { - `certificate_data` (String, Sensitive) The encoded data of the certificate. - `name` (String) The name of this resource. -- `password` (String, Sensitive) The password associated with this resource. ### Optional @@ -43,6 +42,7 @@ resource "octopusdeploy_certificate" "example" { - `not_after` (String) - `not_before` (String) - `notes` (String) +- `password` (String, Sensitive) The password associated with this resource. - `replaced_by` (String) - `self_signed` (Boolean) - `serial_number` (String) diff --git a/docs/resources/cloud_region_deployment_target.md b/docs/resources/cloud_region_deployment_target.md index 88078ee7b..c34613e17 100644 --- a/docs/resources/cloud_region_deployment_target.md +++ b/docs/resources/cloud_region_deployment_target.md @@ -31,6 +31,7 @@ resource "octopusdeploy_cloud_region_deployment_target" "example" { ### Optional - `default_worker_pool_id` (String) +- `endpoint` (Block List) (see [below for nested schema](#nestedblock--endpoint)) - `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. - `is_disabled` (Boolean) @@ -52,6 +53,110 @@ resource "octopusdeploy_cloud_region_deployment_target" "example" { - `has_latest_calamari` (Boolean) - `is_in_process` (Boolean) + +### Nested Schema for `endpoint` + +Required: + +- `communication_style` (String) + +Optional: + +- `aad_client_credential_secret` (String) +- `aad_credential_type` (String) +- `aad_user_credential_username` (String) +- `account_id` (String) +- `applications_directory` (String) +- `authentication` (Block Set, Max: 1) (see [below for nested schema](#nestedblock--endpoint--authentication)) +- `certificate_signature_algorithm` (String) +- `certificate_store_location` (String) +- `certificate_store_name` (String) +- `client_certificate_variable` (String) +- `cloud_service_name` (String) +- `cluster_certificate` (String) +- `cluster_certificate_path` (String) +- `cluster_url` (String) +- `connection_endpoint` (String) +- `container` (Block List) (see [below for nested schema](#nestedblock--endpoint--container)) +- `default_worker_pool_id` (String) +- `destination` (Block List) (see [below for nested schema](#nestedblock--endpoint--destination)) +- `dot_net_core_platform` (String) +- `fingerprint` (String) +- `host` (String) +- `id` (String) The unique ID for this resource. +- `namespace` (String) +- `port` (Number) +- `proxy_id` (String) +- `resource_group_name` (String) +- `running_in_container` (Boolean) +- `security_mode` (String) +- `server_certificate_thumbprint` (String) +- `skip_tls_verification` (Boolean) +- `slot` (String) +- `storage_account_name` (String) +- `swap_if_possible` (Boolean) +- `tentacle_version_details` (Block List) (see [below for nested schema](#nestedblock--endpoint--tentacle_version_details)) +- `thumbprint` (String) +- `uri` (String) +- `use_current_instance_count` (Boolean) +- `web_app_name` (String) +- `web_app_slot_name` (String) +- `working_directory` (String) + + +### Nested Schema for `endpoint.authentication` + +Optional: + +- `account_id` (String) +- `admin_login` (String) +- `assume_role` (Boolean) +- `assume_role_external_id` (String) +- `assume_role_session_duration` (Number) +- `assumed_role_arn` (String) +- `assumed_role_session` (String) +- `authentication_type` (String) +- `client_certificate` (String) +- `cluster_name` (String) +- `cluster_resource_group` (String) +- `impersonate_service_account` (Boolean) +- `project` (String) +- `region` (String) +- `service_account_emails` (String) +- `token_path` (String) +- `use_instance_role` (Boolean) +- `use_vm_service_account` (Boolean) +- `zone` (String) + + + +### Nested Schema for `endpoint.container` + +Optional: + +- `feed_id` (String) +- `image` (String) + + + +### Nested Schema for `endpoint.destination` + +Optional: + +- `destination_type` (String) +- `drop_folder_path` (String) + + + +### Nested Schema for `endpoint.tentacle_version_details` + +Optional: + +- `upgrade_locked` (Boolean) +- `upgrade_required` (Boolean) +- `upgrade_suggested` (Boolean) +- `version` (String) + ## Import Import is supported using the following syntax: diff --git a/docs/resources/docker_container_registry.md b/docs/resources/docker_container_registry.md index e6507d368..ebc6b68cb 100644 --- a/docs/resources/docker_container_registry.md +++ b/docs/resources/docker_container_registry.md @@ -25,7 +25,7 @@ resource "octopusdeploy_docker_container_registry" "example" { ### Required -- `feed_uri` (String) The URL to a Maven repository. This URL is the same value defined in the `repositories`/`repository`/`url` element of a Maven `settings.xml` file. +- `feed_uri` (String) The URL to a Docker repository. - `name` (String) A short, memorable, unique name for this feed. Example: ACME Builds. ### Optional diff --git a/docs/resources/project.md b/docs/resources/project.md index 687303880..bc4517357 100644 --- a/docs/resources/project.md +++ b/docs/resources/project.md @@ -196,7 +196,10 @@ Required: - `connection_id` (String) The connection identifier associated with the extension settings. - `is_enabled` (Boolean) Specifies whether or not this extension is enabled for this project. - `is_state_automatically_transitioned` (Boolean) Specifies whether or not this extension will automatically transition the state of a deployment for this project. -- `standard_change_template_name` (String) The name of the standard change template associated with this extension. + +Optional: + +- `standard_change_template_name` (String) The name of the standard change template associated with this extension. If provided, deployments will create a standard change based on the provided template, otherwise a normal change will be created.