Skip to content

Commit edc8b91

Browse files
author
Sander van Harmelen
committed
Adding/updating the docs to reflect the changes in the provider
1 parent 8f223c0 commit edc8b91

5 files changed

Lines changed: 85 additions & 9 deletions

File tree

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
layout: "cloudstack"
3+
page_title: "CloudStack: cloudstack_egress_firewall"
4+
sidebar_current: "docs-cloudstack-resource-egress-firewall"
5+
description: |-
6+
Creates egress firewall rules for a given network.
7+
---
8+
9+
# cloudstack\_egress\_firewall
10+
11+
Creates egress firewall rules for a given network.
12+
13+
## Example Usage
14+
15+
```
16+
resource "cloudstack_egress_firewall" "default" {
17+
network = "test-network"
18+
19+
rule {
20+
source_cidr = "10.0.0.0/8"
21+
protocol = "tcp"
22+
ports = ["80", "1000-2000"]
23+
}
24+
}
25+
```
26+
27+
## Argument Reference
28+
29+
The following arguments are supported:
30+
31+
* `network` - (Required) The network for which to create the egress firewall
32+
rules. Changing this forces a new resource to be created.
33+
34+
* `managed` - (Optional) USE WITH CAUTION! If enabled all the egress firewall
35+
rules for this network will be managed by this resource. This means it will
36+
delete all firewall rules that are not in your config! (defaults false)
37+
38+
* `rule` - (Optional) Can be specified multiple times. Each rule block supports
39+
fields documented below. If `managed = false` at least one rule is required!
40+
41+
The `rule` block supports:
42+
43+
* `source_cidr` - (Required) The source CIDR to allow access to the given ports.
44+
45+
* `protocol` - (Required) The name of the protocol to allow. Valid options are:
46+
`tcp`, `udp` and `icmp`.
47+
48+
* `icmp_type` - (Optional) The ICMP type to allow. This can only be specified if
49+
the protocol is ICMP.
50+
51+
* `icmp_code` - (Optional) The ICMP code to allow. This can only be specified if
52+
the protocol is ICMP.
53+
54+
* `ports` - (Optional) List of ports and/or port ranges to allow. This can only
55+
be specified if the protocol is TCP or UDP.
56+
57+
## Attributes Reference
58+
59+
The following attributes are exported:
60+
61+
* `ID` - The network ID for which the egress firewall rules are created.

website/source/docs/providers/cloudstack/r/firewall.html.markdown

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,12 @@ The following arguments are supported:
3131
* `ipaddress` - (Required) The IP address for which to create the firewall rules.
3232
Changing this forces a new resource to be created.
3333

34-
* `rule` - (Required) Can be specified multiple times. Each rule block supports
35-
fields documented below.
34+
* `managed` - (Optional) USE WITH CAUTION! If enabled all the firewall rules for
35+
this IP address will be managed by this resource. This means it will delete
36+
all firewall rules that are not in your config! (defaults false)
37+
38+
* `rule` - (Optional) Can be specified multiple times. Each rule block supports
39+
fields documented below. If `managed = false` at least one rule is required!
3640

3741
The `rule` block supports:
3842

@@ -54,4 +58,4 @@ The `rule` block supports:
5458

5559
The following attributes are exported:
5660

57-
* `ipaddress` - The IP address for which the firewall rules are created.
61+
* `ID` - The IP address ID for which the firewall rules are created.

website/source/docs/providers/cloudstack/r/network_acl.html.markdown

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,12 @@ resource "cloudstack_network_acl" "default" {
2323

2424
The following arguments are supported:
2525

26-
* `name` - (Required) The name of the ACL. Changing this forces a new resource to be created.
27-
* `description` - (Optional) The description of the ACL. Changing this forces a new resource to be created.
28-
* `vpc` - (Required) The name of the VPC to create this ACL for. Changing this forces a new resource to be created.
26+
* `name` - (Required) The name of the ACL. Changing this forces a new resource
27+
to be created.
28+
* `description` - (Optional) The description of the ACL. Changing this forces a
29+
new resource to be created.
30+
* `vpc` - (Required) The name of the VPC to create this ACL for. Changing this
31+
forces a new resource to be created.
2932

3033
## Attributes Reference
3134

website/source/docs/providers/cloudstack/r/network_acl_rule.html.markdown

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,12 @@ The following arguments are supported:
3333
* `aclid` - (Required) The network ACL ID for which to create the rules.
3434
Changing this forces a new resource to be created.
3535

36-
* `rule` - (Required) Can be specified multiple times. Each rule block supports
37-
fields documented below.
36+
* `managed` - (Optional) USE WITH CAUTION! If enabled all the firewall rules for
37+
this network ACL will be managed by this resource. This means it will delete
38+
all firewall rules that are not in your config! (defaults false)
39+
40+
* `rule` - (Optional) Can be specified multiple times. Each rule block supports
41+
fields documented below. If `managed = false` at least one rule is required!
3842

3943
The `rule` block supports:
4044

@@ -62,4 +66,4 @@ The `rule` block supports:
6266

6367
The following attributes are exported:
6468

65-
* `aclid` - The ACL ID for which the rules are created.
69+
* `ID` - The ACL ID for which the rules are created.

website/source/layouts/cloudstack.erb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717
<a href="/docs/providers/cloudstack/r/disk.html">cloudstack_disk</a>
1818
</li>
1919

20+
<li<%= sidebar_current("docs-cloudstack-resource-egress-firewall") %>>
21+
<a href="/docs/providers/cloudstack/r/egress_firewall.html">cloudstack_egress_firewall</a>
22+
</li>
23+
2024
<li<%= sidebar_current("docs-cloudstack-resource-firewall") %>>
2125
<a href="/docs/providers/cloudstack/r/firewall.html">cloudstack_firewall</a>
2226
</li>

0 commit comments

Comments
 (0)