Skip to content

Commit cd06737

Browse files
bmhughesbmhughes
committed
Documentation update
Signed-off-by: Ben Hughes <[email protected]>
1 parent 50a63ab commit cd06737

File tree

4 files changed

+51
-31
lines changed

4 files changed

+51
-31
lines changed

‎documentation/iptables_chain.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[back to resource list](https://github.com/chef-cookbooks/iptables#resources)
1+
[Back to resource list](https://github.com/chef-cookbooks/iptables/tree/master/README.md#resources)
22

33
---
44

@@ -12,21 +12,24 @@ As this is an accumalator pattern resource not declaring a chain will have it re
1212

1313
## Actions
1414

15-
`:create`
15+
- `:create`
16+
- `:delete`
1617

1718
## Properties
1819

1920
| Name | Type | Default | Description | Allowed Values |
2021
--------------------------------- | ----------- | -------- | ----------- | -------------- |
22+
| `config_file` | `String` | The default location on disk of the config file, see resource for details | The full path to find the rules on disk | |
23+
| `owner` | `String` | `root` | Owner of the saved output file | |
24+
| `group` | `String` | `root` | Group of the saved output file | |
25+
| `mode` | `String` | `0644` | Permissions on the saved output file | |
26+
| `template` | `source_template` | `iptables.erb` | Source template to use to create the rules | |
27+
| `cookbook` | `String` | `iptables` | Source cookbook to find the template in | |
28+
| `sensitive` | `true, false` | `false` | mark the resource as senstive | |
29+
| `ip_version` | `Symbol`, `String` | `:ipv4` | The IP version | `:ipv4`, `:ipv6` |
2130
| `table` | `Symbol` | `:filter` | The table the chain should exist on | `:filter`, `:mangle`, `:nat`, `:raw`, `:security` |
2231
| `chain` | `Symbol` | `nil` | The name of the Chain | |
2332
| `value` | `String` | `ACCEPT [0:0]` | The default action and the Packets : Bytes count | |
24-
| `ip_version` | `Symbol` | `:ipv4` | The IP version | `:ipv4`, `:ipv6` |
25-
| `file_mode` | `String` | `0644` | Permissions on the saved output file | |
26-
| `source_template` | `source_template` | `iptables.erb` | Source template to use to create the rules | |
27-
| `cookbook` | `String` | `iptables` | Source cookbook to find the template in | |
28-
| `sensitive` | `true, false` | `false` | mark the resource as senstive | |
29-
| `config_file` | `String` | The default location on disk of the config file, see resource for details | The full path to find the rules on disk | |
3033

3134
## Examples
3235

@@ -43,7 +46,7 @@ Create a custom chain
4346
```ruby
4447
iptables_chain 'filter' do
4548
table :filter
46-
chain :LOGGIMG
49+
chain :LOGGING
4750
value '- [0:0]'
4851
end
4952
```

‎documentation/iptables_packages.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[back to resource list](https://github.com/chef-cookbooks/iptables#resources)
1+
[Back to resource list](https://github.com/chef-cookbooks/iptables/tree/master/README.md#resources)
22

33
---
44

@@ -8,14 +8,17 @@ The `iptables_packages` resource can be used to install the required packages fo
88

99
## Actions
1010

11-
`:install`
12-
`:remove`
11+
- `:install`
12+
- `:purge`
13+
- `:reconfig`
14+
- `:remove`
15+
- `:upgrade`
1316

1417
## Properties
1518

1619
| Name | Type | Default | Description | Allowed Values |
1720
--------------------------------- | ----------- | -------- | ----------- | -------------- |
18-
| `package_names` | `Array` | Correct packages for platfrom | List of packages required for this cookbook to work | |
21+
| `package_names` | `Array` | Correct packages for platfrom | List of packages required for this cookbook to work | |
1922

2023
## Examples
2124

‎documentation/iptables_rule.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[back to resource list](https://github.com/chef-cookbooks/iptables#resources)
1+
[Back to resource list](https://github.com/chef-cookbooks/iptables/tree/master/README.md#resources)
22

33
---
44

@@ -14,15 +14,23 @@ If the property `line` is used all other properties around configuring the iptab
1414

1515
## Actions
1616

17-
`:create`
17+
- `:create`
18+
- `:delete`
1819

1920
## Properties
2021

2122
| Name | Type | Default | Description | Allowed Values |
2223
--------------------------------- | ----------- | -------- | ----------- | -------------- |
24+
| `config_file` | `String` | The default location on disk of the config file, see resource for details | The full path to find the rules on disk | |
25+
| `owner` | `String` | `root` | Owner of the saved output file | |
26+
| `group` | `String` | `root` | Group of the saved output file | |
27+
| `mode` | `String` | `0644` | Permissions on the saved output file | |
28+
| `template` | `source_template` | `iptables.erb` | Source template to use to create the rules | |
29+
| `cookbook` | `String` | `iptables` | Source cookbook to find the template in | |
30+
| `sensitive` | `true, false` | `false` | mark the resource as senstive | |
2331
| `table` | `Symbol` | `:filter` | The table the chain exists on for the rule | `:filter`, `:mangle`, `:nat`, `:raw`, `:security` |
2432
| `chain` | `Symbol` | `nil` | The name of the Chain to put this rule on | |
25-
| `ip_version` | `Symbol`, `String` | `:ipv4` | The IP version | `:ipv4`, `:ipv6`, `ipv4`, `ipv6` |
33+
| `ip_version` | `Symbol`, `String` | `:ipv4` | The IP version | `:ipv4`, `:ipv6`, `ipv4`, `ipv6` |
2634
| `protocol` | `Symbol`, `String`, `Integer` | | The protocol to look for | |
2735
| `match` | `String` | | extended packet matching module to use | |
2836
| `source` | `String` | | Source specification. Address can be either a network name, a hostname (please note that specifying any name to be resolved with a remote query such as DNS is a really bad idea), a network IP address (with /mask), or a plain IP address. The mask can be either a network mask or a plain number, specifying the number of 1's at the left side of the network mask. Thus, a mask of 24 is equivalent to 255.255.255.0. A "!" argument before the address specification inverts the sense of the address. | |
@@ -36,11 +44,6 @@ If the property `line` is used all other properties around configuring the iptab
3644
| `line` | `String` | | Specify the entire line yourself, overrides all other options | |
3745
| `extra_options` | `String` | | Pass in extra arguments which are not available directly, useful with modules | |
3846
| `comment` | `String` | | A comment to put on the rule | |
39-
| `file_mode` | `String` | `0644` | Permissions on the saved output file | |
40-
| `source_template` | `source_template` | `iptables.erb` | Source template to use to create the rules | |
41-
| `cookbook` | `String` | `iptables` | Source cookbook to find the template in | |
42-
| `sensitive` | `true, false` | `false` | mark the resource as senstive | |
43-
| `config_file` | `String` | The default location on disk of the config file, see resource for details | The full path to find the rules on disk | |
4447

4548
## Examples
4649

‎documentation/iptables_service.md

+21-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[back to resource list](https://github.com/chef-cookbooks/iptables#resources)
1+
[Back to resource list](https://github.com/chef-cookbooks/iptables/tree/master/README.md#resources)
22

33
---
44

@@ -8,23 +8,34 @@ The `iptables_service` resource can be used to configure the required service fo
88

99
## Actions
1010

11-
`:enable`
12-
`:disable`
11+
- `:start`
12+
- `:stop`
13+
- `:restart`
14+
- `:reload`
15+
- `:enable`
16+
- `:disable`
1317

1418
## Properties
1519

1620
| Name | Type | Default | Description | Allowed Values |
1721
--------------------------------- | ----------- | -------- | ----------- | -------------- |
18-
| `ip_version` | `Symbol` | `:ipv4` | The IP version | `:ipv4`, `:ipv6` |
19-
| `sysconfig` | `Hash` | Correct default settings | A hash of the config settings for sysconfig, see library for more details | |
22+
| `config_file` | `String` | The default location on disk of the config file, see resource for details | The full path to find the rules on disk | |
23+
| `owner` | `String` | `root` | Owner of the saved output file | |
24+
| `group` | `String` | `root` | Group of the saved output file | |
25+
| `mode` | `String` | `0644` | Permissions on the saved output file | |
26+
| `template` | `source_template` | `iptables.erb` | Source template to use to create the rules | |
27+
| `cookbook` | `String` | `iptables` | Source cookbook to find the template in | |
28+
| `sensitive` | `true, false` | `false` | mark the resource as senstive | |
29+
| `ip_version` | `Symbol`, `String` | `:ipv4` | The IP version | `:ipv4`, `:ipv6` |
2030
| `service_name` | `String` | Correct service name | Name of the iptables services | |
21-
| `sysconfig_file_mode` | `String` | `0600` | Permissions on the saved sysconfig file | |
22-
23-
| `file_mode` | `String` | `0644` | Permissions on the saved rules file | |
24-
| `source_template` | `source_template` | `iptables.erb` | Source template to use to create the rules | |
31+
| `owner` | `String` | `root` | Owner of the saved output file | |
32+
| `group` | `String` | `root` | Group of the saved output file | |
33+
| `mode` | `String` | `0644` | Permissions on the saved rules file | |
34+
| `template` | `source_template` | `iptables.erb` | Source template to use to create the rules | |
2535
| `cookbook` | `cookbook` | `iptables` | Source cookbook to find the template in | |
2636
| `sysconfig_file` | `String` | The default location on disk of the sysconfig file, see resource for details | The full path to find the sysconfig file on disk | |
27-
| `config_file` | `String` | The default location on disk of the config file, see resource for details | The full path to find the rules on disk | |
37+
| `sysconfig_template` | `source_template` | `iptables-config.erb` | Source template to use to create the rules | |
38+
| `sysconfig` | `Hash` | Correct default settings | A hash of the config settings for sysconfig, see library for more details | |
2839

2940
## Examples
3041

0 commit comments

Comments
 (0)