https://github.com/sous-chefs/logrotate
Development repository for the logrotate cookbook
https://github.com/sous-chefs/logrotate
chef chef-cookbook chef-resource hacktoberfest logrotate managed-by-terraform
Last synced: 17 days ago
JSON representation
Development repository for the logrotate cookbook
- Host: GitHub
- URL: https://github.com/sous-chefs/logrotate
- Owner: sous-chefs
- License: apache-2.0
- Created: 2012-03-14T18:15:46.000Z (about 13 years ago)
- Default Branch: main
- Last Pushed: 2024-02-01T00:10:19.000Z (about 1 year ago)
- Last Synced: 2024-04-14T11:03:41.587Z (about 1 year ago)
- Topics: chef, chef-cookbook, chef-resource, hacktoberfest, logrotate, managed-by-terraform
- Language: Ruby
- Homepage: https://supermarket.chef.io/cookbooks/logrotate
- Size: 339 KB
- Stars: 122
- Watchers: 27
- Forks: 155
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-chef - logrotate
README
# logrotate Cookbook
[](https://supermarket.chef.io/cookbooks/logrotate)
[](https://github.com/sous-chefs/logrotate/actions?query=workflow%3Aci)
[](#backers)
[](#sponsors)
[](https://opensource.org/licenses/Apache-2.0)
Manages the logrotate package and provides resources to manage both global and application-specific logrotate configurations. This cookbook allows you to manage the logrotate package installation and create configuration for both the main logrotate.conf file and application-specific configurations in /etc/logrotate.d/.
## Maintainers
This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit sous-chefs.org or come chat with us on the Chef Community Slack in #sous-chefs.
## Requirements
### Platforms
Should work on any platform that includes a 'logrotate' package and writes logrotate configuration to /etc/logrotate.d.
Tested on:
- Ubuntu / Debian
- CentOS
- Amazon Linux
- openSUSE Leap
### Chef
- Chef 15.3+
## Resources
- [logrotate_app](documentation/logrotate_app.md) - Manages application-specific logrotate configurations
- [logrotate_global](documentation/logrotate_global.md) - Manages the global logrotate configuration
- [logrotate_package](documentation/logrotate_package.md) - Manages the logrotate package installation
## Usage
### Package Installation
By default, the cookbook will install the logrotate package:
```ruby
logrotate_package 'logrotate'
```
### Global Configuration
To manage the global logrotate configuration:
```ruby
logrotate_global 'logrotate' do
options %w(weekly dateext)
parameters(
'rotate' => 4,
'create' => nil
)
paths(
'/var/log/wtmp' => {
'missingok' => true,
'monthly' => true,
'create' => '0664 root utmp',
'rotate' => 1
}
)
end
```
### Application-Specific Configuration
To create application-specific logrotate configs, use the `logrotate_app` resource:
```ruby
logrotate_app 'tomcat-myapp' do
path '/var/log/tomcat/myapp.log'
frequency 'daily'
rotate 30
create '644 root adm'
options %w(missingok compress delaycompress copytruncate notifempty)
end
```
For multiple log files:
```ruby
logrotate_app 'tomcat-myapp' do
path ['/var/log/tomcat/myapp.log', '/opt/local/tomcat/catalina.out']
frequency 'daily'
create '644 root adm'
rotate 7
end
```
## Contributors
This project exists thanks to all the people who [contribute.](https://opencollective.com/sous-chefs/contributors.svg?width=890&button=false)
### Backers
Thank you to all our backers!
### Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
