From ffbed18ae9825bf30167c54bd9e6a0038002f94f Mon Sep 17 00:00:00 2001 From: Benjamin Zores Date: Thu, 10 Oct 2024 13:22:22 +0200 Subject: [PATCH] updated docs --- docs/data-sources/groups.md | 20 ---------- docs/data-sources/{group.md => team.md} | 8 ++-- docs/data-sources/teams.md | 20 ++++++++++ docs/resources/agent.md | 2 +- docs/resources/{host.md => kaktus.md} | 20 +++++----- docs/resources/{kgw.md => kawaii.md} | 38 +++++++++---------- docs/resources/kce.md | 49 ------------------------- docs/resources/{netgw.md => kiwi.md} | 10 ++--- docs/resources/kompute.md | 49 +++++++++++++++++++++++++ docs/resources/{kfs.md => kylo.md} | 12 +++--- docs/resources/project.md | 2 +- docs/resources/{group.md => team.md} | 8 ++-- 12 files changed, 119 insertions(+), 119 deletions(-) delete mode 100644 docs/data-sources/groups.md rename docs/data-sources/{group.md => team.md} (63%) create mode 100644 docs/data-sources/teams.md rename docs/resources/{host.md => kaktus.md} (54%) rename docs/resources/{kgw.md => kawaii.md} (63%) delete mode 100644 docs/resources/kce.md rename docs/resources/{netgw.md => kiwi.md} (78%) create mode 100644 docs/resources/kompute.md rename docs/resources/{kfs.md => kylo.md} (59%) rename docs/resources/{group.md => team.md} (79%) diff --git a/docs/data-sources/groups.md b/docs/data-sources/groups.md deleted file mode 100644 index 18b6041..0000000 --- a/docs/data-sources/groups.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -# generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "kowabunga_groups Data Source - terraform-provider-kowabunga" -subcategory: "" -description: |- - Data from groups ---- - -# kowabunga_groups (Data Source) - -Data from groups - - - - -## Schema - -### Read-Only - -- `groups` (Map of String) List of Kowabunga groups diff --git a/docs/data-sources/group.md b/docs/data-sources/team.md similarity index 63% rename from docs/data-sources/group.md rename to docs/data-sources/team.md index 3ec89d1..4941c37 100644 --- a/docs/data-sources/group.md +++ b/docs/data-sources/team.md @@ -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 diff --git a/docs/data-sources/teams.md b/docs/data-sources/teams.md new file mode 100644 index 0000000..55f1981 --- /dev/null +++ b/docs/data-sources/teams.md @@ -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 + +### Read-Only + +- `teams` (Map of String) List of Kowabunga teams diff --git a/docs/resources/agent.md b/docs/resources/agent.md index 47a8058..254c74c 100644 --- a/docs/resources/agent.md +++ b/docs/resources/agent.md @@ -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 diff --git a/docs/resources/host.md b/docs/resources/kaktus.md similarity index 54% rename from docs/resources/host.md rename to docs/resources/kaktus.md index d7ef435..f0452b6 100644 --- a/docs/resources/host.md +++ b/docs/resources/kaktus.md @@ -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 @@ -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 diff --git a/docs/resources/kgw.md b/docs/resources/kawaii.md similarity index 63% rename from docs/resources/kgw.md rename to docs/resources/kawaii.md index 1c7c947..4f58a1f 100644 --- a/docs/resources/kgw.md +++ b/docs/resources/kawaii.md @@ -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. @@ -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)) ### Nested Schema for `egress_rules` @@ -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: @@ -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). @@ -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)) ### 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) diff --git a/docs/resources/kce.md b/docs/resources/kce.md deleted file mode 100644 index 5206a0f..0000000 --- a/docs/resources/kce.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -# generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "kowabunga_kce Resource - terraform-provider-kowabunga" -subcategory: "" -description: |- - Manages a virtual machine KCE resource. KCE (stands for Kowabunga Compute Engine) 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. KCE 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_kce (Resource) - -Manages a virtual machine KCE resource. **KCE** (stands for *Kowabunga Compute Engine*) 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. KCE 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 - -### Required - -- `disk` (Number) The KCE OS disk size (expressed in GB) -- `mem` (Number) The KCE memory size (expressed in GB) -- `name` (String) Resource name -- `project` (String) Associated project name or ID -- `vcpus` (Number) The KCE number of vCPUs -- `zone` (String) Associated zone name or ID - -### Optional - -- `desc` (String) Resource extended description -- `extra_disk` (Number) The KCE 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 KCE 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) - - -### Nested Schema for `timeouts` - -Optional: - -- `create` (String) 30m0s -- `delete` (String) 5m0s -- `read` (String) 2m0s -- `update` (String) 5m0s diff --git a/docs/resources/netgw.md b/docs/resources/kiwi.md similarity index 78% rename from docs/resources/netgw.md rename to docs/resources/kiwi.md index 464ee21..06cf453 100644 --- a/docs/resources/netgw.md +++ b/docs/resources/kiwi.md @@ -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 @@ -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 diff --git a/docs/resources/kompute.md b/docs/resources/kompute.md new file mode 100644 index 0000000..fe7f736 --- /dev/null +++ b/docs/resources/kompute.md @@ -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 + +### 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) + + +### Nested Schema for `timeouts` + +Optional: + +- `create` (String) 30m0s +- `delete` (String) 5m0s +- `read` (String) 2m0s +- `update` (String) 5m0s diff --git a/docs/resources/kfs.md b/docs/resources/kylo.md similarity index 59% rename from docs/resources/kfs.md rename to docs/resources/kylo.md index 329f514..f0266c7 100644 --- a/docs/resources/kfs.md +++ b/docs/resources/kylo.md @@ -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. @@ -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 diff --git a/docs/resources/project.md b/docs/resources/project.md index 17d4cf0..d81adf4 100644 --- a/docs/resources/project.md +++ b/docs/resources/project.md @@ -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 diff --git a/docs/resources/group.md b/docs/resources/team.md similarity index 79% rename from docs/resources/group.md rename to docs/resources/team.md index 34d54d2..4e4efcb 100644 --- a/docs/resources/group.md +++ b/docs/resources/team.md @@ -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