poise-service 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92c813d92c8af7d4c18ec212f0c9539a535abc42
+  data.tar.gz: 655fd28e30903b194a92ca42d68a3c810bf132fe
+SHA512:
+  metadata.gz: b3d0af699173014347e5518144b66ea8d89570cb0039c989b3a9ad0fb43612bc72b5c9516ab89e61e9f0f6af8bba92c4a3a29565649cccf74f8b4d48557b7c44
+  data.tar.gz: 5b59948c6fe65b14f7904a1c2783a977e31ec3f2fb46b273c1ee3d625ae2eaabec74693da9420b4e0c428b79d0d317045a5c18d98f8495f6203efe2f76a23e80

data/.gitignore

@@ -0,0 +1,10 @@
+.kitchen/
+.kitchen.local.yml
+.vagrant/
+test/docker/
+Gemfile.lock
+Berksfile.lock
+coverage/
+.yardoc/
+doc/
+

data/.kitchen.travis.yml

@@ -0,0 +1,4 @@
+---
+driver:
+  name: rackspace
+  flavor_id: general1-1

data/.kitchen.yml

@@ -0,0 +1,9 @@
+---
+#<% require 'poise_boiler' %>
+<%= PoiseBoiler.kitchen(platforms: 'linux') %>
+
+suites:
+- name: default
+  run_list:
+  - recipe[poise-service_test]
+  - recipe[poise-service_test::mixin]

data/.travis.yml

@@ -0,0 +1,23 @@
+sudo: false
+cache: bundler
+language: ruby
+addons:
+  apt:
+    packages:
+    - libgecode-dev
+rvm:
+- 2.1.4
+env:
+  global:
+  - USE_SYSTEM_GECODE=true
+  - KITCHEN_LOCAL_YAML=.kitchen.travis.yml
+  - RACKSPACE_USERNAME=coderanger
+  - secure: XpFA4AwBW5v4o3IuwKVSCTeVr6jXsW13T6ShGPpru4q+W2Zpcwh1qyBbxkkIWlkNjbhAT7G0HzQOqYcvUssYLEUYUNSlN10hxjpTZxvVj5sGjjhS3iTXbSop0NXzQthNRHfVZeK9ZWc+zP1MHGImjGCkErkin1+vu/SwMfIl2/8=
+  - secure: k36byJyrxjPXKqMjlhojJJwA3iTgVcy1z8zJzUMf0v6JGLsbLbMLfOxkTwIhuLZ3mFEQHvv0TZ8rm84Mg8pYb95fChF2rZNHasRDDB5rFBd++HaYirSC0kndXpZ5gLBhSZXggDv8ROANgKwgWmI0PDDZz96rR/tPDD7edZIvgfc=
+  - secure: OZhgvnu2op+rxg6ECSYlWGwaD1xIyOhzQtxqwzA4F/59RiR667JWaSTAmdEDN6SKmrqphxmZatzDEVXLaidbzAC0yAVv7zt4JbkLLZwmLFpq0YL+128sjgI4iUXomJhLxFqZyl8xmDhbu2pZLVyIR0S5Y0VUnu4kTmKDpvBwYsA=
+bundler_args: "--binstubs=$PWD/bin --jobs 3 --retry 3"
+script:
+- "./bin/rake travis"
+gemfile:
+- test/gemfiles/chef-12.gemfile
+- test/gemfiles/master.gemfile

data/.yardopts

@@ -0,0 +1,6 @@
+--plugin classmethods
+--markup markdown
+--hide-api private
+--hide-void-return
+--tag provides:Provides
+--tag action:Actions

data/Berksfile

@@ -0,0 +1,27 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+source 'https://supermarket.chef.io/'
+extension 'halite'
+
+# Force the rebuild every time for development.
+cookbook 'poise', gem: 'poise'
+cookbook 'poise-service', gem: 'poise-service'
+
+group :test do
+  cookbook 'poise-service_test', path: 'test/cookbooks/poise-service_test'
+  cookbook 'apt'
+end

data/Gemfile

