summaryrefslogtreecommitdiff
path: root/lib/chef/resource/cron_access.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/chef/resource/cron_access.rb')
-rw-r--r--lib/chef/resource/cron_access.rb19
1 files changed, 19 insertions, 0 deletions
diff --git a/lib/chef/resource/cron_access.rb b/lib/chef/resource/cron_access.rb
index 6c0272b667..37dd5959c5 100644
--- a/lib/chef/resource/cron_access.rb
+++ b/lib/chef/resource/cron_access.rb
@@ -28,6 +28,25 @@ class Chef
introduced "14.4"
description "Use the cron_access resource to manage the /etc/cron.allow and /etc/cron.deny files."
+ examples <<~DOC
+ Add the mike user to cron.allow
+ ```ruby
+ cron_access 'mike'
+ ```
+ Add the mike user to cron.deny
+ ```ruby
+ cron_access 'mike' do
+ action :deny
+ end
+ ```
+ Specify the username with the user property
+ ```ruby
+ cron_access 'Deny the tomcat access to cron for security purposes' do
+ user 'jenkins'
+ action :deny
+ end
+ ```
+ DOC
property :user, String,
description: "An optional property to set the user name if it differs from the resource block's name.",