Skip to content

Commit

Permalink
Updated Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
unasra committed Sep 25, 2024
1 parent 56a2380 commit 6ca2c59
Show file tree
Hide file tree
Showing 10 changed files with 184 additions and 127 deletions.
34 changes: 17 additions & 17 deletions docs/data-sources/cloud_discovery_providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ Required:

Optional:

- `additional_config` (Attributes) Additional configuration. Ex.: '{ "excluded_object_types": [], "exclusion_account_list": [], "zone_forwarding": "true" or "false" }'. (see [below for nested schema](#nestedatt--results--additional_config))
- `credential_preference` (Attributes) Credential preference. Ex.: '{ "type": "dynamic", "access_identifier_type": "role_arn" or "tenant_id" or "project_id" }'. (see [below for nested schema](#nestedatt--results--credential_preference))
- `additional_config` (Attributes) Additional configuration for the Discovery Job (see [below for nested schema](#nestedatt--results--additional_config))
- `credential_preference` (Attributes) Credential preference for the discovery job . Note - Static credentials are not supported. (see [below for nested schema](#nestedatt--results--credential_preference))
- `deleted_at` (String) Timestamp when the object has been deleted.
- `description` (String) Description of the discovery config. Optional.
- `desired_state` (String) Desired state. Default is "enabled".
Expand All @@ -81,8 +81,8 @@ Read-Only:
Optional:

- `excluded_accounts` (List of String) List of account IDs to exclude from discovery.
- `forward_zone_enabled` (Boolean) Enable forward zone discovery.
- `internal_ranges_enabled` (Boolean) Enable internal ranges discovery.
- `forward_zone_enabled` (Boolean) Enable/Disable forward zone discovery.
- `internal_ranges_enabled` (Boolean) Enable/Disable internal ranges discovery.
- `object_type` (Attributes) Object type to discover. (see [below for nested schema](#nestedatt--results--additional_config--object_type))

<a id="nestedatt--results--additional_config--object_type"></a>
Expand Down Expand Up @@ -129,15 +129,15 @@ Optional:
Optional:

- `access_identifier_type` (String) Access identifier type. Possible values: role_arn, tenant_id, project_id.
- `credential_type` (String) Credential type. Possible values: `dynamic`.
- `credential_type` (String) Credential type. Possible values: `dynamic`. Support for Static Credentials is not present


<a id="nestedatt--results--destinations"></a>
### Nested Schema for `results.destinations`

Optional:

- `config` (Attributes) Destination configuration. Ex.: '{ "dns": { "view_name": "view 1", "view_id": "dns/view/v1", "consolidated_zone_data_enabled": false, "sync_type": "read_only/read_write" "split_view_enabled": false }, "ipam": { "ip_space": "", }, "account": {}, }'. (see [below for nested schema](#nestedatt--results--destinations--config))
- `config` (Attributes) Destination configuration. (see [below for nested schema](#nestedatt--results--destinations--config))
- `destination_type` (String) Destination type: DNS or IPAM/DHCP.

Read-Only:
Expand Down Expand Up @@ -183,19 +183,29 @@ Optional:

Optional:

- `accounts` (Attributes List) List of accounts to be discovered. (see [below for nested schema](#nestedatt--results--source_configs--accounts))
- `cloud_credential_id` (String) Cloud Credential ID.
- `credential_config` (Attributes) Credential configuration. Ex.: '{ "access_identifier": "arn:aws:iam::1234:role/access_for_discovery", "region": "us-east-1", "enclave": "commercial/gov" }'. (see [below for nested schema](#nestedatt--results--source_configs--credential_config))
- `restricted_to_accounts` (List of String) Provider account IDs such as accountID/ SubscriptionID to be restricted for a given source_config.

Read-Only:

- `account_schedule_id` (String) Account Schedule ID.
- `accounts` (Attributes List) List of accounts to be discovered. (see [below for nested schema](#nestedatt--results--source_configs--accounts))
- `created_at` (String) Timestamp when the object has been created.
- `deleted_at` (String) Timestamp when the object has been deleted.
- `id` (String) Auto-generated unique source config ID. Format BloxID.
- `updated_at` (String) Timestamp when the object has been updated.

<a id="nestedatt--results--source_configs--credential_config"></a>
### Nested Schema for `results.source_configs.credential_config`

Optional:

- `access_identifier` (String) Access identifier of the account
- `enclave` (String) Enclave of the account
- `region` (String) Region of the account


<a id="nestedatt--results--source_configs--accounts"></a>
### Nested Schema for `results.source_configs.accounts`

Expand All @@ -222,13 +232,3 @@ Read-Only:
- `status` (String) Status of the sync operation.
- `status_message` (String) Status message of the sync operation.
- `updated_at` (String) Timestamp when the object has been updated.


<a id="nestedatt--results--source_configs--credential_config"></a>
### Nested Schema for `results.source_configs.credential_config`

Optional:

- `access_identifier` (String) Access identifier of the account
- `enclave` (String) Enclave of the account
- `region` (String) Region of the account
47 changes: 28 additions & 19 deletions docs/resources/cloud_discovery_provider.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "bloxone_cloud_discovery_provider Resource - terraform-provider-bloxone"
subcategory: ""
subcategory: "Cloud Discovery Providers"
description: |-
Manages Cloud Discovery Providers.
---
Expand All @@ -10,7 +10,7 @@ description: |-

Manages Cloud Discovery Providers.

## Example Usage
## Example Usage in Amazon Web Services

```terraform
resource "bloxone_dns_view" "example" {
Expand Down Expand Up @@ -53,7 +53,11 @@ resource "bloxone_cloud_discovery_provider" "example_aws" {
}
}
```

## Example Usage in Microsoft Azure

```terraform
resource "bloxone_cloud_discovery_provider" "example_azure" {
name = "example_provider_azure"
provider_type = "Microsoft Azure"
Expand All @@ -77,7 +81,11 @@ resource "bloxone_cloud_discovery_provider" "example_azure" {
site = "Site A"
}
}
```

## Example Usage in Google Cloud Platform

```terraform
resource "bloxone_cloud_discovery_provider" "example_gcp" {
name = "example_provider_gcp"
provider_type = "Google Cloud Platform"
Expand All @@ -102,6 +110,7 @@ resource "bloxone_cloud_discovery_provider" "example_gcp" {
}
```


<!-- schema generated by tfplugindocs -->
## Schema

Expand All @@ -113,8 +122,8 @@ resource "bloxone_cloud_discovery_provider" "example_gcp" {

### Optional

- `additional_config` (Attributes) Additional configuration. Ex.: '{ "excluded_object_types": [], "exclusion_account_list": [], "zone_forwarding": "true" or "false" }'. (see [below for nested schema](#nestedatt--additional_config))
- `credential_preference` (Attributes) Credential preference. Ex.: '{ "type": "dynamic", "access_identifier_type": "role_arn" or "tenant_id" or "project_id" }'. (see [below for nested schema](#nestedatt--credential_preference))
- `additional_config` (Attributes) Additional configuration for the Discovery Job (see [below for nested schema](#nestedatt--additional_config))
- `credential_preference` (Attributes) Credential preference for the discovery job . Note - Static credentials are not supported. (see [below for nested schema](#nestedatt--credential_preference))
- `deleted_at` (String) Timestamp when the object has been deleted.
- `description` (String) Description of the discovery config. Optional.
- `desired_state` (String) Desired state. Default is "enabled".
Expand All @@ -140,8 +149,8 @@ resource "bloxone_cloud_discovery_provider" "example_gcp" {
Optional:

- `excluded_accounts` (List of String) List of account IDs to exclude from discovery.
- `forward_zone_enabled` (Boolean) Enable forward zone discovery.
- `internal_ranges_enabled` (Boolean) Enable internal ranges discovery.
- `forward_zone_enabled` (Boolean) Enable/Disable forward zone discovery.
- `internal_ranges_enabled` (Boolean) Enable/Disable internal ranges discovery.
- `object_type` (Attributes) Object type to discover. (see [below for nested schema](#nestedatt--additional_config--object_type))

<a id="nestedatt--additional_config--object_type"></a>
Expand Down Expand Up @@ -188,15 +197,15 @@ Optional:
Optional:

- `access_identifier_type` (String) Access identifier type. Possible values: role_arn, tenant_id, project_id.
- `credential_type` (String) Credential type. Possible values: `dynamic`.
- `credential_type` (String) Credential type. Possible values: `dynamic`. Support for Static Credentials is not present


<a id="nestedatt--destinations"></a>
### Nested Schema for `destinations`

Optional:

- `config` (Attributes) Destination configuration. Ex.: '{ "dns": { "view_name": "view 1", "view_id": "dns/view/v1", "consolidated_zone_data_enabled": false, "sync_type": "read_only/read_write" "split_view_enabled": false }, "ipam": { "ip_space": "", }, "account": {}, }'. (see [below for nested schema](#nestedatt--destinations--config))
- `config` (Attributes) Destination configuration. (see [below for nested schema](#nestedatt--destinations--config))
- `destination_type` (String) Destination type: DNS or IPAM/DHCP.

Read-Only:
Expand Down Expand Up @@ -242,19 +251,29 @@ Optional:

Optional:

- `accounts` (Attributes List) List of accounts to be discovered. (see [below for nested schema](#nestedatt--source_configs--accounts))
- `cloud_credential_id` (String) Cloud Credential ID.
- `credential_config` (Attributes) Credential configuration. Ex.: '{ "access_identifier": "arn:aws:iam::1234:role/access_for_discovery", "region": "us-east-1", "enclave": "commercial/gov" }'. (see [below for nested schema](#nestedatt--source_configs--credential_config))
- `restricted_to_accounts` (List of String) Provider account IDs such as accountID/ SubscriptionID to be restricted for a given source_config.

Read-Only:

- `account_schedule_id` (String) Account Schedule ID.
- `accounts` (Attributes List) List of accounts to be discovered. (see [below for nested schema](#nestedatt--source_configs--accounts))
- `created_at` (String) Timestamp when the object has been created.
- `deleted_at` (String) Timestamp when the object has been deleted.
- `id` (String) Auto-generated unique source config ID. Format BloxID.
- `updated_at` (String) Timestamp when the object has been updated.

<a id="nestedatt--source_configs--credential_config"></a>
### Nested Schema for `source_configs.credential_config`

Optional:

- `access_identifier` (String) Access identifier of the account
- `enclave` (String) Enclave of the account
- `region` (String) Region of the account


<a id="nestedatt--source_configs--accounts"></a>
### Nested Schema for `source_configs.accounts`

Expand All @@ -281,13 +300,3 @@ Read-Only:
- `status` (String) Status of the sync operation.
- `status_message` (String) Status message of the sync operation.
- `updated_at` (String) Timestamp when the object has been updated.


<a id="nestedatt--source_configs--credential_config"></a>
### Nested Schema for `source_configs.credential_config`

Optional:

- `access_identifier` (String) Access identifier of the account
- `enclave` (String) Enclave of the account
- `region` (String) Region of the account
87 changes: 0 additions & 87 deletions examples/resources/bloxone_cloud_discovery_provider/resource.tf

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
resource "bloxone_dns_view" "example" {
name = "example_dns_view"
}


resource "bloxone_cloud_discovery_provider" "example_aws" {
name = "example_provider_aws"
provider_type = "Amazon Web Services"
account_preference = "single"
credential_preference = {
access_identifier_type = "role_arn"
credential_type = "dynamic"
}
source_configs = [
{
credential_config = {
access_identifier = "arn:aws:iam::123456789012:role/role-name"
}
}
]

# Other Optional fields
destinations = [
{
config = {}
destination_type = "IPAM/DHCP"
},
{
config = {
view_id = bloxone_dns_view.example.id
}
destination_type = "DNS"
}
]

tags = {
site = "Site A"
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
resource "bloxone_cloud_discovery_provider" "example_azure" {
name = "example_provider_azure"
provider_type = "Microsoft Azure"
account_preference = "single"
credential_preference = {
access_identifier_type = "tenant_id"
credential_type = "dynamic"
}
source_configs = [
{
credential_config = {
access_identifier = "xyz98765-4321-abcd-efgh-ijklmnopqrst"
}
restricted_to_accounts = ["12345678-abcd-efgh-ijkl-901234567890"]
}
]

# Other Optional fields

tags = {
site = "Site A"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
resource "bloxone_cloud_discovery_provider" "example_gcp" {
name = "example_provider_gcp"
provider_type = "Google Cloud Platform"
account_preference = "single"
credential_preference = {
access_identifier_type = "project_id"
credential_type = "dynamic"
}
source_configs = [
{
credential_config = {
access_identifier = "my-bloxone-example-2024"
}
}
]

# Other Optional fields

tags = {
site = "Site A"
}
}
Loading

0 comments on commit 6ca2c59

Please sign in to comment.