Skip to content

Commit bf499ca

Browse files
damacusdamacus
committed
fix: satisfy markdownlint for resource docs
1 parent 009b9c6 commit bf499ca

10 files changed

Lines changed: 198 additions & 169 deletions

‎CHANGELOG.md‎

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Standardise files with files in sous-chefs/repo-management
1515

1616
### Bug Fixes
1717

18-
* **ci:** Update workflows to use release pipeline ([#188](https://github.com/sous-chefs/ossec/issues/188)) ([1cc004a](https://github.com/sous-chefs/ossec/commit/1cc004ad272354130c96be8018ccd3d17c35ee06))
18+
- **ci:** Update workflows to use release pipeline ([#188](https://github.com/sous-chefs/ossec/issues/188)) ([1cc004a](https://github.com/sous-chefs/ossec/commit/1cc004ad272354130c96be8018ccd3d17c35ee06))
1919

2020
## [2.0.17](https://github.com/sous-chefs/ossec/compare/2.0.16...v2.0.17) (2025-10-15)
2121

2222

2323
### Bug Fixes
2424

25-
* **ci:** Update workflows to use release pipeline ([#188](https://github.com/sous-chefs/ossec/issues/188)) ([1cc004a](https://github.com/sous-chefs/ossec/commit/1cc004ad272354130c96be8018ccd3d17c35ee06))
25+
- **ci:** Update workflows to use release pipeline ([#188](https://github.com/sous-chefs/ossec/issues/188)) ([1cc004a](https://github.com/sous-chefs/ossec/commit/1cc004ad272354130c96be8018ccd3d17c35ee06))
2626

2727
## 2.0.16 - *2025-09-04*
2828

@@ -68,54 +68,54 @@ Standardise files with files in sous-chefs/repo-management
6868

6969
## 2.0.0 - *2023-01-12*
7070

71-
* Standardise files with files in sous-chefs/repo-management
72-
* Partially modernize cookbook
73-
* Refactor library helper
74-
* Properly set repositories for various supported platforms
75-
* Cleanup and Fix CI
76-
* Add support to various platforms
77-
* Fix idempotency issues
71+
- Standardise files with files in sous-chefs/repo-management
72+
- Partially modernize cookbook
73+
- Refactor library helper
74+
- Properly set repositories for various supported platforms
75+
- Cleanup and Fix CI
76+
- Add support to various platforms
77+
- Fix idempotency issues
7878

7979
## 1.2.7 - *2022-02-08*
8080

81-
* Standardise files with files in sous-chefs/repo-management
81+
- Standardise files with files in sous-chefs/repo-management
8282

8383
## 1.2.6 - *2022-02-07*
8484

85-
* Remove delivery folder
86-
* Standardise files with files in sous-chefs/repo-management
85+
- Remove delivery folder
86+
- Standardise files with files in sous-chefs/repo-management
8787

8888
## 1.2.5 - *2021-09-08*
8989

90-
* resolved cookstyle error: recipes/authd.rb:25:4 refactor: `Chef/Modernize/UseChefLanguageSystemdHelper`
90+
- resolved cookstyle error: recipes/authd.rb:25:4 refactor: `Chef/Modernize/UseChefLanguageSystemdHelper`
9191

9292
## 1.2.4 - *2021-08-30*
9393

94-
* Standardise files with files in sous-chefs/repo-management
94+
- Standardise files with files in sous-chefs/repo-management
9595

9696
## 1.2.3 - *2021-06-01*
9797

98-
* resolved cookstyle error: spec/unit/recipes/agent_spec.rb:5:31 convention: `Style/ExpandPathArguments`
99-
* resolved cookstyle error: spec/unit/recipes/client_spec.rb:5:31 convention: `Style/ExpandPathArguments`
100-
* resolved cookstyle error: spec/unit/recipes/server_spec.rb:5:31 convention: `Style/ExpandPathArguments`
98+
- resolved cookstyle error: spec/unit/recipes/agent_spec.rb:5:31 convention: `Style/ExpandPathArguments`
99+
- resolved cookstyle error: spec/unit/recipes/client_spec.rb:5:31 convention: `Style/ExpandPathArguments`
100+
- resolved cookstyle error: spec/unit/recipes/server_spec.rb:5:31 convention: `Style/ExpandPathArguments`
101101

102102
## 1.2.2 - 2020-05-14
103103

104-
* resolved cookstyle error: recipes/common.rb:20:35 convention: `Layout/TrailingWhitespace`
105-
* resolved cookstyle error: recipes/common.rb:20:36 refactor: `ChefModernize/FoodcriticComments`
106-
* resolved cookstyle error: recipes/common.rb:90:24 convention: `Layout/TrailingWhitespace`
107-
* resolved cookstyle error: recipes/common.rb:90:25 refactor: `ChefModernize/FoodcriticComments`
104+
- resolved cookstyle error: recipes/common.rb:20:35 convention: `Layout/TrailingWhitespace`
105+
- resolved cookstyle error: recipes/common.rb:20:36 refactor: `ChefModernize/FoodcriticComments`
106+
- resolved cookstyle error: recipes/common.rb:90:24 convention: `Layout/TrailingWhitespace`
107+
- resolved cookstyle error: recipes/common.rb:90:25 refactor: `ChefModernize/FoodcriticComments`
108108

109109
## 1.2.1 - 2020-05-05
110110

111111
### Added
112112

113-
* Migration to Github Actions
113+
- Migration to Github Actions
114114

115115
### Changed
116116

117-
* Various Cookstyle and foodcritic fixes
118-
* resolved cookstyle error: libraries/helpers.rb:31:18 convention: `Style/HashEachMethods`
117+
- Various Cookstyle and foodcritic fixes
118+
- resolved cookstyle error: libraries/helpers.rb:31:18 convention: `Style/HashEachMethods`
119119

120120
### Deprecated
121121

@@ -125,7 +125,7 @@ Standardise files with files in sous-chefs/repo-management
125125

126126
### Added
127127

128-
* Add distro based authd service name
128+
- Add distro based authd service name
129129

130130
### Changed
131131

@@ -135,31 +135,31 @@ Standardise files with files in sous-chefs/repo-management
135135

136136
## [1.1.0] - 2018-08-13
137137

138-
* README Updates:
139-
* Fix broken links
140-
* Add reference to Wazzuh
141-
* General updates to cookbook
142-
* Remove EOL distros
143-
* Update for current supported Chef version (13)
138+
- README Updates:
139+
- Fix broken links
140+
- Add reference to Wazzuh
141+
- General updates to cookbook
142+
- Remove EOL distros
143+
- Update for current supported Chef version (13)
144144

145145
## [1.0.5] - 2014-04-15
146146

147-
* Avoid node.save to prevent incomplete attribute collections
148-
* `dist-ossec-keys.sh` should be sorted for idempotency
149-
* Ability to disable ossec configuration template
150-
* Support for encrypted databags
151-
* Support for environment-scoped searches
152-
* Support for multiple email_to addresses
147+
- Avoid node.save to prevent incomplete attribute collections
148+
- `dist-ossec-keys.sh` should be sorted for idempotency
149+
- Ability to disable ossec configuration template
150+
- Support for encrypted databags
151+
- Support for environment-scoped searches
152+
- Support for multiple email_to addresses
153153

154154
## [1.0.4] - 2013-05-14
155155

156-
* [COOK-2740]: Use FQDN for a client name
157-
* [COOK-2739]: Upgrade OSSEC to version 2.7
156+
- [COOK-2740]: Use FQDN for a client name
157+
- [COOK-2739]: Upgrade OSSEC to version 2.7
158158

159159
## [1.0.2] - 2012-07-01
160160

161-
* [COOK-1394] - update ossec to version 2.6
161+
- [COOK-1394] - update ossec to version 2.6
162162

163163
## 1.0.0
164164

165-
* Initial/current release
165+
- Initial/current release

‎LIMITATIONS.md‎

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,12 @@ packages are unavailable or unsuitable.
114114

115115
### Build Dependencies
116116

117-
| Platform Family | Packages |
118-
|-----------------|----------|
119-
| Debian / Ubuntu | `build-essential`, `make`, `zlib1g-dev`, `libpcre2-dev`, `libevent-dev`, `libssl-dev`, `libsystemd-dev`, `libsqlite3-dev` |
120-
| RHEL / CentOS / Fedora / Amazon | `zlib-devel`, `pcre2-devel`, `make`, `gcc`, `sqlite-devel`, `openssl-devel`, `libevent-devel`, `systemd-devel` |
121-
| OpenSuse | `zlib-devel`, `pcre2-devel`, optional `postgresql-devel`, optional `mysql-devel` |
117+
- `Debian / Ubuntu`: `build-essential`, `make`, `zlib1g-dev`, `libpcre2-dev`,
118+
`libevent-dev`, `libssl-dev`, `libsystemd-dev`, `libsqlite3-dev`
119+
- `RHEL / CentOS / Fedora / Amazon`: `zlib-devel`, `pcre2-devel`, `make`,
120+
`gcc`, `sqlite-devel`, `openssl-devel`, `libevent-devel`, `systemd-devel`
121+
- `OpenSuse`: `zlib-devel`, `pcre2-devel`, optional `postgresql-devel`,
122+
optional `mysql-devel`
122123

123124
### Build-Time Notes
124125

@@ -144,34 +145,34 @@ packages are unavailable or unsuitable.
144145
## Sources
145146

146147
- Atomicorp package support docs:
147-
- https://docs.atomicorp.com/AEO/agents/requirements/index.html
148+
- <https://docs.atomicorp.com/AEO/agents/requirements/index.html>
148149
- Atomicorp archive trees:
149-
- https://updates.atomicorp.com/channels/atomic/ubuntu/dists/
150-
- https://updates.atomicorp.com/channels/atomic/debian/dists/
151-
- https://updates.atomicorp.com/channels/atomic/centos/
152-
- https://updates.atomicorp.com/channels/atomic/amazon/
153-
- https://updates.atomicorp.com/channels/atomic/fedora/
154-
- https://updates.atomicorp.com/channels/atomic/opensuse/
150+
- <https://updates.atomicorp.com/channels/atomic/ubuntu/dists/>
151+
- <https://updates.atomicorp.com/channels/atomic/debian/dists/>
152+
- <https://updates.atomicorp.com/channels/atomic/centos/>
153+
- <https://updates.atomicorp.com/channels/atomic/amazon/>
154+
- <https://updates.atomicorp.com/channels/atomic/fedora/>
155+
- <https://updates.atomicorp.com/channels/atomic/opensuse/>
155156
- Atomicorp mirror index:
156-
- https://updates.atomicorp.com/channels/mirrorlist/atomic/
157+
- <https://updates.atomicorp.com/channels/mirrorlist/atomic/>
157158
- GPG key and installer assets:
158-
- https://www.atomicorp.com/RPM-GPG-KEY.atomicorp.txt
159-
- https://updates.atomicorp.com/installers/
159+
- <https://www.atomicorp.com/RPM-GPG-KEY.atomicorp.txt>
160+
- <https://updates.atomicorp.com/installers/>
160161
- Upstream OSSEC installation requirements:
161-
- https://www.ossec.net/docs/docs/manual/installation/installation-requirements.html
162+
- <https://www.ossec.net/docs/docs/manual/installation/installation-requirements.html>
162163
- Upstream OSSEC package install docs:
163-
- https://www.ossec.net/docs/docs/manual/installation/installation-package.html
164+
- <https://www.ossec.net/docs/docs/manual/installation/installation-package.html>
164165
- Upstream OSSEC source install docs:
165-
- https://www.ossec.net/docs/docs/manual/installation/install-source.html
166+
- <https://www.ossec.net/docs/docs/manual/installation/install-source.html>
166167
- Lifecycle references:
167-
- https://endoflife.date/ubuntu
168-
- https://endoflife.date/debian
169-
- https://endoflife.date/centos
170-
- https://endoflife.date/centos-stream
171-
- https://endoflife.date/amazon-linux
172-
- https://endoflife.date/rhel
173-
- https://endoflife.date/rocky-linux
174-
- https://endoflife.date/oracle-linux
175-
- https://endoflife.date/fedora
176-
- https://endoflife.date/opensuse
177-
- https://scientificlinux.org/category/uncategorized/scientific-linux-end-of-life/
168+
- <https://endoflife.date/ubuntu>
169+
- <https://endoflife.date/debian>
170+
- <https://endoflife.date/centos>
171+
- <https://endoflife.date/centos-stream>
172+
- <https://endoflife.date/amazon-linux>
173+
- <https://endoflife.date/rhel>
174+
- <https://endoflife.date/rocky-linux>
175+
- <https://endoflife.date/oracle-linux>
176+
- <https://endoflife.date/fedora>
177+
- <https://endoflife.date/opensuse>
178+
- <https://scientificlinux.org/category/uncategorized/scientific-linux-end-of-life/>

‎documentation/ossec_agent_auth.md‎

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,33 @@ applies the resulting agent configuration.
55

66
## Actions
77

8-
| Action | Description |
9-
|--------|-------------|
10-
| `:create` | Installs the agent package, runs `agent-auth`, and writes agent configuration (default) |
11-
| `:delete` | Removes agent configuration, deletes `client.keys`, and removes the agent package |
8+
- `:create`: Installs the agent package, runs `agent-auth`, and writes agent
9+
configuration
10+
- `:delete`: Removes agent configuration, deletes `client.keys`, and removes
11+
the agent package
1212

1313
## Properties
1414

15-
| Property | Type | Default | Description |
16-
|----------|------|---------|-------------|
17-
| `install_dir` | String | `'/var/ossec'` | OSSEC installation directory |
18-
| `manage_repository` | Boolean | `true` | Whether the Atomicorp repository should be managed |
19-
| `ossec_conf` | Hash | `{}` | Additional OSSEC configuration merged over the defaults |
20-
| `agent_name` | String | node FQDN | Name passed to `agent-auth` |
21-
| `server_role` | String | `'ossec_server'` | Chef role used to discover the manager when `agent_server_ip` is not set |
22-
| `server_env` | String, nil | `nil` | Optional Chef environment filter for manager discovery |
23-
| `agent_server_ip` | String, nil | `nil` | Explicit manager IP address |
24-
| `port` | Integer | `1515` | authd listening port |
25-
| `ca` | String, nil | `nil` | Optional CA file passed to `agent-auth` |
26-
| `certificate` | String, nil | `nil` | Optional client certificate passed to `agent-auth` |
27-
| `key` | String, nil | `nil` | Optional client key passed to `agent-auth` |
15+
- `install_dir` (`String`, default: `'/var/ossec'`): OSSEC installation
16+
directory
17+
- `manage_repository` (`Boolean`, default: `true`): Whether the Atomicorp
18+
repository should be managed
19+
- `ossec_conf` (`Hash`, default: `{}`): Additional OSSEC configuration merged
20+
over the defaults
21+
- `agent_name` (`String`, default: node FQDN): Name passed to `agent-auth`
22+
- `server_role` (`String`, default: `'ossec_server'`): Chef role used to
23+
discover the manager when `agent_server_ip` is not set
24+
- `server_env` (`String, nil`, default: `nil`): Optional Chef environment
25+
filter for manager discovery
26+
- `agent_server_ip` (`String, nil`, default: `nil`): Explicit manager IP
27+
address
28+
- `port` (`Integer`, default: `1515`): authd listening port
29+
- `ca` (`String, nil`, default: `nil`): Optional CA file passed to
30+
`agent-auth`
31+
- `certificate` (`String, nil`, default: `nil`): Optional client certificate
32+
passed to `agent-auth`
33+
- `key` (`String, nil`, default: `nil`): Optional client key passed to
34+
`agent-auth`
2835

2936
## Examples
3037

‎documentation/ossec_authd.md‎

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,29 @@ the `ossec-authd` systemd unit.
55

66
## Actions
77

8-
| Action | Description |
9-
|--------|-------------|
10-
| `:create` | Installs the server package, writes configuration, and creates the authd unit (default) |
11-
| `:delete` | Stops and removes the authd unit, removes configuration, and removes the server package |
8+
- `:create`: Installs the server package, writes configuration, and creates the
9+
authd unit
10+
- `:delete`: Stops and removes the authd unit, removes configuration, and
11+
removes the server package
1212

1313
## Properties
1414

15-
| Property | Type | Default | Description |
16-
|----------|------|---------|-------------|
17-
| `install_dir` | String | `'/var/ossec'` | OSSEC installation directory |
18-
| `manage_repository` | Boolean | `true` | Whether the Atomicorp repository should be managed |
19-
| `ossec_conf` | Hash | `{}` | Additional OSSEC configuration merged over the defaults |
20-
| `agent_conf` | Array | `[]` | Agent configuration entries written to `agent.conf` |
21-
| `ip_address` | Boolean | `false` | Passes `-i` to `ossec-authd` to bind the configured IP |
22-
| `port` | Integer | `1515` | authd listening port |
23-
| `ca` | String, nil | `nil` | Optional CA file passed as `-v` |
24-
| `certificate` | String | `'/var/ossec/etc/sslmanager.cert'` | SSL certificate path |
25-
| `key` | String | `'/var/ossec/etc/sslmanager.key'` | SSL private key path |
15+
- `install_dir` (`String`, default: `'/var/ossec'`): OSSEC installation
16+
directory
17+
- `manage_repository` (`Boolean`, default: `true`): Whether the Atomicorp
18+
repository should be managed
19+
- `ossec_conf` (`Hash`, default: `{}`): Additional OSSEC configuration merged
20+
over the defaults
21+
- `agent_conf` (`Array`, default: `[]`): Agent configuration entries written to
22+
`agent.conf`
23+
- `ip_address` (`Boolean`, default: `false`): Passes `-i` to `ossec-authd` to
24+
bind the configured IP
25+
- `port` (`Integer`, default: `1515`): authd listening port
26+
- `ca` (`String, nil`, default: `nil`): Optional CA file passed as `-v`
27+
- `certificate` (`String`, default: `'/var/ossec/etc/sslmanager.cert'`): SSL
28+
certificate path
29+
- `key` (`String`, default: `'/var/ossec/etc/sslmanager.key'`): SSL private key
30+
path
2631

2732
## Examples
2833

‎documentation/ossec_client.md‎

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,31 @@ configuration.
66

77
## Actions
88

9-
| Action | Description |
10-
|--------|-------------|
11-
| `:create` | Installs and configures an OSSEC agent (default) |
12-
| `:delete` | Removes agent configuration, key material, and the agent package |
9+
- `:create`: Installs and configures an OSSEC agent
10+
- `:delete`: Removes agent configuration, key material, and the agent package
1311

1412
## Properties
1513

16-
| Property | Type | Default | Description |
17-
|----------|------|---------|-------------|
18-
| `install_dir` | String | `'/var/ossec'` | OSSEC installation directory |
19-
| `manage_repository` | Boolean | `true` | Whether the Atomicorp repository should be managed |
20-
| `ossec_conf` | Hash | `{}` | Additional OSSEC configuration merged over the defaults |
21-
| `data_bag_name` | String | `'ossec'` | Data bag name containing SSH key material |
22-
| `ssh_data_bag_item` | String | `'ssh'` | Data bag item containing the public key |
23-
| `encrypted_data_bag` | Boolean | `false` | Whether the SSH data bag item is encrypted |
24-
| `server_role` | String | `'ossec_server'` | Chef role used to discover the manager when `agent_server_ip` is not set |
25-
| `server_env` | String, nil | `nil` | Optional Chef environment filter for manager discovery |
26-
| `agent_server_ip` | String, nil | `nil` | Explicit manager IP address |
27-
| `client_keys_content` | String, nil | `nil` | Optional content written to `client.keys` |
14+
- `install_dir` (`String`, default: `'/var/ossec'`): OSSEC installation
15+
directory
16+
- `manage_repository` (`Boolean`, default: `true`): Whether the Atomicorp
17+
repository should be managed
18+
- `ossec_conf` (`Hash`, default: `{}`): Additional OSSEC configuration merged
19+
over the defaults
20+
- `data_bag_name` (`String`, default: `'ossec'`): Data bag name containing SSH
21+
key material
22+
- `ssh_data_bag_item` (`String`, default: `'ssh'`): Data bag item containing
23+
the public key
24+
- `encrypted_data_bag` (`Boolean`, default: `false`): Whether the SSH data bag
25+
item is encrypted
26+
- `server_role` (`String`, default: `'ossec_server'`): Chef role used to
27+
discover the manager when `agent_server_ip` is not set
28+
- `server_env` (`String, nil`, default: `nil`): Optional Chef environment
29+
filter for manager discovery
30+
- `agent_server_ip` (`String, nil`, default: `nil`): Explicit manager IP
31+
address
32+
- `client_keys_content` (`String, nil`, default: `nil`): Optional content
33+
written to `client.keys`
2834

2935
## Examples
3036

0 commit comments

Comments
 (0)