Skip to content

Commit

Permalink
updated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
gxben committed May 30, 2024
1 parent 9ab314e commit 779c6c8
Show file tree
Hide file tree
Showing 5 changed files with 156 additions and 9 deletions.
25 changes: 25 additions & 0 deletions docs/data-sources/subnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kowabunga_subnet Data Source - terraform-provider-kowabunga"
subcategory: ""
description: |-
Data from a subnet resource
---

# kowabunga_subnet (Data Source)

Data from a subnet resource



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

### Optional

- `app` (String) Datasource application
- `name` (String) Datasource name

### Read-Only

- `id` (String) Datasource object internal identifier
20 changes: 20 additions & 0 deletions docs/data-sources/subnets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kowabunga_subnets Data Source - terraform-provider-kowabunga"
subcategory: ""
description: |-
Data from subnets
---

# kowabunga_subnets (Data Source)

Data from subnets



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

### Read-Only

- `subnets` (Map of String) List of Kowabunga subnets
115 changes: 107 additions & 8 deletions docs/resources/kgw.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,55 @@ Manages a KGW resource. **KGW** (stands for *Kowabunga Gateway*) is a resource t
### Optional

- `desc` (String) Resource extended description
- `nats` (Attributes List) NATs Configuration (see [below for nested schema](#nestedatt--nats))
- `egress_policy` (String) KGW default public traffic firewall egress policy: 'accept' (default) or 'drop'
- `egress_rules` (Attributes List) KGW public firewall list of egress rules. KGW default policy is to accept all outgoing traffic, including ICMP. Specified ruleset will be explicitly dropped if egress_policy is set to accept, and explicitly accepted if egress policy is set to drop. (see [below for nested schema](#nestedatt--egress_rules))
- `ingress_rules` (Attributes List) The KGW public firewall list of ingress rules. KGW default policy is to drop all incoming traffic, including ICMP. Specified ruleset will be explicitly accepted. (see [below for nested schema](#nestedatt--ingress_rules))
- `nat_rules` (Attributes List) KGW list of NAT forwarding rules. KGW will forward public Internet traffic from all public virtual IPs to requested private subnet IP addresses. (see [below for nested schema](#nestedatt--nat_rules))
- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
- `vpc_peerings` (Attributes List) KGW list of Kowabunga private VPC subnet peering rules. (see [below for nested schema](#nestedatt--vpc_peerings))

### Read-Only

- `id` (String) Resource object internal identifier
- `private_ip` (String) The KGW Private IP (read-only)
- `public_ip` (String) The KGW default Public IP (read-only)
- `netcfg` (Attributes) KGW list of assigned virtual IPs per-zone addresses (read-only) (see [below for nested schema](#nestedatt--netcfg))

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

Required:

- `ports` (String) Ports that will be forwarded. 0 Means all. For a list of ports, separate it with a comma, Ranges Accepted. e.g 8001,9006-9010
- `private_ip` (String) Private IP where the NAT will be forwarded
- `ports` (String) The port (or list of ports) to forward public traffic from. Ranges are accepted. Format is a-b,c-d (e.g. 443; 22,80,443; 80,443,3000-3005).

Optional:

- `public_ip` (String) Exposed public IP used to forward traffic. Leave empty to use the default GW interface
- `destination` (String) The destination IP or CIDR to accept/drop public traffic to (defaults to 0.0.0.0/0)
- `protocol` (String) The transport layer protocol to accept/drop public traffic to (defaults to 'tcp')


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

Required:

- `ports` (String) The port (or list of ports) to accept public traffic from. Ranges are accepted. Format is a-b,c-d (e.g. 443; 22,80,443; 80,443,3000-3005).

Optional:

- `protocol` (String) The transport layer protocol to accept public traffic from (defaults to 'tcp').
- `source` (String) The source IP or CIDR to accept public traffic from (defaults to 0.0.0.0/0).


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

Required:

- `destination` (String) Target private IP address to forward public traffic to.
- `ports` (String) The port (or list of ports) to forward public traffic from. Ranges are accepted. Format is a-b,c-d (e.g. 443; 22,80,443; 80,443,3000-3005).

Optional:

- `protocol` (String) The transport layer protocol to forward public traffic to (defaults to 'tcp')


<a id="nestedatt--timeouts"></a>
Expand All @@ -54,3 +83,73 @@ Optional:
- `delete` (String) 5m0s
- `read` (String) 2m0s
- `update` (String) 5m0s


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

Required:

- `subnet` (String) Kowabunga Subnet ID to be peered with (subnet local IP addresses will be automatically assigned to KGW instances).

Optional:

- `egress_rules` (Attributes List) The firewall list of forwarding egress rules to VPC peered subnet. ICMP trafficis always accepted. The specified ruleset will be explicitly accepted if drop is the default policy (useless otherwise) (see [below for nested schema](#nestedatt--vpc_peerings--egress_rules))
- `ingress_rules` (Attributes List) The firewall list of forwarding ingress rules from VPC peered subnet. ICMP traffic is always accepted. The specified ruleset will be explicitly accepted if drop is the default policy (useless otherwise) (see [below for nested schema](#nestedatt--vpc_peerings--ingress_rules))
- `policy` (String) The default VPC traffic forwarding policy: 'accept' (default) or 'drop'

Read-Only:

- `netcfg` (Attributes List) The per-zone auto-assigned private IPs in peered subnet (read-only) (see [below for nested schema](#nestedatt--vpc_peerings--netcfg))

<a id="nestedatt--vpc_peerings--egress_rules"></a>
### Nested Schema for `vpc_peerings.egress_rules`

Required:

- `ports` (String) The port (or list of ports) to forward public traffic from. Ranges are accepted. Format is a-b,c-d (e.g. 443; 22,80,443; 80,443,3000-3005).

Optional:

- `protocol` (String) The transport layer protocol to forward public traffic to (defaults to 'tcp')


<a id="nestedatt--vpc_peerings--ingress_rules"></a>
### Nested Schema for `vpc_peerings.ingress_rules`

Required:

- `ports` (String) The port (or list of ports) to forward public traffic from. Ranges are accepted. Format is a-b,c-d (e.g. 443; 22,80,443; 80,443,3000-3005).

Optional:

- `protocol` (String) The transport layer protocol to forward public traffic to (defaults to 'tcp')


<a id="nestedatt--vpc_peerings--netcfg"></a>
### Nested Schema for `vpc_peerings.netcfg`

Read-Only:

- `private_ip` (String) KGW zone gateway private IP address in VPC peered subnet (read-only)
- `zone` (String) KGW zone name (read-only).



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

Read-Only:

- `private_ips` (List of String) KGW global private gateways virtual IP addresses (read-only).
- `public_ips` (List of String) KGW global public gateways virtual IP addresses (read-only).
- `zones` (Attributes List) KGW per-zone list of Kowabunga virtual IP addresses (read-only) (see [below for nested schema](#nestedatt--netcfg--zones))

<a id="nestedatt--netcfg--zones"></a>
### Nested Schema for `netcfg.zones`

Read-Only:

- `private_ip` (String) KGW zone gateway private virtual IP (read-only).
- `public_ip` (String) KGW zone gateway public virtual IP (read-only)
- `zone` (String) KGW zone name (read-only)
1 change: 1 addition & 0 deletions docs/resources/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Manages a project resource

- `id` (String) Resource object internal identifier
- `private_subnets` (Map of String) List of project's private subnets zones association (read-only)
- `vrids` (List of Number) List of VRRP IDs used by -as-a-service resources within the project virtual network (read-only). Should your application use VRRP for service redundancy, you should use different IDs to prevent issues.

<a id="nestedatt--timeouts"></a>
### Nested Schema for `timeouts`
Expand Down
4 changes: 3 additions & 1 deletion docs/resources/subnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,15 @@ Manages a subnet resource
- `cidr` (String) Subnet CIDR
- `dns` (String) Subnet DNS server
- `gateway` (String) Subnet router/gateway
- `gw_pool` (List of String) Subnet's range of IPv4 addresses reserved for local zone's network gateway (format: 192.168.0.200-192.168.0.240). Range size must be at least equal to region's number of zones.
- `name` (String) Resource name
- `reserved` (List of String) List of subnet's reserved IPv4 ranges (format: 192.168.0.200-192.168.0.240)
- `reserved` (List of String) List of subnet's reserved IPv4 ranges (format: 192.168.0.200-192.168.0.240). IPv4 addresses from these ranges cannot be used by Kowabunga to assign resources.
- `routes` (List of String) List of extra routes to be access through designated gateway (format: 10.0.0.0/8).
- `vnet` (String) Associated virtual network name or ID

### Optional

- `application` (String) Optional application service type (defaults to 'user', possible values: 'user', 'ceph').
- `default` (Boolean) Whether to set subnet as virtual network's default one (default: **false**). The first subnet to be created is always considered as default one.
- `desc` (String) Resource extended description
- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))
Expand Down

0 comments on commit 779c6c8

Please sign in to comment.