From eac7aa72c48984fe293e956465356a3f5980c01e Mon Sep 17 00:00:00 2001 From: Olexandr Lytvyn Date: Mon, 5 Aug 2024 13:07:31 +0300 Subject: [PATCH] Update examples and documentation --- docs/data-sources/application.md | 12 +++++++++++- docs/data-sources/connector.md | 2 ++ docs/data-sources/user.md | 4 ---- docs/data-sources/user_group.md | 5 ++--- docs/data-sources/vpn_region.md | 3 +-- docs/resources/ip_service.md | 2 +- example/applications.tf | 4 ++-- example/networks.tf | 2 +- example/routes.tf | 2 +- example/variables.tf | 10 +++++----- 10 files changed, 26 insertions(+), 20 deletions(-) diff --git a/docs/data-sources/application.md b/docs/data-sources/application.md index d9094d1..e7706f4 100644 --- a/docs/data-sources/application.md +++ b/docs/data-sources/application.md @@ -26,7 +26,7 @@ description: |- - `id` (String) The ID of this resource. - `network_item_id` (String) - `network_item_type` (String) -- `routes` (List of String) +- `routes` (List of Object) (see [below for nested schema](#nestedatt--routes)) ### Nested Schema for `config` @@ -44,3 +44,13 @@ Read-Only: - `from_port` (Number) - `protocol` (String) - `to_port` (Number) + + + + +### Nested Schema for `routes` + +Read-Only: + +- `allow_embedded_ip` (Boolean) +- `domain` (String) diff --git a/docs/data-sources/connector.md b/docs/data-sources/connector.md index 6d7c01c..3adf5dd 100644 --- a/docs/data-sources/connector.md +++ b/docs/data-sources/connector.md @@ -21,10 +21,12 @@ Use an `cloudconnexa_connector` data source to read an existing CloudConnexa con ### Read-Only +- `description` (String) The description of the connector. - `id` (String) The ID of this resource. - `ip_v4_address` (String) The IPV4 address of the connector. - `ip_v6_address` (String) The IPV6 address of the connector. - `network_item_id` (String) The id of the network or host with which the connector is associated. - `network_item_type` (String) The network object type of the connector. This typically will be set to either `NETWORK` or `HOST`. - `profile` (String) OpenVPN profile +- `token` (String) Connector token - `vpn_region_id` (String) The id of the region where the connector is deployed. diff --git a/docs/data-sources/user.md b/docs/data-sources/user.md index 67bfb63..13b1357 100644 --- a/docs/data-sources/user.md +++ b/docs/data-sources/user.md @@ -13,7 +13,6 @@ Use a `cloudconnexa_user` data source to read a specific CloudConnexa user. - ## Schema ### Required @@ -32,11 +31,8 @@ Use a `cloudconnexa_user` data source to read a specific CloudConnexa user. - `last_name` (String) The user's last name. - `status` (String) The user's status. - `user_id` (String) The ID of this resource. -- `connection_status` (String) The user's connection status. Valid values are `OFFLINE`, `ONLINE`, - or `ONLINE_WITH_ISSUES`. - ### Nested Schema for `devices` Read-Only: diff --git a/docs/data-sources/user_group.md b/docs/data-sources/user_group.md index f9a1def..1a381f9 100644 --- a/docs/data-sources/user_group.md +++ b/docs/data-sources/user_group.md @@ -21,10 +21,9 @@ Use an `cloudconnexa_user_group` data source to read an CloudConnexa user group. ### Read-Only -- `id` (String) The ID of this resource. +- `connect_auth` (String) The type of connection authentication. Valid values are `AUTH`, `AUTO`, or `STRICT_AUTH`. +- `id` (String) The user group ID. - `internet_access` (String) The type of internet access provided. Valid values are `BLOCKED`, `GLOBAL_INTERNET`, or `LOCAL`. Defaults to `LOCAL`. - `max_device` (Number) The maximum number of devices per user. - `system_subnets` (List of String) The IPV4 and IPV6 addresses of the subnets associated with this user group. -- `user_group_id` (String) The user group ID. - `vpn_region_ids` (List of String) The list of VPN region IDs this user group is associated with. -- `connect_auth` (String) The type of connection authentication. Valid values are `AUTH`, `AUTO`, or `STRICT_AUTH`. diff --git a/docs/data-sources/vpn_region.md b/docs/data-sources/vpn_region.md index 8530a7b..ab3acf3 100644 --- a/docs/data-sources/vpn_region.md +++ b/docs/data-sources/vpn_region.md @@ -17,12 +17,11 @@ Use a `cloudconnexa_vpn_region` data source to read an CloudConnexa VPN region. ### Required -- `region_id` (String) The id of the region. +- `id` (String) The id of the region. ### Read-Only - `continent` (String) The continent of the region. - `country` (String) The country of the region. - `country_iso` (String) The ISO code of the country of the region. -- `id` (String) The ID of this resource. - `region_name` (String) The name of the region. diff --git a/docs/resources/ip_service.md b/docs/resources/ip_service.md index 4775f7b..b326a79 100644 --- a/docs/resources/ip_service.md +++ b/docs/resources/ip_service.md @@ -20,13 +20,13 @@ description: |- - `name` (String) - `network_item_id` (String) - `network_item_type` (String) -- `routes` (List of String) - `type` (String) ### Optional - `config` (Block List, Max: 1) (see [below for nested schema](#nestedblock--config)) - `description` (String) +- `routes` (List of String) ### Read-Only diff --git a/example/applications.tf b/example/applications.tf index 2451dfd..51ed7cd 100644 --- a/example/applications.tf +++ b/example/applications.tf @@ -7,7 +7,7 @@ resource "cloudconnexa_application" "application_full_access" { network_item_type = "NETWORK" network_item_id = data.cloudconnexa_network.test-net.id routes { - domain = "example-application-1.com" + domain = "example-application-1.com" allow_embedded_ip = false } @@ -22,7 +22,7 @@ resource "cloudconnexa_application" "application_custom_access" { network_item_id = data.cloudconnexa_network.test-net.id routes { - domain = "example-application-2.com" + domain = "example-application-2.com" allow_embedded_ip = false } diff --git a/example/networks.tf b/example/networks.tf index 3920eb1..b340a10 100644 --- a/example/networks.tf +++ b/example/networks.tf @@ -2,7 +2,7 @@ resource "cloudconnexa_network" "test-network" { name = "test-network" egress = false default_route { - value = "192.168.0.0/24" + subnet = "192.168.0.0/24" } default_connector { name = "test-connector" diff --git a/example/routes.tf b/example/routes.tf index cb325be..877d97a 100644 --- a/example/routes.tf +++ b/example/routes.tf @@ -4,6 +4,6 @@ resource "cloudconnexa_route" "this" { } network_item_id = var.networks["example-network"] type = "IP_V4" - subnet = each.value.subnet + subnet = each.value.subnet description = each.value.description } diff --git a/example/variables.tf b/example/variables.tf index 8169811..95bdead 100644 --- a/example/variables.tf +++ b/example/variables.tf @@ -14,13 +14,13 @@ variable "users" { }) ) default = { - "Username1" = { + "John_Doe" = { username = "Username1" email = "username1@company.com" group = "Default" role = "ADMIN" } - "Username2" = { + "Jane_Doe" = { username = "Username2" email = "username2@company.com" group = "Developer" @@ -55,15 +55,15 @@ variable "routes" { type = list(map(string)) default = [ { - subnet = "10.0.0.0/18" + subnet = "10.0.0.0/18" description = "Example Route with subnet /18" }, { - subnet = "10.10.0.0/20" + subnet = "10.10.0.0/20" description = "Example Route with subnet /20" }, { - subnet = "10.20.0.0/24" + subnet = "10.20.0.0/24" description = "Example Route with subnet /24" }, ]