Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/data-sources/vpc_firewall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "civo_vpc_firewall Data Source - terraform-provider-civo"
subcategory: "Civo Network"
description: |-
Retrieve information about a firewall for use in other resources.
This data source provides all of the firewall's properties as configured on your Civo account.
Firewalls may be looked up by id or name, and you can optionally pass region if you want to make a lookup for a specific firewall inside that region.
---

# civo_vpc_firewall (Data Source)

Retrieve information about a firewall for use in other resources.

This data source provides all of the firewall's properties as configured on your Civo account.

Firewalls may be looked up by id or name, and you can optionally pass region if you want to make a lookup for a specific firewall inside that region.



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

### Optional

- `name` (String) The name of the firewall
- `region` (String) The region where the firewall is

### Read-Only

- `id` (String) The ID of this resource.
- `network_id` (String) The id of the associated network
50 changes: 50 additions & 0 deletions docs/data-sources/vpc_loadbalancer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "civo_vpc_loadbalancer Data Source - terraform-provider-civo"
subcategory: "Civo Network"
description: |-
Get information on a load balancer for use in other resources. This data source provides all of the load balancers properties as configured on your Civo account.
An error will be raised if the provided load balancer name does not exist in your Civo account.
---

# civo_vpc_loadbalancer (Data Source)

Get information on a load balancer for use in other resources. This data source provides all of the load balancers properties as configured on your Civo account.

An error will be raised if the provided load balancer name does not exist in your Civo account.



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

### Optional

- `id` (String) The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
- `name` (String) The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
- `region` (String) The region of the load balancer, if you declare this field, the datasource will use this value instead of the one defined in the provider

### Read-Only

