Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gxben committed Oct 10, 2024
1 parent d7e0a0b commit ffbed18
Show file tree
Hide file tree
Showing 12 changed files with 119 additions and 119 deletions.
20 changes: 0 additions & 20 deletions docs/data-sources/groups.md

This file was deleted.

8 changes: 4 additions & 4 deletions docs/data-sources/group.md → docs/data-sources/team.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kowabunga_group Data Source - terraform-provider-kowabunga"
page_title: "kowabunga_team Data Source - terraform-provider-kowabunga"
subcategory: ""
description: |-
Data from a group resource
Data from a team resource
---

# kowabunga_group (Data Source)
# kowabunga_team (Data Source)

Data from a group resource
Data from a team resource



Expand Down
20 changes: 20 additions & 0 deletions docs/data-sources/teams.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_teams Data Source - terraform-provider-kowabunga"
subcategory: ""
description: |-
Data from teams
---

# kowabunga_teams (Data Source)

Data from teams



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

### Read-Only

- `teams` (Map of String) List of Kowabunga teams
2 changes: 1 addition & 1 deletion docs/resources/agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Manages a Kowabunga remote agent resource
### Required

- `name` (String) Resource name
- `type` (String) Kowabunga remote agent type (KCA, KSA, KNA)
- `type` (String) Kowabunga remote agent type (Kaktus, Kiwi)

### Optional

Expand Down
20 changes: 10 additions & 10 deletions docs/resources/host.md → docs/resources/kaktus.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kowabunga_host Resource - terraform-provider-kowabunga"
page_title: "kowabunga_kaktus Resource - terraform-provider-kowabunga"
subcategory: ""
description: |-
Manages a host resource
Manages a kaktus node resource
---

# kowabunga_host (Resource)
# kowabunga_kaktus (Resource)

Manages a host resource
Manages a kaktus node resource



Expand All @@ -17,18 +17,18 @@ Manages a host resource

### Required

- `agents` (List of String) The list of Kowabunga remote agents to be associated with the host
- `agents` (List of String) The list of Kowabunga remote agents to be associated with the kaktus node
- `name` (String) Resource name
- `zone` (String) Associated zone name or ID

### Optional

- `cpu_overcommit` (Number) Host CPU over-commit factor (default: 3)
- `cpu_price` (Number) Host monthly CPU price value (default: 0)
- `currency` (String) Host monthly price currency (default: **EUR**)
- `cpu_overcommit` (Number) Kaktus node CPU over-commit factor (default: 3)
- `cpu_price` (Number) Kaktus node monthly CPU price value (default: 0)
- `currency` (String) Kaktus node monthly price currency (default: **EUR**)
- `desc` (String) Resource extended description
- `memory_overcommit` (Number) Host Memory over-commit factor (default: 2)
- `memory_price` (Number) Host monthly Memory price value (default: 0)
- `memory_overcommit` (Number) Kaktus node memory over-commit factor (default: 2)
- `memory_price` (Number) Kaktus node monthly Memory price value (default: 0)
- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))

### Read-Only
Expand Down
38 changes: 19 additions & 19 deletions docs/resources/kgw.md → docs/resources/kawaii.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kowabunga_kgw Resource - terraform-provider-kowabunga"
page_title: "kowabunga_kawaii Resource - terraform-provider-kowabunga"
subcategory: ""
description: |-
Manages a KGW resource. KGW (stands for Kowabunga Gateway) is a resource that provides Nats & internet access capabilities for a given project.
Manages a Kawaii resource. Kawaii is a resource that provides NATs & Internet access capabilities for a given project.
---

# kowabunga_kgw (Resource)
# kowabunga_kawaii (Resource)

Manages a KGW resource. **KGW** (stands for *Kowabunga Gateway*) is a resource that provides Nats & internet access capabilities for a given project.
Manages a Kawaii resource. **Kawaii** is a resource that provides NATs & Internet access capabilities for a given project.



Expand All @@ -23,17 +23,17 @@ Manages a KGW resource. **KGW** (stands for *Kowabunga Gateway*) is a resource t
### Optional

