cookbook 'samhain', '~> 1.0.5'
The samhain cookbook has been deprecated
Author provided reason for deprecation:
The samhain cookbook has been deprecated and is no longer being maintained by its authors. Use of the samhain cookbook is no longer recommended.
samhain (8) Versions 1.0.5 Follow0
Installs/configures Samhain
cookbook 'samhain', '~> 1.0.5', :supermarket
knife supermarket install samhain
knife supermarket download samhain
Samhain Cookbook README
Installs and configures Samhain for host integrity monitoring.
Requirements
This cookbook is continously tested against a matrix of platforms and Chef versions; see the output of chef exec microwave list
for the current list.
Usage
Include the default recipe in your node's run list.
Recipes
default
Do a simple, attribute-based install of Samhain.
Attributes
default
The attributes in attributes/default.rb
are for the basic configuration of Samhain. They write to a file at /etc/samhain/samhainrc
The config is written at run time and can be extended from any book by adding attributes. Since the samhainrc is not a perfect hash, the syntax for adding attributes is a bit different.
To overwrite regular attributes:
default['samhain']['config']['Misc']['bacon'] = 'Applewood Smoked'
To add files or directories for monitoring:
default['samhain']['config']['LogFiles']['file']['path/to/my/file'] = true
The intent of the attributes file is to allow service owners to add files to the Samhain watchlist. For more information on Samhain, see their docs at Samhain Labs
Resources
samhain
A parent resource for the Samhain components.
Syntax:
samhain 'default' do config { 'Attributes' => { 'file' => { '/etc/mtab' => true } } } source 'http://example.com/samhain.package' action :create end
Actions:
Action | Description |
---|---|
:create |
Install, configure, and enaile+start Samhain |
:remove |
Stop+disable and remove Samhain |
Properties:
Property | Default | Description |
---|---|---|
config | nil |
A Samhain configuration hash |
source | nil |
An optional custom package PATH/URL |
action | :create |
Action(s) to perform |
samhain_app
A resource for installation and removal of the Samhain app package.
Syntax:
samhain_app 'default' do source 'http://example.com/samhain.package' action :install end
Actions:
Action | Description |
---|---|
:install |
Install the Samhain package |
:remove |
Uninstall the Samhain package |
Properties:
Property | Default | Description |
---|---|---|
source | nil |
An optional custom package PATH/URL |
action | :install |
Action(s) to perform |
samhain_config
A resource for generating Samhain configurations.
Syntax:
samhain_config 'default' do config { 'Attributes' => { 'file' => { '/etc/mtab' => true } } } action :create end
Actions:
Action | Description |
---|---|
:create |
Write out the samhainrc config file |
:remove |
Delete the samhainrc config file |
Properties:
Property | Default | Description |
---|---|---|
config | nil |
A Samhain configuration hash |
action | :create |
Action(s) to perform |
samhain_service
A resource for the Samhain service.
Syntax:
samhain_service 'default' do action [:create, :enable, :start] end
Actions:
Action | Description |
---|---|
:create |
Ensure the service is defined |
:remove |
Delete the service definition |
:enable |
Enable the service |
:disable |
Disable the service |
:start |
Start the service |
:stop |
Stop the service |
:restart |
Restart the service |
Properties:
Property | Default | Description |
---|---|---|
action | [:create, :enable, :start] |
Action(s) to perform |
Maintainers
- Jonathan Hartman <jonathan.hartman@tylertech.com
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Samhain Cookbook CHANGELOG
This file is used to list changes made in each version of the samhain cookbook.
1.0.5 (2019-11-13)
- Version bump to overcome build issue
1.0.4 (2019-11-12)
- Prevent any CRIT messsages.
1.0.3 (2019-11-07)
- Move attributes to attributes/default.rb
1.0.2 (2019-11-06)
- Move recipe to recipes/default.rb
1.0.1 (2019-11-06)
- Version bump to overcome build issue
1.0.0 (2019-04-10)
- Don't rely on Ohai's Passwd plugin
- Update all the cookbook boilerplate
- Drop support for Chef 11
- Drop support for Ubuntu 12.04
- Remove dependency on the apt cookbook
- Add support for Debian platforms
- Convert Chef 11-style HWRPs to custom resources
- Drop support for Chef < 14, Debian 8, Ubuntu 14.04
0.5.1 (2016-01-11)
- Catch and clean up cases of duplicate trusted users
0.5.0 (2016-01-09)
- Get rid of errors about access to
/var/log
by granting trusted status to any user with group-write access
0.4.0 (2015-12-30)
- Add support for legacy versions of Ubuntu (with testing done against 12.04)
0.3.0 (2015-12-21)
- Convert everything to HWRPs
0.2.0 (2015-12-15)
- Fix failures in service restarts and reloads in Ubuntu 14.04 by modifying the bug-impacted init script
0.1.0 (2015-12-04)
- Initial release
0.0.1 (2015-11-13)
- Development started
Collaborator Number Metric
1.0.5 failed this metric
Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
1.0.5 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
1.0.5 passed this metric
No Binaries Metric
1.0.5 passed this metric
Testing File Metric
1.0.5 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.0.5 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.0.5 failed this metric
1.0.5 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
1.0.5 passed this metric
No Binaries Metric
1.0.5 passed this metric
Testing File Metric
1.0.5 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.0.5 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.0.5 passed this metric
1.0.5 passed this metric
Testing File Metric
1.0.5 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.0.5 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.0.5 failed this metric
1.0.5 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number