- `algorithm` (String) The algorithm used by the load balancer
- `backends` (List of Object) (see [below for nested schema](#nestedatt--backends))
- `cluster_id` (String) The cluster id of the load balancer
- `enable_proxy_protocol` (String) The enabled proxy protocol of the load balancer
- `external_traffic_policy` (String) The external traffic policy of the load balancer
- `firewall_id` (String) The firewall id of the load balancer
- `private_ip` (String) The private ip of the load balancer
- `public_ip` (String) The public ip of the load balancer
- `session_affinity` (String) The session affinity of the load balancer
- `session_affinity_config_timeout` (Number) The session affinity config timeout of the load balancer
- `state` (String) The state of the load balancer

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

Read-Only:

- `health_check_port` (Number)
- `ip` (String)
- `protocol` (String)
- `source_port` (Number)
- `target_port` (Number)
33 changes: 33 additions & 0 deletions docs/data-sources/vpc_network.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "civo_vpc_network Data Source - terraform-provider-civo"
subcategory: "Civo Network"
description: |-
Retrieve information about a network for use in other resources.
This data source provides all of the network's properties as configured on your Civo account.
Networks may be looked up by id or label, and you can optionally pass region if you want to make a lookup for a specific network inside that region.
---

# civo_vpc_network (Data Source)

Retrieve information about a network for use in other resources.

This data source provides all of the network's properties as configured on your Civo account.

Networks may be looked up by id or label, and you can optionally pass region if you want to make a lookup for a specific network inside that region.



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

### Optional

- `label` (String) The label of an existing network
- `region` (String) The region of an existing network

### Read-Only

- `default` (Boolean) If is the default network
- `id` (String) The ID of this resource.
- `name` (String) The name of the network
34 changes: 34 additions & 0 deletions docs/data-sources/vpc_reserved_ip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "civo_vpc_reserved_ip Data Source - terraform-provider-civo"
subcategory: "Civo Network"
description: |-
Get information on a reserved IP. This data source provides the region and Instance id as configured on your Civo account.
This is useful if the reserved IP in question is not managed by Terraform or you need to find the instance the IP is attached to.
An error will be raised if the provided domain name is not in your Civo account.
---

# civo_vpc_reserved_ip (Data Source)

Get information on a reserved IP. This data source provides the region and Instance id as configured on your Civo account.

This is useful if the reserved IP in question is not managed by Terraform or you need to find the instance the IP is attached to.

An error will be raised if the provided domain name is not in your Civo account.



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

### Optional

- `id` (String) ID for the ip address
- `name` (String) Name for the ip address

### Read-Only

- `instance_id` (String) The ID of the instance the IP is attached to
- `instance_name` (String) The name of the instance the IP is attached to
- `ip` (String) The IP Address requested
- `region` (String) The region the ip address is in
80 changes: 80 additions & 0 deletions docs/resources/vpc_firewall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "civo_vpc_firewall Resource - terraform-provider-civo"
subcategory: "Civo Network"
description: |-
Provides a Civo firewall resource. This can be used to create, modify, and delete firewalls.
---

# civo_vpc_firewall (Resource)

Provides a Civo firewall resource. This can be used to create, modify, and delete firewalls.



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

### Required

- `name` (String) The firewall name

### Optional

- `create_default_rules` (Boolean) The create rules flag is used to create the default firewall rules, if is not defined will be set to true, and if you set to false you need to define at least one ingress or egress rule
- `egress_rule` (Block Set) The egress rules, this is a list of rules that will be applied to the firewall (see [below for nested schema](#nestedblock--egress_rule))
- `ingress_rule` (Block Set) The ingress rules, this is a list of rules that will be applied to the firewall (see [below for nested schema](#nestedblock--ingress_rule))
- `network_id` (String) The firewall network, if is not defined we use the default network
- `region` (String) The firewall region, if is not defined we use the global defined in the provider
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--egress_rule"></a>
### Nested Schema for `egress_rule`

Required:

- `action` (String) The action of the rule can be allow or deny. When we set the `action = 'allow'`, this is going to add a rule to allow traffic. Similarly, setting `action = 'deny'` will deny the traffic.
- `cidr` (Set of String) The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

Optional:

- `label` (String) A string that will be the displayed name/reference for this rule
- `port_range` (String) The port or port range to open, can be a single port or a range separated by a dash (`-`), e.g. `80` or `80-443`
- `protocol` (String) The protocol choice from `tcp`, `udp` or `icmp` (the default if unspecified is `tcp`)

Read-Only:

- `id` (String) The ID of the firewall rule. This is only set when the rule is created by terraform.


<a id="nestedblock--ingress_rule"></a>
### Nested Schema for `ingress_rule`

Required:

- `action` (String) The action of the rule can be allow or deny. When we set the `action = 'allow'`, this is going to add a rule to allow traffic. Similarly, setting `action = 'deny'` will deny the traffic.
- `cidr` (Set of String) The CIDR notation of the other end to affect, or a valid network CIDR (e.g. 0.0.0.0/0 to open for everyone or 1.2.3.4/32 to open just for a specific IP address)

Optional:

- `label` (String) A string that will be the displayed name/reference for this rule
- `port_range` (String) The port or port range to open, can be a single port or a range separated by a dash (`-`), e.g. `80` or `80-443`
- `protocol` (String) The protocol choice from `tcp`, `udp` or `icmp` (the default if unspecified is `tcp`)

Read-Only:

- `id` (String) The ID of the firewall rule. This is only set when the rule is created by terraform.


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

Optional:

- `create` (String)
- `delete` (String)
- `update` (String)
48 changes: 48 additions & 0 deletions docs/resources/vpc_network.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "civo_vpc_network Resource - terraform-provider-civo"
subcategory: "Civo Network"
description: |-
Provides a Civo network resource. This can be used to create, modify, and delete networks.
---

# civo_vpc_network (Resource)

Provides a Civo network resource. This can be used to create, modify, and delete networks.



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

### Required

- `label` (String) Name for the network

### Optional

- `cidr_v4` (String) The CIDR block for the network
- `nameservers_v4` (List of String) List of nameservers for the network
- `region` (String) The region of the network
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
- `vlan_allocation_pool_v4_end` (String) End of the IPv4 allocation pool for VLAN
- `vlan_allocation_pool_v4_start` (String) Start of the IPv4 allocation pool for VLAN
- `vlan_cidr_v4` (String) CIDR for VLAN IPv4
- `vlan_gateway_ip_v4` (String) Gateway IP for VLAN IPv4
- `vlan_id` (Number) VLAN ID for the network
- `vlan_physical_interface` (String) Physical interface for VLAN

### Read-Only

- `default` (Boolean) If the network is default, this will be `true`
- `id` (String) The ID of this resource.
- `name` (String) The name of the network

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

Optional:

- `create` (String)
- `delete` (String)
- `update` (String)
29 changes: 29 additions & 0 deletions docs/resources/vpc_reserved_ip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "civo_vpc_reserved_ip Resource - terraform-provider-civo"
subcategory: "Civo Network"
description: |-
Provides a Civo reserved IP to represent a publicly-accessible static IP addresses that can be mapped to one of your Instancesor Load Balancer.
---

# civo_vpc_reserved_ip (Resource)

Provides a Civo reserved IP to represent a publicly-accessible static IP addresses that can be mapped to one of your Instancesor Load Balancer.



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

### Required

- `name` (String) Name for the ip address

### Optional

- `region` (String) The region of the ip

### Read-Only

- `id` (String) The ID of this resource.
- `ip` (String) The IP Address of the resource
37 changes: 37 additions & 0 deletions docs/resources/vpc_reserved_ip_assignment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "civo_vpc_reserved_ip_assignment Resource - terraform-provider-civo"
subcategory: "Civo Instance"
description: |-
The instance reserved ip assignment resource schema definition
---

# civo_vpc_reserved_ip_assignment (Resource)

The instance reserved ip assignment resource schema definition



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

### Required

- `instance_id` (String) The instance id
- `reserved_ip_id` (String) The reserved ip id

### Optional

- `region` (String) The region of the ip
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.

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

Optional:

- `create` (String)
Loading