Skip to content

Commit

Permalink
updated docs (#583)
Browse files Browse the repository at this point in the history
  • Loading branch information
benPearce1 authored Dec 12, 2023
1 parent 794c1d3 commit 7621985
Show file tree
Hide file tree
Showing 8 changed files with 310 additions and 21 deletions.
102 changes: 102 additions & 0 deletions docs/data-sources/cloud_region_deployment_targets.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand All @@ -75,3 +76,104 @@ Read-Only:
- `tenants` (List of String) A list of tenant IDs associated with this resource.
- `thumbprint` (String)
- `uri` (String)

<a id="nestedatt--cloud_region_deployment_targets--endpoint"></a>
### 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)

<a id="nestedobjatt--cloud_region_deployment_targets--endpoint--authentication"></a>
### 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)


<a id="nestedobjatt--cloud_region_deployment_targets--endpoint--container"></a>
### Nested Schema for `cloud_region_deployment_targets.endpoint.container`

Read-Only:

- `feed_id` (String)
- `image` (String)


<a id="nestedobjatt--cloud_region_deployment_targets--endpoint--destination"></a>
### Nested Schema for `cloud_region_deployment_targets.endpoint.destination`

Read-Only:

- `destination_type` (String)
- `drop_folder_path` (String)


<a id="nestedobjatt--cloud_region_deployment_targets--endpoint--tentacle_version_details"></a>
### Nested Schema for `cloud_region_deployment_targets.endpoint.tentacle_version_details`

Read-Only:

- `upgrade_locked` (Boolean)
- `upgrade_required` (Boolean)
- `upgrade_suggested` (Boolean)
- `version` (String)
25 changes: 7 additions & 18 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" {
Expand All @@ -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
*/
Expand All @@ -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"
}
Expand All @@ -122,16 +108,19 @@ 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"
}
```

<!-- schema generated by tfplugindocs -->
## 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
50 changes: 50 additions & 0 deletions docs/resources/artifactory_generic_feed.md
Original file line number Diff line number Diff line change
@@ -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 generated by tfplugindocs -->
## 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.<name> <feed-id>
```
40 changes: 40 additions & 0 deletions docs/resources/azure_openid_connect.md
Original file line number Diff line number Diff line change
@@ -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 generated by tfplugindocs -->
## 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.
2 changes: 1 addition & 1 deletion docs/resources/certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)
Expand Down
Loading

0 comments on commit 7621985

Please sign in to comment.