- `desc` (String) Resource extended description
- `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))
- `egress_policy` (String) Kawaii default public traffic firewall egress policy: 'accept' (default) or 'drop'
- `egress_rules` (Attributes List) Kawaii public firewall list of egress rules. Kawaii 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 Kawaii public firewall list of ingress rules. Kawaii 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) Kawaii list of NAT forwarding rules. Kawaii 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))
- `vpc_peerings` (Attributes List) Kawaii list of Kowabunga private VPC subnet peering rules. (see [below for nested schema](#nestedatt--vpc_peerings))

### Read-Only

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

<a id="nestedatt--egress_rules"></a>
### Nested Schema for `egress_rules`
Expand Down Expand Up @@ -90,7 +90,7 @@ Optional:

Required:

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

Optional:

Expand Down Expand Up @@ -131,8 +131,8 @@ Optional:

Read-Only:

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



Expand All @@ -141,15 +141,15 @@ Read-Only:

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))
- `private_ips` (List of String) Kawaii global private gateways virtual IP addresses (read-only).
- `public_ips` (List of String) Kawaii global public gateways virtual IP addresses (read-only).
- `zones` (Attributes List) Kawaii 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)
- `private_ip` (String) Kawaii zone gateway private virtual IP (read-only).
- `public_ip` (String) Kawaii zone gateway public virtual IP (read-only)
- `zone` (String) Kawaii zone name (read-only)
49 changes: 0 additions & 49 deletions docs/resources/kce.md

This file was deleted.

10 changes: 5 additions & 5 deletions docs/resources/netgw.md → docs/resources/kiwi.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kowabunga_netgw Resource - terraform-provider-kowabunga"
page_title: "kowabunga_kiwi Resource - terraform-provider-kowabunga"
subcategory: ""
description: |-
Manages a netgw resource
Manages a Kiwi resource
---

# kowabunga_netgw (Resource)
# kowabunga_kiwi (Resource)

Manages a netgw resource
Manages a Kiwi resource



Expand All @@ -17,7 +17,7 @@ Manages a netgw resource

### Required

- `agents` (List of String) The list of Kowabunga remote agents to be associated with the network gateway
- `agents` (List of String) The list of Kowabunga remote agents to be associated with the Kiwi network gateway
- `name` (String) Resource name
- `region` (String) Associated region name or ID

Expand Down
49 changes: 49 additions & 0 deletions docs/resources/kompute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kowabunga_kompute Resource - terraform-provider-kowabunga"
subcategory: ""
description: |-
Manages a Kompute virtual machine resource. Kompute is an seamless automated way to create virtual machine resources. It abstract the complexity of manually creating instance, volumes and network adapters resources and binding them together. It is the RECOMMENDED way to create and manipulate virtual machine services, unless a specific hwardware configuration is required. Kompute provides 2 network adapters, a public (WAN) and a private (LAN/VPC) one, as well as up to two disks (first one for OS, optional second one for extra data).
---

# kowabunga_kompute (Resource)

Manages a Kompute virtual machine resource. **Kompute** is an seamless automated way to create virtual machine resources. It abstract the complexity of manually creating instance, volumes and network adapters resources and binding them together. It is the **RECOMMENDED** way to create and manipulate virtual machine services, unless a specific hwardware configuration is required. Kompute provides 2 network adapters, a public (WAN) and a private (LAN/VPC) one, as well as up to two disks (first one for OS, optional second one for extra data).



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

### Required

- `disk` (Number) The Kompute instance OS disk size (expressed in GB)
- `mem` (Number) The Kompute instance memory size (expressed in GB)
- `name` (String) Resource name
- `project` (String) Associated project name or ID
- `vcpus` (Number) The Kompute instance number of vCPUs
- `zone` (String) Associated zone name or ID

### Optional

- `desc` (String) Resource extended description
- `extra_disk` (Number) The Kompute optional data disk size (expressed in GB, disabled by default, 0 to disable)
- `pool` (String) Associated storage pool name or ID (zone's default if unspecified)
- `public` (Boolean) Should Kompute instance be exposed over public Internet ? (default: **false**)
- `template` (String) Associated template name or ID (zone's default storage pool's default if unspecified)
- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))

### Read-Only

- `id` (String) Resource object internal identifier
- `ip` (String) IP (read-only)

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

Optional:

- `create` (String) 30m0s
- `delete` (String) 5m0s
- `read` (String) 2m0s
- `update` (String) 5m0s
12 changes: 6 additions & 6 deletions docs/resources/kfs.md → docs/resources/kylo.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kowabunga_kfs Resource - terraform-provider-kowabunga"
page_title: "kowabunga_kylo Resource - terraform-provider-kowabunga"
subcategory: ""
description: |-
Manages a KFS distributed network storage resource. KFS (stands for Kowabunga File System) provides an elastic NFS-compatible endpoint.
Manages a Kylo distributed network storage resource. Kylo provides an elastic NFS-compatible endpoint.
---

# kowabunga_kfs (Resource)
# kowabunga_kylo (Resource)

Manages a KFS distributed network storage resource. **KFS** (stands for *Kowabunga File System*) provides an elastic NFS-compatible endpoint.
Manages a Kylo distributed network storage resource. **Kylo** provides an elastic NFS-compatible endpoint.



Expand All @@ -23,10 +23,10 @@ Manages a KFS distributed network storage resource. **KFS** (stands for *Kowabun

### Optional

- `access_type` (String) KFS' access type. Allowed values: 'RW' or 'RO'. Defaults to RW.
- `access_type` (String) Kylo' access type. Allowed values: 'RW' or 'RO'. Defaults to RW.
- `desc` (String) Resource extended description
- `nfs` (String) Associated NFS storage name or ID (zone's default if unspecified)
- `protocols` (List of Number) KFS's requested NFS protocols versions (defaults to NFSv3 and NFSv4))
- `protocols` (List of Number) Kylo's requested NFS protocols versions (defaults to NFSv3 and NFSv4))
- `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts))

### Read-Only
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ Manages a project resource

### Required

- `groups` (List of String) The list of user groups allowed to administrate the project (i.e. capable of managing internal resources)
- `metadata` (Map of String) List of metadatas key/value associated with the project
- `name` (String) Resource name
- `regions` (List of String) The list of regions the project is managing resources from (subnets will be pre-allocated in all referenced regions)
- `tags` (List of String) List of tags associated with the project
- `teams` (List of String) The list of user teams allowed to administrate the project (i.e. capable of managing internal resources)

### Optional

Expand Down
8 changes: 4 additions & 4 deletions docs/resources/group.md → docs/resources/team.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "kowabunga_group Resource - terraform-provider-kowabunga"
page_title: "kowabunga_team Resource - terraform-provider-kowabunga"
subcategory: ""
description: |-
Manages a Kowabunga group resource
Manages a Kowabunga team resource
---

# kowabunga_group (Resource)
# kowabunga_team (Resource)

Manages a Kowabunga group resource
Manages a Kowabunga team resource



Expand Down

0 comments on commit ffbed18

Please sign in to comment.