@@ -0,0 +1,33 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+source 'https://rubygems.org/'
+
+gemspec path: File.expand_path('..', __FILE__)
+
+def dev_gem(name, path: File.join('..', name))
+  path = File.expand_path(File.join('..', path), __FILE__)
+  if File.exist?(path)
+    gem name, path: path
+  end
+end
+
+dev_gem 'halite'
+dev_gem 'poise'
+dev_gem 'poise-boiler'
+
+# Pending https://github.com/acrmp/foodcritic/pull/312 in a release.
+gem 'foodcritic', github: 'acrmp/foodcritic'

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,381 @@
+# Poise-Service Cookbook
+
+[![Build Status](https://img.shields.io/travis/poise/poise-service.svg)](https://travis-ci.org/poise/poise-service)
+[![Gem Version](https://img.shields.io/gem/v/poise-service.svg)](https://rubygems.org/gems/poise-service)
+[![Cookbook Version](https://img.shields.io/cookbook/v/poise-service.svg)](https://supermarket.chef.io/cookbooks/poise-service)
+[![Coverage](https://img.shields.io/codecov/c/github/poise/poise-service.svg)](https://codecov.io/github/poise/poise-service)
+[![Gemnasium](https://img.shields.io/gemnasium/poise/poise-service.svg)](https://gemnasium.com/poise/poise-service)
+[![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+A [Chef](https://www.chef.io/) cookbook to provide a unified interface for
+services.
+
+### What is poise-service?
+
+Poise-service is a tool for developers of "library cookbooks" to define a
+service without forcing the end-user of the library to adhere to their choice of
+service management framework. The `poise_service` resource represents an
+abstract service to be run, which can then be customized by node attributes and
+the `poise_service_options` resource. This is a technique called [dependency
+injection](https://en.wikipedia.org/wiki/Dependency_injection), and allows a
+measure of decoupling between the library and application cookbooks.
+
+### Why would I use poise-service?
+
+Poise-service is most useful for authors of library-style cookbooks, for example
+the `apache2`, `mysql`, or `application` cookbooks. When using other service
+management options with Chef, the author of the library cookbook has to add
+specific code for each service management framework they want to support, often
+resulting in a cookbook only supporting the favorite framework of the author or
+depending on distribution packages for their init scripts. The `poise_service`
+resource allows library cookbook authors a way to write generic code for all
+service management frameworks while still allowing users of that cookbook to
+choose which service management framework best fits their needs.
+
+### How is this different from the built-in service resource?
+
+Chef includes a `service` resource which allows interacting with certain
+service management frameworks such as SysV, Upstart, and systemd.
+`poise-service` goes further in that it actually generates the configuration
+files needed for the requested service management framework, as well as offering
+a dependency injection system for application cookbooks to customize which
+framework is used.
+
+### What service management frameworks are supported?
+
+* SysV (aka /etc/init.d)
+* Upstart
+* systemd
+* [Runit](https://github.com/poise/poise-service-runit)
+* *Supervisor (coming soon!)*
+
+
+## Quick Start
+
+To create a service user and a service to run Apache2:
+
+```ruby
+poise_service_user 'www-data'
+
+poise_service 'apache2' do
+  command '/usr/sbin/apache2 -f /etc/apache2/apache2.conf -DFOREGROUND'
+  stop_signal 'WINCH'
+  reload_signal 'USR1'
+end
+```
+
+or for a hypothetical Rails web application:
+
+```ruby
+poise_service_user 'myapp'
+
+poise_service 'myapp-web' do
+  command 'bundle exec unicorn -p 8080'
+  user 'myapp'
+  directory '/srv/myapp'
+  environment RAILS_ENV: 'production'
+end
+```
+
+## Resources
+
+### `poise_service`
+
+The `poise_service` resource is the abstract definition of a service.
+
+```ruby
+poise_service 'myapp' do
+  command 'myapp --serve'
+  environment RAILS_ENV: 'production'
+end
+```
+
+#### Actions
+
+* `:enable` – Create, enable and start the service. *(default)*
+* `:disable` – Stop, disable, and destroy the service.
+* `:start` – Start the service.
+* `:stop` – Stop the service.
+* `:restart` – Stop and then start the service.
+* `:reload` – Send the configured reload signal to the service.
+
+#### Attributes
+
+* `service_name` – Name of the service. *(name attribute)*
+* `command` – Command to run for the service. This command must stay in the
+  foreground and not daemonize itself. *(required)*
+* `user` – User to run the service as. See
+  [`poise_service_user`](#poise_service_user) for any easy way to create service
+   users. *(default: root)*
+* `directory` – Working directory for the service. *(default: home directory for
+  user, or / if not found)*
+* `environment` – Environment variables for the service.
+* `stop_signal` – Signal to use to stop the service. Some systems will fall back
+  to SIGKILL if this signal fails to stop the process. *(default: TERM)*
+* `reload_signal` – Signal to use to reload the service. *(default: HUP)*
+* `restart_on_update` – If true, the service will be restarted if the service
+  definition or configuration changes. If `'immediately'`, the notification will
+  happen in immediate mode. *(default: true)*
+
+#### Service Options
+
+The `poise-service` library offers an additional way to pass configuration
+information to the final service called "options". Options are key/value pairs
+that are passed down to the service provider and can be used to control how it
+creates and manages the service. These can be set in the `poise_service`
+resource using the `options` method, in node attributes or via the
+`poise_service_options` resource. The options from all sources are merged
+together into a single hash based.
+
+When setting options in the resource you can either set them for all providers:
+
+```ruby
+poise_service 'myapp' do
+  command 'myapp --serve'
+  options status_port: 8000
+end
+```
+
+or for a single provider:
+
+```ruby
+poise_service 'myapp' do
+  command 'myapp --serve'
+  options :systemd, after_target: 'network'
+end
+```
+
+Setting via node attributes is generally how an end-user or application cookbook
+will set options to customize services in the library cookbooks they are using.
+You can set options for all services or for a single service, by service name
+or by resource name:
+
+```ruby
+# Global, for all services.
+override['poise-service']['options']['after_target'] = 'network'
+# Single service.
+override['poise-service']['myapp']['template'] = 'myapp.erb'
+```
+
+The `poise_service_options` resource is also available to set node attributes
+for a specific service in a DSL-friendly way:
+
+```ruby
+poise_service_options 'myapp' do
+  template 'myapp.erb'
+  restart_on_update false
+end
+```
+
+Unlike resource attributes, service options can be different for each provide.
+Not all providers support the same options so make sure to the check the
+documentation for each provider to see what options the use.
+
+### `poise_service_options`
+
+The `poise_service_options` resource allows setting per-service options in a
+DSL-friendly way. See [the Service Options](#service-options) section for more
+information about service options overall.
+
+```ruby
+poise_service_options 'myapp' do
+  template 'myapp.erb'
+  restart_on_update false
+end
+```
+
+#### Actions
+
+* `:run` – Apply the service options. *(default)*
+
+#### Attributes
+
+* `service_name` – Name of the service. *(name attribute)*
+* `for_provider` – Provider to set options for. If set, the resource must be
+  defined and reachable before the `poise_service_options` resource.
+
+All other attribute keys will be used as options data.
+
+### `poise_service_user`
+
+The `poise_service_user` resource is an easy way to create service users. It is
+not required to use `poise_service`, it is only a helper.
+
+```ruby
+poise_service_user 'myapp' do
+  home '/srv/myapp'
+end
+```
+
+#### Actions
+
+* `:create` – Create the user and group. *(default)*
+* `:remove` – Remove the user and group.
+
+#### Attributes
+
+* `user` – Name of the user. *(name attribute)*
+* `group` – Name of the group. Set to `false` to disable group creation. *(name attribute)*
+* `uid` – UID of the user. If unspecified it will be automatically allocated.
+* `gid` – GID of the group. If unspecified it will be automatically allocated.
+* `home` – Home directory of the user.
+
+## Providers
+
+### `sysvinit`
+
+The `sysvinit` provider supports SystemV-style init systems on Debian-family and
+RHEL-family platforms. It will create the `/etc/init.d/<service_name>` script
+and enable/disable the service using the platform-specific service resource.
+
+```ruby
+poise_service 'myapp' do
+  provider :sysvinit
+  command 'myapp --serve'
+end
+```
+
+By default a PID file will be created in `/var/run/service_name.pid`. You can
+use the `pid_file` option detailed below to override this and rely on your
+process creating a PID file in the given path. This is highly recommended on
+RHEL-family platforms as automatic PID detection there is more finicky.
+
+#### Options
+
+* `pid_file` – Path to PID file that the service command will create.
+* `template` – Override the default script template. If you want to use a
+  template in a different cookbook use `'cookbook:template'`.
+* `command` – Override the service command.
+* `directory` – Override the service directory.
+* `environment` – Override the service environment variables.
+* `reload_signal` – Override the service reload signal.
+* `stop_signal` – Override the service stop signal.
+* `user` – Override the service user.
+* `never_restart` – Never try to restart the service.
+* `never_reload` – Never try to reload the service.
+
+### `upstart`
+
+The `upstart` provider supports [Upstart](http://upstart.ubuntu.com/). It will
+create the `/etc/init/service_name.conf` configuration.
+
+```ruby
+poise_service 'myapp' do
+  provider :upstart
+  command 'myapp --serve'
+end
+```
+
+As a wide variety of versions of Upstart are in use in various Linux
+distributions, the provider does its best to identify which features are
+available and provide shims as appropriate. Most of these should be invisible
+however Upstart older than 1.10 does not support setting a `reload signal` so
+only SIGHUP can be used. You can set a `reload_shim` option to enable an
+internal implementaion of reloading to be used for signals other than SIGHUP,
+however as this is implemented inside Chef code, running `initctl reload` would
+still result in SIGHUP being sent. For this reason, the feature is disabled by
+default and will throw an error if a reload signal other than SIGHUP is used.
+
+#### Options
+
+* `reload_shim` – Enable the reload signal shim. See above for a warning about
+  this feature.
+* `template` – Override the default configuration template. If you want to use a
+  template in a different cookbook use `'cookbook:template'`.
+* `command` – Override the service command.
+* `directory` – Override the service directory.
+* `environment` – Override the service environment variables.
+* `reload_signal` – Override the service reload signal.
+* `stop_signal` – Override the service stop signal.
+* `user` – Override the service user.
+* `never_restart` – Never try to restart the service.
+* `never_reload` – Never try to reload the service.
+
+### `systemd`
+
+The `systemd` provider supports [systemd](http://www.freedesktop.org/wiki/Software/systemd/).
+It will create the `/etc/systemd/system/service_name.service` configuration.
+
+
+```ruby
+poise_service 'myapp' do
+  provider :systemd
+  command 'myapp --serve'
+end
+```
+
+#### Options
+
+* `template` – Override the default configuration template. If you want to use a
+  template in a different cookbook use `'cookbook:template'`.
+* `command` – Override the service command.
+* `directory` – Override the service directory.
+* `environment` – Override the service environment variables.
+* `reload_signal` – Override the service reload signal.
+* `stop_signal` – Override the service stop signal.
+* `user` – Override the service user.
+* `never_restart` – Never try to restart the service.
+* `never_reload` – Never try to reload the service.
+
+## ServiceMixin
+
+For the common case of a resource (LWRP or plain Ruby) that roughly maps to
+"some config files and a service" poise-service provides a mixin module,
+`PoiseService::ServiceMixin`. This mixin adds the standard service actions
+(`enable`, `disable`, `start`, `stop`, `restart`, and `reload`) with basic
+implementations that call those actions on a `poise_service` resource for you.
+You customize the service by defining a `service_options` method on your
+provider class:
+
+```ruby
+def service_options(service)
+  # service is the PoiseService::Resource object instance.
+  service.command "/usr/sbin/#{new_resource.name} -f /etc/#{new_resource.name}/conf/httpd.conf -DFOREGROUND"
+  service.stop_signal 'WINCH'
+  service.reload_signal 'USR1'
+end
+```
+
+You will generally want to override the `enable` action to install things
+related to the service like packages, users and configuration files:
+
+```ruby
+def action_enable
+  notifying_block do
+    package 'apache2'
+    poise_service_user 'www-data'
+    template "/etc/#{new_resource.name}/conf/httpd.conf" do
+      # ...
+    end
+  end
+  # This super call will run the normal service enable,
+  # creating the service and starting it.
+  super
+end
+```
+
+See [the poise_service_test_mixin resource](test/cookbooks/poise-service_test/resources/mixin.rb)
+and [provider](test/cookbooks/poise-service_test/resources/mixin.rb) for
+examples of using `ServiceMixin` in an LWRP.
+
+## Sponsors
+
+Development sponsored by [Bloomberg](http://www.bloomberg.com/company/technology/).
+
+The Poise test server infrastructure is sponsored by [Rackspace](https://rackspace.com/).
+
+## License
+
+Copyright 2015, Noah Kantrowitz
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.