Skip to content

Commit 4c6de92

Browse files
committed
Documentation formatting fixes
1 parent 43bad98 commit 4c6de92

File tree

4 files changed

+68
-76
lines changed

4 files changed

+68
-76
lines changed

documentation/iptables_chain.md

+15-17
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
[Back to resource list](https://github.com/chef-cookbooks/iptables/tree/master/README.md#resources)
2-
3-
---
4-
51
# iptables_chain
62

3+
[Back to resource list](https://github.com/chef-cookbooks/iptables/tree/master/README.md#resources)
4+
75
The `iptables_chain` resource can be used to manage configuration of chains for iptables.
86

97
More information available at <hhttps://linux.die.net/man/8/iptables>
@@ -17,19 +15,19 @@ As this is an accumalator pattern resource not declaring a chain will have it re
1715

1816
## Properties
1917

20-
| Name | Type | Default | Description | Allowed Values |
21-
--------------------------------- | ----------- | -------- | ----------- | -------------- |
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` |
30-
| `table` | `Symbol` | `:filter` | The table the chain should exist on | `:filter`, `:mangle`, `:nat`, `:raw`, `:security` |
31-
| `chain` | `Symbol` | `nil` | The name of the Chain | |
32-
| `value` | `String` | `ACCEPT [0:0]` | The default action and the Packets : Bytes count | |
18+
| Name | Type | Default | Description | Allowed Values |
19+
| ------------- | ------------------ | -------------- | ------------------------------------------------ | ------------------------------------------------- |
20+
| `config_file` | `String` | | Platform dependant | The full path to find the rules on disk |
21+
| `owner` | `String` | `root` | Owner of the saved output file | |
22+
| `group` | `String` | `root` | Group of the saved output file | |
23+
| `mode` | `String` | `0644` | Permissions on the saved output file | |
24+
| `template` | `source_template` | `iptables.erb` | Source template to use to create the rules | |
25+
| `cookbook` | `String` | `iptables` | Source cookbook to find the template in | |
26+
| `sensitive` | `true, false` | `false` | mark the resource as senstive | |
27+
| `ip_version` | `Symbol`, `String` | `:ipv4` | The IP version | `:ipv4`, `:ipv6` |
28+
| `table` | `Symbol` | `:filter` | The table the chain should exist on | `:filter`, `:mangle`, `:nat`, `:raw`, `:security` |
29+
| `chain` | `Symbol` | `nil` | The name of the Chain | |
30+
| `value` | `String` | `ACCEPT [0:0]` | The default action and the Packets : Bytes count | |
3331

3432
## Examples
3533

documentation/iptables_packages.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
[Back to resource list](https://github.com/chef-cookbooks/iptables/tree/master/README.md#resources)
2-
3-
---
4-
51
# iptables_packages
62

3+
[Back to resource list](https://github.com/chef-cookbooks/iptables/tree/master/README.md#resources)
4+
75
The `iptables_packages` resource can be used to install the required packages for iptables.
86

97
## Actions
@@ -16,9 +14,9 @@ The `iptables_packages` resource can be used to install the required packages fo
1614

1715
## Properties
1816

19-
| Name | Type | Default | Description | Allowed Values |
20-
--------------------------------- | ----------- | -------- | ----------- | -------------- |
21-
| `package_names` | `Array` | Correct packages for platfrom | List of packages required for this cookbook to work | |
17+
| Name | Type | Default | Description | Allowed Values |
18+
| --------------- | ------- | ------------------ | --------------------------------------------------- | -------------- |
19+
| `package_names` | `Array` | Platform dependant | List of packages required for this cookbook to work | |
2220

2321
## Examples
2422

0 commit comments

Comments
 (0)