Class: Chef::Resource::Service

Inherits:
Chef::Resource show all
Defined in:
lib/chef/resource/service.rb

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #elapsed_time, #enclosing_provider, #not_if_args, #only_if_args, #params, #provider, #recipe_name, #resource_name, #retries, #retry_delay, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, #after_created, #as_json, #cookbook_version, #customize_exception, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, find_subclass_by_name, #identity, identity_attr, #ignore_failure, #immediate_notifications, inherited, #inspect, #is, json_create, #load_prior_resource, #method_missing, #name, #node, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, platform_map, provider_base, #provider_for_action, provides, #resolve_notification_references, resource_classes, resource_for_node, resource_for_platform, #resources, #run_action, #should_skip?, #state, state_attrs, #subscribes, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, #validate_action

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::Deprecation

#deprecated_ivar

Methods included from DSL::RegistryHelper

#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?

Methods included from DSL::PlatformIntrospection

#platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Methods included from Mixin::ParamsValidate

#set_or_return, #validate

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search

Constructor Details

#initialize(name, run_context = nil) ⇒ Service

Returns a new instance of Service.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/chef/resource/service.rb', line 30

def initialize(name, run_context=nil)
  super
  @resource_name = :service
  @service_name = name
  @enabled = nil
  @running = nil
  @parameters = nil
  @pattern = service_name
  @start_command = nil
  @stop_command = nil
  @status_command = nil
  @restart_command = nil
  @reload_command = nil
  @init_command = nil
  @priority = nil
  @action = "nothing"
  @startup_type = :automatic
  @supports = { :restart => false, :reload => false, :status => false }
  @allowed_actions.push(:enable, :disable, :start, :stop, :restart, :reload)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Resource

Instance Method Details

#enabled(arg = nil) ⇒ Object

if the service is enabled or not



126
127
128
129
130
131
132
 
# File 'lib/chef/resource/service.rb', line 126

def enabled(arg=nil)
  set_or_return(
    :enabled,
    arg,
    :kind_of => [ TrueClass, FalseClass ]
  )
end

#init_command(arg = nil) ⇒ Object

The path to the init script associated with the service. On many distributions this is ‘/etc/init.d/SERVICE_NAME’ by default. In non-standard configurations setting this value will save having to specify overrides for the start_command, stop_command and restart_command attributes.



117
118
119
120
121
122
123
 
# File 'lib/chef/resource/service.rb', line 117

def init_command(arg=nil)
  set_or_return(
    :init_command,
    arg,
    :kind_of => [ String ]
  )
end

#parameters(arg = nil) ⇒ Object 



159
160
161
162
163
164
 
# File 'lib/chef/resource/service.rb', line 159

def parameters(arg=nil)
  set_or_return(
    :parameters,
    arg,
    :kind_of => [ Hash ] )
end

#pattern(arg = nil) ⇒ Object

regex for match against ps -ef when !supports && status == nil



60
61
62
63
64
65
66
 
# File 'lib/chef/resource/service.rb', line 60

def pattern(arg=nil)
  set_or_return(
    :pattern,
    arg,
    :kind_of => [ String ]
  )
end

#priority(arg = nil) ⇒ Object

Priority arguments can have two forms:

  • a simple number, in which the default start runlevels get that as the start value and stop runlevels get 100 - value.

  • a hash like { 2 => [:start, 20], 3 => [:stop, 55] }, where the service will be marked as started with priority 20 in runlevel 2, stopped in 3 with priority 55 and no symlinks or similar for other runlevels



153
154
155
156
157
 
# File 'lib/chef/resource/service.rb', line 153

def priority(arg=nil)
  set_or_return(:priority,
                arg,
                :kind_of => [ Integer, String, Hash ])
end

#reload_command(arg = nil) ⇒ Object 



104
105
106
107
108
109
110
 
# File 'lib/chef/resource/service.rb', line 104

def reload_command(arg=nil)
  set_or_return(
    :reload_command,
    arg,
    :kind_of => [ String ]
  )
end

#restart_command(arg = nil) ⇒ Object

command to call to restart service



96
97
98
99
100
101
102
 
# File 'lib/chef/resource/service.rb', line 96

def restart_command(arg=nil)
  set_or_return(
    :restart_command,
    arg,
    :kind_of => [ String ]
  )
end

#running(arg = nil) ⇒ Object

if the service is running or not



135
136
137
138
139
140
141
 
# File 'lib/chef/resource/service.rb', line 135

def running(arg=nil)
  set_or_return(
    :running,
    arg,
    :kind_of => [ TrueClass, FalseClass ]
  )
end

#service_name(arg = nil) ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/chef/resource/service.rb', line 51

def service_name(arg=nil)
  set_or_return(
    :service_name,
    arg,
    :kind_of => [ String ]
  )
end

#start_command(arg = nil) ⇒ Object

command to call to start service



69
70
71
72
73
74
75
 
# File 'lib/chef/resource/service.rb', line 69

def start_command(arg=nil)
  set_or_return(
    :start_command,
    arg,
    :kind_of => [ String ]
  )
end

#status_command(arg = nil) ⇒ Object

command to call to get status of service



87
88
89
90
91
92
93
 
# File 'lib/chef/resource/service.rb', line 87

def status_command(arg=nil)
  set_or_return(
    :status_command,
    arg,
    :kind_of => [ String ]
  )
end

#stop_command(arg = nil) ⇒ Object

command to call to stop service



78
79
80
81
82
83
84
 
# File 'lib/chef/resource/service.rb', line 78

def stop_command(arg=nil)
  set_or_return(
    :stop_command,
    arg,
    :kind_of => [ String ]
  )
end

#supports(args = {}) ⇒ Object 



166
167
168
169
170
171
172
173
174
 
# File 'lib/chef/resource/service.rb', line 166

def supports(args={})
  if args.is_a? Array
    args.each { |arg| @supports[arg] = true }
  elsif args.any?
    @supports = args
  else
    @supports
  end
end