Skip to content

Commit

Permalink
docs: update doc after upgrade validator and superschema lib
Browse files Browse the repository at this point in the history
  • Loading branch information
azrod committed Aug 22, 2023
1 parent f26e94e commit f742489
Show file tree
Hide file tree
Showing 10 changed files with 46 additions and 19 deletions.
27 changes: 27 additions & 0 deletions .changelog/476.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,30 @@
```release-note:dependency
deps: bumps github.com/hashicorp/terraform-plugin-framework-validators from 0.10.0 to 0.11.0
```
```release-note:dependency
deps: bumps github.com/FrangipaneTeam/terraform-plugin-framework-validators from v1.7.0 to v1.8.0
```
```release-note:dependency
deps: bumps github.com/FrangipaneTeam/terraform-plugin-framework-superschema from v1.5.1 to v1.5.2
```
```release-note:enhancement
`resource/cloudavenue_alb_pool` - Improve documentation.
```
```release-note:enhancement
`resource/cloudavenue_catalog_acl` - Improve documentation.
```
```release-note:enhancement
`resource/cloudavenue_edgegateway_nat_rule` - Improve documentation.
```
```release-note:enhancement
`resource/cloudavenue_edgegateway_vpn_ipsec` - Improve documentation.
```
```release-note:enhancement
`resource/cloudavenue_network_dhcp` - Improve documentation.
```
```release-note:enhancement
`resource/cloudavenue_vm_disk` - Improve documentation.
```
```release-note:enhancement
`resource/cloudavenue_vm` - Improve documentation.
```
4 changes: 2 additions & 2 deletions docs/resources/alb_pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ resource "cloudavenue_alb_pool" "example" {
- `edge_gateway_name` (String) (ForceNew) Edge gateway Name in which ALB Pool should be created. Ensure that one and only one attribute from this collection is set : `edge_gateway_id`, `edge_gateway_name`.
- `enabled` (Boolean) Define if ALB Pool is enabled or not. Value defaults to `true`.
- `graceful_timeout_period` (Number) Maximum time in minutes allowed for gracefully disabling a pool member. Value defaults to `1`.
- `health_monitors` (Set of String) List of health monitors type to activate. Element value must satisfy all validations: value must be one of: ["\"HTTP\"" "\"HTTPS\"" "\"TCP\"" "\"UDP\"" "\"PING\""].
- `health_monitors` (Set of String) List of health monitors type to activate. Element value must satisfy all validations: value must be one of: ["HTTP" "HTTPS" "TCP" "UDP" "PING"].
- `members` (Attributes Set) ALB Pool Member(s). (see [below for nested schema](#nestedatt--members))
- `passive_monitoring_enabled` (Boolean) Monitors if the traffic is accepted by node. Value defaults to `true`.
- `persistence_profile` (Attributes) Persistence profile ensures that a user remains connected to the same server for a specified duration. If the persistence profile is unmanaged by Cloud Avenue, updates with unchanged values will continue using the same unmanaged profile. However, any changes to the persistence profile will prompt Cloud Avenue to switch the pool to a profile it manages. (see [below for nested schema](#nestedatt--persistence_profile))
Expand Down Expand Up @@ -110,7 +110,7 @@ Required:

Optional:

- `value` (String) Value of attribute based on persistence type. If persistence_profile.type attribute is set and the value is one of `"HTTP_COOKIE"`, this attribute is REQUIRED.
- `value` (String) Value of attribute based on persistence type. If the value of [`persistence_profile.type`](#persistence_profile.type) attribute is `HTTP_COOKIE` this attribute is **REQUIRED**.

## Import

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/catalog_acl.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ resource "cloudavenue_catalog_acl" "example" {

- `catalog_id` (String) The ID of the catalog. Ensure that one and only one attribute from this collection is set : `catalog_name`, `catalog_id`. Must be a valid URN. This value must start with `urn:vcloud:catalog:`.
- `catalog_name` (String) The Name of the catalog. Ensure that one and only one attribute from this collection is set : `catalog_name`, `catalog_id`.
- `everyone_access_level` (String) Access level when the Catalog is shared with everyone. Value must be one of : `ReadOnly`, `Change`, `FullControl`. If shared_with_everyone attribute is set and the value is one of `true`, this attribute is REQUIRED. If shared_with_everyone attribute is set and the value is one of `false`, this attribute is NULL.
- `everyone_access_level` (String) Access level when the Catalog is shared with everyone. Value must be one of : `ReadOnly`, `Change`, `FullControl`. If the value of [`shared_with_everyone`](#shared_with_everyone) attribute is `true` this attribute is **REQUIRED**. If the value of [`shared_with_everyone`](#shared_with_everyone) attribute is `false` this attribute is **NULL**.
- `shared_with_everyone` (Boolean) Whether the Catalog is shared with everyone in your organization with right `ReadOnly`. Value defaults to `false`.
- `shared_with_users` (Attributes Set) The list of users with whom the Catalog is shared. If shared_with_everyone attribute is set and the value is one of `true`, this attribute is NULL. (see [below for nested schema](#nestedatt--shared_with_users))
- `shared_with_users` (Attributes Set) The list of users with whom the Catalog is shared. If the value of [`shared_with_everyone`](#shared_with_everyone) attribute is `true` this attribute is **NULL**. (see [below for nested schema](#nestedatt--shared_with_users))

### Read-Only

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/edgegateway_nat_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,13 @@ resource "cloudavenue_edgegateway_nat_rule" "example-reflexive" {
### Optional

- `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 rule_type attribute is set and the value is one of `"SNAT"`, `"NO_SNAT"`, `"REFLEXIVE"`, this attribute is NULL.
- `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`.
- `enabled` (Boolean) Enable or Disable the Nat Rule. Value defaults to `true`.
- `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.).
- `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 rule_type attribute is set and the value is one of `"DNAT"`, `"NO_DNAT"`, `"REFLEXIVE"`, this attribute is NULL.
- `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**.

### Read-Only

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/edgegateway_vpn_ipsec.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,13 +95,13 @@ resource "cloudavenue_edgegateway_vpn_ipsec" "example" {
Optional:

- `ike_dh_groups` (String) The Diffie-Hellman (DH) key exchange algorithm is a method used to make a shared encryption key available to two entities over an insecure communications channel. Value must be one of : `GROUP2`, `GROUP5`, `GROUP14`, `GROUP15`, `GROUP16`, `GROUP19`, `GROUP20`, `GROUP21`.
- `ike_digest_algorithm` (String) Secure hashing algorithms to use during the IKE negotiation. Value must be one of : `SHA1`, `SHA2_256`, `SHA2_384`, `SHA2_512`. If <.ike_encryption_algorithm attribute is set and the value is one of `"AES_GCM_128"`, `"AES_GCM_256"`, `"AES_GCM_512"`, this attribute is NULL.
- `ike_digest_algorithm` (String) Secure hashing algorithms to use during the IKE negotiation. Value must be one of : `SHA1`, `SHA2_256`, `SHA2_384`, `SHA2_512`. If the value of [`<.ike_encryption_algorithm`](#<.ike_encryption_algorithm) attribute is one of `AES_GCM_128`, `AES_GCM_256` or `AES_GCM_512` this attribute is **NULL**.
- `ike_encryption_algorithm` (String) Encryption algorithms used by IKE. Value must be one of : `AES_128`, `AES_256`, `AES_GCM_128`, `AES_GCM_192`, `AES_GCM_256`.
- `ike_sa_lifetime` (Number) Security association lifetime in seconds. It is number of seconds before the IPsec tunnel ike part needs to reestablish. Value must be between 21600 and 31536000. Value defaults to `86400`.
- `ike_version` (String) IKE (Internet Key Exchange) is an encrypt protocol of your VPN data. Value must be one of: `IKE_V1` (When you select this option, IPSec VPN initiates and responds to IKEv1 protocol only.), `IKE_V2` (The default option. When you select this version, IPSec VPN initiates and responds to IKEv2 protocol only.), `IKE_FLEX` (When you select this option, if the tunnel establishment fails with IKEv2 protocol, the source site does not fall back and initiate a connection with the IKEv1 protocol. Instead, if the remote site initiates a connection with the IKEv1 protocol, then the connection is accepted.).
- `tunnel_df_policy` (String) Policy for handling defragmentation. Value must be one of: `COPY` (Copies the defragmentation bit from the inner IP packet to the outer packet.), `CLEAR` (Ignores the defragmentation bit present in the inner packet.). Value defaults to `COPY`.
- `tunnel_dh_groups` (String) The Diffie-Hellman (DH) key exchange algorithm is a method used to make a shared encryption key available to two entities over an insecure communications channel. Value must be one of : `GROUP2`, `GROUP5`, `GROUP14`, `GROUP15`, `GROUP16`, `GROUP19`, `GROUP20`, `GROUP21`.
- `tunnel_digest_algorithms` (String) Digest algorithms to be used for message digest. Value must be one of : `SHA1`, `SHA2_256`, `SHA2_384`, `SHA2_512`. If <.tunnel_encryption_algorithms attribute is set and the value is one of `"AES_GCM_128"`, `"AES_GCM_256"`, `"AES_GCM_512"`, this attribute is NULL.
- `tunnel_digest_algorithms` (String) Digest algorithms to be used for message digest. Value must be one of : `SHA1`, `SHA2_256`, `SHA2_384`, `SHA2_512`. If the value of [`<.tunnel_encryption_algorithms`](#<.tunnel_encryption_algorithms) attribute is one of `AES_GCM_128`, `AES_GCM_256` or `AES_GCM_512` this attribute is **NULL**.
- `tunnel_dpd` (Number) Value in seconds of Dead Probe Detection interval. Value must be between 3 and 60. Value defaults to `60`.
- `tunnel_encryption_algorithms` (String) Encryption algorithms to use in IPSec tunnel establishment. Value must be one of : `AES_128`, `AES_256`, `AES_GCM_128`, `AES_GCM_192`, `AES_GCM_256`.
- `tunnel_pfs` (Boolean) PFS (Perfect Forward Secrecy) capacity enabled or disabled. It's generates unique private keys for each secure session. Value defaults to `true`.
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/network_dhcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ resource "cloudavenue_network_routed" "example" {

- `dns_servers` (List of String) The DNS server IPs to be assigned by this DHCP service. List must contain at most 2 elements.
- `lease_time` (Number) The lease time in seconds for the DHCP service. Value must be at least 60. Value defaults to `86400`.
- `listener_ip_address` (String) (ForceNew) The IP address of the DHCP listener. Must be a valid IP with net.ParseIP. If mode attribute is set and the value is one of `"RELAY"`, `"EDGE"`, this attribute is NULL.
- `listener_ip_address` (String) (ForceNew) The IP address of the DHCP listener. Must be a valid IP with net.ParseIP. If the value of [`mode`](#mode) attribute is one of `RELAY` or `EDGE` this attribute is **NULL**.
- `mode` (String) (ForceNew) The mode of the DHCP server. Value must be one of: `EDGE` (The Edge's DHCP service is used to obtain DHCP IP addresses.), `NETWORK` (A new DHCP service directly associated with this network is used to obtain DHCP IP addresses. Use Network Mode if the network is isolated or if you plan to detach this network from the Edge), `RELAY` (DHCP messages are relayed from virtual machines to designated DHCP servers in your physical DHCP infrastructure.). Value defaults to `EDGE`.
- `pools` (Attributes Set) IP ranges used for DHCP pool allocation in the network. If mode attribute is set and the value is one of `"RELAY"`, this attribute is NULL. If mode attribute is set and the value is one of `"EDGE"`, `"NETWORK"`, this attribute is REQUIRED. (see [below for nested schema](#nestedatt--pools))
- `pools` (Attributes Set) IP ranges used for DHCP pool allocation in the network. If the value of [`mode`](#mode) attribute is `RELAY` this attribute is **NULL**. If the value of [`mode`](#mode) attribute is one of `EDGE` or `NETWORK` this attribute is **REQUIRED**. (see [below for nested schema](#nestedatt--pools))

### Read-Only

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,11 +199,11 @@ Optional:

- `adapter_type` (String) The type of vNic to create on this interface. Value must be one of: `VMXNET3` (A VMXNET3 adapter it's an paravirtualized NIC designed for performance. VMXNET 3 offers all the features available in VMXNET 2 and adds several new features.), `E1000E` (A E1000E adapter it's an Emulated version of the Intel 82574 Gigabit Ethernet NIC. E1000E is the default adapter for Windows 8 and Windows Server 2012.), `VMXNET3VRDMA` (VMXNET3VRDMA adapter it's a paravirtualized NIC that supports remote direct memory access (RDMA) between virtual machines through the OFED verbs API.), `SRIOVETHERNETCARD` (SRIOVETHERNETCARD adapter it's a representation of a virtual function (VF) on a physical NIC with SR-IOV support.). Value defaults to `VMXNET3`.
- `connected` (Boolean) Whether the network interface is connected or not. Value defaults to `true`.
- `ip` (String) The IP address to assign to this VM on this network. Must be a valid IP with net.ParseIP. If <.ip_allocation_mode attribute is set and the value is one of `"MANUAL"`, `"POOL"`, this attribute is REQUIRED. If <.ip_allocation_mode attribute is set and the value is one of `"DHCP"`, `"NONE"`, this attribute is NULL.
- `ip` (String) The IP address to assign to this VM on this network. Must be a valid IP with net.ParseIP. If the value of [`<.ip_allocation_mode`](#<.ip_allocation_mode) attribute is one of `MANUAL` or `POOL` this attribute is **REQUIRED**. If the value of [`<.ip_allocation_mode`](#<.ip_allocation_mode) attribute is one of `DHCP` or `NONE` this attribute is **NULL**.
- `ip_allocation_mode` (String) The IP allocation mode for this network. Value must be one of: `DHCP` (IP address is obtained from a DHCP service.), `POOL` (Static IP address is allocated automatically from defined static pool in network.), `MANUAL` (SIP address is assigned manually in the ip field. Must be valid IP address from static pool.), `NONE` (No IP address will be set because VM will have a NIC without network.). Value defaults to `DHCP`.
- `is_primary` (Boolean) Whether this network is the primary network for the VM <a href="#restartrequired" style="color:red">(Restart Required)</a>. Value defaults to `false`.
- `mac` (String) The MAC address to assign to this VM on this network. Autogenerated if not specified. Must be a valid mac address.
- `name` (String) The name of the network to attach to the VM. If <.type attribute is set and the value is one of `"vapp"`, `"org"`, this attribute is REQUIRED. If <.type attribute is set and the value is one of `"none"`, this attribute is NULL.
- `name` (String) The name of the network to attach to the VM. If the value of [`<.type`](#<.type) attribute is one of `vapp` or `org` this attribute is **REQUIRED**. If the value of [`<.type`](#<.type) attribute is `none` this attribute is **NULL**.



Expand Down
2 changes: 1 addition & 1 deletion docs/resources/vm_disk.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ resource "cloudavenue_vm_disk" "example-detachable" {
- `bus_number` (Number) (ForceNew) The bus number of the disk controller. If the disk is attached to a VM and this attribute is not set, the disk will be attached to the first available bus. Value must be between 0 and 3.
- `bus_type` (String) (ForceNew) The type of disk controller. Value must be one of : `IDE`, `SATA`, `SCSI`, `NVME`. Value defaults to `SCSI`.
- `is_detachable` (Boolean) (ForceNew) If set to `true`, the disk could be detached from the VM. If set to `false`, the disk cannot be detached to the VM. Value defaults to `false`.
- `name` (String) The name of the disk. If is_detachable attribute is set and the value is one of `true`, this attribute is REQUIRED. If is_detachable attribute is set and the value is one of `false`, this attribute is NULL.
- `name` (String) The name of the disk. If the value of [`is_detachable`](#is_detachable) attribute is `true` this attribute is **REQUIRED**. If the value of [`is_detachable`](#is_detachable) attribute is `false` this attribute is **NULL**.
- `storage_profile` (String) The name of the storage profile. If not set, the default storage profile will be used. Value must be one of : `silver`, `silver_r1`, `silver_r2`, `gold`, `gold_r1`, `gold_r2`, `gold_hm`, `platinum3k`, `platinum3k_r1`, `platinum3k_r2`, `platinum3k_hm`, `platinum7k`, `platinum7k_r1`, `platinum7k_r2`, `platinum7k_hm`.
- `unit_number` (Number) (ForceNew) The unit number of the disk controller. If the disk is attached to a VM and this attribute is not set, the disk will be attached to the first available unit. Value must be between 0 and 15.
- `vapp_id` (String) (ForceNew) ID of the vApp. Ensure that one and only one attribute from this collection is set : `vapp_name`, `vapp_id`.
Expand Down
4 changes: 2 additions & 2 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ go 1.20

require (
github.com/FrangipaneTeam/terraform-plugin-framework-planmodifiers v1.3.2
github.com/FrangipaneTeam/terraform-plugin-framework-superschema v1.5.1
github.com/FrangipaneTeam/terraform-plugin-framework-superschema v1.5.2
github.com/FrangipaneTeam/terraform-plugin-framework-supertypes v0.0.5
github.com/FrangipaneTeam/terraform-plugin-framework-validators v1.7.0
github.com/FrangipaneTeam/terraform-plugin-framework-validators v1.8.0
github.com/antihax/optional v1.0.0
github.com/google/uuid v1.3.0
github.com/hashicorp/terraform-plugin-docs v0.16.0
Expand Down
8 changes: 4 additions & 4 deletions go.sum
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
github.com/FrangipaneTeam/terraform-plugin-framework-planmodifiers v1.3.2 h1:4Lev5yI0V2h3YU/b6fR/L6q1k20sys7lixjY7Aopmos=
github.com/FrangipaneTeam/terraform-plugin-framework-planmodifiers v1.3.2/go.mod h1:3iRjqbOOGi1VHXIKtgwD7gxNQcFyI+HZq8fhZbSYcLE=
github.com/FrangipaneTeam/terraform-plugin-framework-superschema v1.5.1 h1:cjjvLnQBT/He8SLMTXCCQedi+W+b8oakrHy0w8JG89o=
github.com/FrangipaneTeam/terraform-plugin-framework-superschema v1.5.1/go.mod h1:PmD/Hgbo7uAi0W6HCnZnS6ykXNP8HFxocaa5qMR7p9A=
github.com/FrangipaneTeam/terraform-plugin-framework-superschema v1.5.2 h1:eW0m5hpRWA2pSytEGyvYs4MDMObB9JVRp7ON5qp4O+g=
github.com/FrangipaneTeam/terraform-plugin-framework-superschema v1.5.2/go.mod h1:cNvDYMLsIkdsMTOLUS0ZpyUeH5MMQ9A1B+b85V6XmlA=
github.com/FrangipaneTeam/terraform-plugin-framework-supertypes v0.0.5 h1:Cz5wnn5hXVeE5ibqi1K9ntrNicpYtHhqxY3cYnxqxVM=
github.com/FrangipaneTeam/terraform-plugin-framework-supertypes v0.0.5/go.mod h1:2odt8NV8oEXmS26A3MVrk99oNOnPe9oUE1l5yknkUD4=
github.com/FrangipaneTeam/terraform-plugin-framework-validators v1.7.0 h1:BbH8mSww0smldxXa9rCe1GIzJck2XjftNKOLTpV+ZOY=
github.com/FrangipaneTeam/terraform-plugin-framework-validators v1.7.0/go.mod h1:W2rE/MpS5A24CMCZDANw39nLaKSUlUJdCsbsR7Ww0BE=
github.com/FrangipaneTeam/terraform-plugin-framework-validators v1.8.0 h1:SxSS6sVRpMnCyiRv+hzYOjt3SJIG/k6ccCieCZEVkvk=
github.com/FrangipaneTeam/terraform-plugin-framework-validators v1.8.0/go.mod h1:y0FJ8Ff43rArUq6Np8B0EQoLuMA9D3btFjAUXiuptWI=
github.com/Masterminds/goutils v1.1.1 h1:5nUrii3FMTL5diU80unEVvNevw1nH4+ZV4DSLVJLSYI=
github.com/Masterminds/goutils v1.1.1/go.mod h1:8cTjp+g8YejhMuvIA5y2vz3BpJxksy863GQaJW2MFNU=
github.com/Masterminds/semver/v3 v3.1.1/go.mod h1:VPu/7SZ7ePZ3QOrcuXROw5FAcLl4a0cBrbBpGY/8hQs=
Expand Down

0 comments on commit f742489

Please sign in to comment.