docs: improve documentation

.changelog/1000.txt

@@ -0,0 +1,12 @@
+```release-note:dependency
+deps: bumps github.com/orange-cloudavenue/terraform-plugin-framework-validators from 0.13.0 to 0.14.1
+```
+```release-note:dependency
+deps: bumps github.com/orange-cloudavenue/terraform-plugin-framework-supertypes from 0.5.0 to 1.0.0
+```
+```release-note:dependency
+deps: bumps github.com/orange-cloudavenue/terraform-plugin-framework-superschema from 1.9.1 to 1.10.1
+```
+```release-note:note
+A lot of improvements in the documentation.
+```

docs/data-sources/elb_pool.md

@@ -36,11 +36,11 @@ data "cloudavenue_elb_pool" "example" {
 - `default_port` (Number) DefaultPort defines destination server port used by the traffic sent to the member.
 - `description` (String) The name of the pool.
 - `enabled` (Boolean) Enable or disable the pool.
-- `health` (Attributes) . (see [below for nested schema](#nestedatt--health))
+- `health` (Attributes) Health check member servers health. It can be monitored by using one or more health monitors. Active monitors generate synthetic traffic and mark a server up or down based on the response. (see [below for nested schema](#nestedatt--health))
 - `id` (String) The ID of the pool.
-- `members` (Attributes) . (see [below for nested schema](#nestedatt--members))
-- `persistence` (Attributes) . (see [below for nested schema](#nestedatt--persistence))
-- `tls` (Attributes) . (see [below for nested schema](#nestedatt--tls))
+- `members` (Attributes) The members of the pool. (see [below for nested schema](#nestedatt--members))
+- `persistence` (Attributes) Persistence profile will ensure that the same user sticks to the same server for a desired duration of time. If the persistence profile is unmanaged by ELB, updates that leave the values unchanged will continue to use the same unmanaged profile. Any changes made to the persistence profile will cause ELB to switch the pool to a profile managed by ELB. (see [below for nested schema](#nestedatt--persistence))
+- `tls` (Attributes) The TLS configuration of the pool. (see [below for nested schema](#nestedatt--tls))
 
 <a id="nestedatt--health"></a>
 ### Nested Schema for `health`

docs/resources/backup.md

@@ -55,12 +55,12 @@ resource "cloudavenue_backup" "example-vm" {
 ### Required
 
 - `policies` (Attributes Set) The backup policies of the target. Set must contain at least 1 elements. (see [below for nested schema](#nestedatt--policies))
-- `type` (String) (ForceNew) Scope of the backup. Value must be one of : `vdc`, `vapp`, `vm`.
+- `type` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> Scope of the backup. Value must be one of : `vdc`, `vapp`, `vm`.
 
 ### Optional
 
-- `target_id` (String) (ForceNew) The URN of the target. A target can be a VDC, a VApp or a VM. Ensure that one and only one attribute from this collection is set : `target_id`, `target_name`. Must be a valid URN.
-- `target_name` (String) (ForceNew) The name of the target. A target can be a VDC, a VApp or a VM. Ensure that one and only one attribute from this collection is set : `target_id`, `target_name`.
+- `target_id` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The URN of the target. A target can be a VDC, a VApp or a VM. Ensure that one and only one attribute from this collection is set : `target_id`, `target_name`. Must be a valid URN.
+- `target_name` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The name of the target. A target can be a VDC, a VApp or a VM. Ensure that one and only one attribute from this collection is set : `target_id`, `target_name`.
 
 ### Read-Only
 

docs/resources/catalog_acl.md

@@ -75,7 +75,7 @@ Required:
 
 Optional:
 
-- `access_level` (String) The access level for the user to which we are sharing. Value must be one of : `ReadOnly`, `Change`, `FullControl`. Value defaults to `ReadOnly`.
+- `access_level` (String) The access level for the user to which we are sharing. Value defaults to `ReadOnly`. Value must be one of : `ReadOnly`, `Change`, `FullControl`.
 
 ## Import
 

docs/resources/edgegateway.md

@@ -34,8 +34,8 @@ resource "cloudavenue_edgegateway" "example" {
 
 ### Required
 
-- `owner_name` (String) (ForceNew) The name of the Edge Gateway owner. It can be a VDC or a VDC Group name.
-- `tier0_vrf_name` (String) (ForceNew) The name of the Tier-0 VRF to which the Edge Gateway is attached.
+- `owner_name` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The name of the Edge Gateway owner. It can be a VDC or a VDC Group name.
+- `tier0_vrf_name` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The name of the Tier-0 VRF to which the Edge Gateway is attached.
 
 ### Optional
 

docs/resources/edgegateway_app_port_profile.md

@@ -44,8 +44,8 @@ resource "cloudavenue_edgegateway_app_port_profile" "example" {
 ### Optional
 
 - `description` (String) Application Port Profile description.
-- `edge_gateway_id` (String) (ForceNew) ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_id`, `edge_gateway_name`. This value must start with `urn:vcloud:gateway:`.
-- `edge_gateway_name` (String) (ForceNew) Name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_id`, `edge_gateway_name`.
+- `edge_gateway_id` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_id`, `edge_gateway_name`. This value must start with `urn:vcloud:gateway:`.
+- `edge_gateway_name` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> Name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_id`, `edge_gateway_name`.
 
 ### Read-Only
 

docs/resources/edgegateway_dhcp_forwarding.md

@@ -36,8 +36,8 @@ data "cloudavenue_edgegateway" "example" {
 
 ### Optional
 
-- `edge_gateway_id` (String) (ForceNew) The ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
-- `edge_gateway_name` (String) (ForceNew) The name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
+- `edge_gateway_id` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
+- `edge_gateway_name` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
 - `enabled` (Boolean) Enable or disable DHCP Forwarding for the Edge Gateway. Value defaults to `true`.
 
 ### Read-Only

docs/resources/edgegateway_firewall.md

@@ -58,8 +58,8 @@ resource "cloudavenue_edgegateway_firewall" "example" {
 
 ### Optional
 
-- `edge_gateway_id` (String) (ForceNew) The ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
-- `edge_gateway_name` (String) (ForceNew) The name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
+- `edge_gateway_id` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
+- `edge_gateway_name` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
 
 ### Read-Only
 
@@ -79,7 +79,7 @@ Optional:
 - `app_port_profile_ids` (Set of String) A set of Application Port Profile IDs. Leaving it empty means `Any` (all).
 - `destination_ids` (Set of String) A set of Destination Firewall Group IDs (`IP Sets` or `Security Groups`). Leaving it empty means `Any` (all).
 - `enabled` (Boolean) Defines if the rule is enabled or not. Value defaults to `true`.
-- `ip_protocol` (String) The IP protocol of the rule. Value must be one of : `IPV4`, `IPV6`, `IPV4_IPV6`. Value defaults to `IPV4`.
+- `ip_protocol` (String) The IP protocol of the rule. Value defaults to `IPV4`. Value must be one of : `IPV4`, `IPV6`, `IPV4_IPV6`.
 - `logging` (Boolean) Defines if the rule should log matching traffic. Value defaults to `false`.
 - `source_ids` (Set of String) A set of Source Firewall Group IDs (`IP Sets` or `Security Groups`). Leaving it empty means `Any` (all).
 

docs/resources/edgegateway_ip_set.md

@@ -34,8 +34,8 @@ resource "cloudavenue_edgegateway_ip_set" "example" {
 ### Optional
 
 - `description` (String) The description of the IP Set.
-- `edge_gateway_id` (String) (ForceNew) The ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
-- `edge_gateway_name` (String) (ForceNew) The name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
+- `edge_gateway_id` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
+- `edge_gateway_name` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
 - `ip_addresses` (Set of String) A set of IP address, CIDR or IP range.
 
 ### Read-Only

docs/resources/edgegateway_nat_rule.md

@@ -62,18 +62,26 @@ resource "cloudavenue_edgegateway_nat_rule" "example-reflexive" {
 ### Required
 
 - `name` (String) The Name of the NAT rule.
-- `rule_type` (String) (ForceNew) NAT rule type. Value must be one of: `DNAT` (Rule translates the external IP to an internal IP and is used for inbound traffic.), `NO_DNAT` (Prevents external IP translation.), `SNAT` (Translates an internal IP to an external IP and is used for outbound traffic.), `NO_SNAT` (Prevents internal IP translation.), `REFLEXIVE` (This translates an internal IP to an external IP and vice versa.).
+- `rule_type` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> NAT rule type. Value must be one of: 
+  - `DNAT` Rule translates the external IP to an internal IP and is used for inbound traffic.
+  - `NO_DNAT` Prevents external IP translation.
+  - `SNAT` Translates an internal IP to an external IP and is used for outbound traffic.
+  - `NO_SNAT` Prevents internal IP translation.
+  - `REFLEXIVE` This translates an internal IP to an external IP and vice versa.
 
 ### Optional
 
 - `app_port_profile_id` (String) Application Port Profile ID to which the rule applies. This value must start with `urn:vcloud:applicationPortProfile:`. If the value of [`rule_type`](#rule_type) attribute is one of `SNAT`, `NO_SNAT`, `NO_DNAT` or `REFLEXIVE` this attribute is **NULL**.
 - `description` (String) A description of the NAT rule.
 - `dnat_external_port` (String) This represents the external port number or port range when doing DNAT port forwarding from external to internal. If not specify, all ports are translated. If the value of [`rule_type`](#rule_type) attribute is one of `SNAT`, `NO_SNAT` or `REFLEXIVE` this attribute is **NULL**.
-- `edge_gateway_id` (String) (ForceNew) The ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
-- `edge_gateway_name` (String) (ForceNew) The Name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
+- `edge_gateway_id` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
+- `edge_gateway_name` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The Name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
 - `enabled` (Boolean) Enable or Disable the NAT rule. Value defaults to `true`.
 - `external_address` (String) The external address for the NAT Rule. This must be supplied as a single IP or Network CIDR. For a DNAT rule, this is the external facing IP Address for incoming traffic. For an SNAT rule, this is the external facing IP Address for outgoing traffic. These IPs are typically allocated/suballocated IP Addresses on the Edge Gateway. For a REFLEXIVE rule, these are the external facing IPs. If the value of [`rule_type`](#rule_type) attribute is `NO_SNAT` this attribute is **NULL**. If the value of [`rule_type`](#rule_type) attribute is one of `DNAT`, `SNAT`, `NO_DNAT` or `REFLEXIVE` this attribute is **REQUIRED**.
-- `firewall_match` (String) You can set a firewall match rule to determine how firewall is applied during NAT. Value must be one of: `MATCH_INTERNAL_ADDRESS` (Applies firewall rule to the internal address of a NAT rule.), `MATCH_EXTERNAL_ADDRESS` (Applies firewall rule to the external address of a NAT rule.), `BYPASS` (Skip applying firewall rule to NAT rule.).
+- `firewall_match` (String) You can set a firewall match rule to determine how firewall is applied during NAT. Value must be one of: 
+  - `MATCH_INTERNAL_ADDRESS` Applies firewall rule to the internal address of a NAT rule.
+  - `MATCH_EXTERNAL_ADDRESS` Applies firewall rule to the external address of a NAT rule.
+  - `BYPASS` Skip applying firewall rule to NAT rule.
 - `internal_address` (String) The internal address for the NAT Rule. This must be supplied as a single IP or Network CIDR. For a DNAT rule, this is the internal IP address for incoming traffic. For an SNAT rule, this is the internal IP Address for outgoing traffic. For a REFLEXIVE rule, these are the internal IPs. These IPs are typically the Private IPs that are allocated to workloads. If the value of [`rule_type`](#rule_type) attribute is `NO_DNAT` this attribute is **NULL**. If the value of [`rule_type`](#rule_type) attribute is one of `DNAT`, `NO_SNAT` or `REFLEXIVE` this attribute is **REQUIRED**.
 - `priority` (Number) If an address has multiple NAT rule, you can assign these rule different priorities to determine the order in which they are applied. A lower value means a higher priority for this rule. Value defaults to `0`.
 - `snat_destination_address` (String) The destination addresses to match in the SNAT Rule. This must be supplied as a single IP or Network CIDR. Providing no value for this field results in match with ANY destination network. If the value of [`rule_type`](#rule_type) attribute is one of `DNAT`, `NO_DNAT` or `REFLEXIVE` this attribute is **NULL**.

docs/resources/edgegateway_security_group.md

@@ -56,8 +56,8 @@ resource "cloudavenue_network_routed" "example" {
 ### Optional
 
 - `description` (String) The description of the security group.
-- `edge_gateway_id` (String) (ForceNew) The ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
-- `edge_gateway_name` (String) (ForceNew) The name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
+- `edge_gateway_id` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
+- `edge_gateway_name` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
 - `member_org_network_ids` (Set of String) The list of organization network IDs to which the security group is applied. Element value must satisfy all validations: must be a valid URN.
 
 ### Read-Only

docs/resources/edgegateway_static_route.md

@@ -41,8 +41,8 @@ resource "cloudavenue_edgegateway_static_route" "example" {
 ### Optional
 
 - `description` (String) The description of the Static Route.
-- `edge_gateway_id` (String) (ForceNew) The ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
-- `edge_gateway_name` (String) (ForceNew) The name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
+- `edge_gateway_id` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The ID of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
+- `edge_gateway_name` (String) <i style="color:red;font-weight: bold">(ForceNew)</i> The name of the Edge Gateway. Ensure that one and only one attribute from this collection is set : `edge_gateway_name`, `edge_gateway_id`.
 
 ### Read-Only
 
@@ -57,7 +57,7 @@ Required:
 
 Optional:
 
-- `admin_distance` (Number) Admin distance is used to choose which route to use when there are multiple routes for a specific network. The lower the admin distance, the higher the preference for the route. Value must be at least 1. Value defaults to `1`.
+- `admin_distance` (Number) Admin distance is used to choose which route to use when there are multiple routes for a specific network. The lower the admin distance, the higher the preference for the route. Value defaults to `1`. Value must be at least 1.
 
 ## Import