inspec/docs/resources/runit_service.md.erb
David Wrede 9283f19b6e Changing headings to align with SEO best practices
Signed-off-by: David Wrede <dwrede@chef.io>
2016-09-27 12:03:23 -07:00

76 lines
1.6 KiB
Text

---
title: About the runit_service Resource
---
# runit_service
Use the `runit_service` InSpec audit resource to test a service using runit.
## Syntax
A `runit_service` resource block declares the name of a service and then one (or more) matchers to test the state of the service:
describe runit_service('service_name') do
it { should be_installed }
it { should be_enabled }
it { should be_running }
end
where
* `('service_name')` must specify a service name
* `be_installed`, `be_enabled`, and `be_running` are valid matchers for this resource; all matchers available to the `service` resource may be used
The path to the service manager's control may be specified for situations where the path isn't available in the current `PATH`. For example:
describe runit_service('service_name', '/path/to/control') do
it { should be_enabled }
it { should be_installed }
it { should be_running }
end
## Matchers
This InSpec audit resource has the following matchers:
### be
<%= partial "/shared/matcher_be" %>
### be_enabled
The `be_enabled` matcher tests if the named service is enabled:
it { should be_enabled }
### be_installed
The `be_installed` matcher tests if the named service is installed:
it { should be_installed }
### be_running
The `be_running` matcher tests if the named service is running:
it { should be_running }
### cmp
<%= partial "/shared/matcher_cmp" %>
### eq
<%= partial "/shared/matcher_eq" %>
### include
<%= partial "/shared/matcher_include" %>
### match
<%= partial "/shared/matcher_match" %>
## Examples
None.