diff options
| author | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2012-06-05 17:34:29 -0400 |
|---|---|---|
| committer | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2012-06-05 17:34:34 -0400 |
| commit | 42e619c585de45e5e4e16ae3746efb7db9f90b1e (patch) | |
| tree | dfdf1905a4bf586bba321d6ab562343cf1ebc28a /doc | |
| parent | c6e7bfed9b6563b0c567997f063a8259ec548519 (diff) | |
| download | bcfg2-42e619c585de45e5e4e16ae3746efb7db9f90b1e.tar.gz bcfg2-42e619c585de45e5e4e16ae3746efb7db9f90b1e.tar.bz2 bcfg2-42e619c585de45e5e4e16ae3746efb7db9f90b1e.zip | |
re-rationalized service modes to make them more consistent and granular
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/server/plugins/generators/rules.txt | 59 |
1 files changed, 35 insertions, 24 deletions
diff --git a/doc/server/plugins/generators/rules.txt b/doc/server/plugins/generators/rules.txt index 03372b120..3b1d94480 100644 --- a/doc/server/plugins/generators/rules.txt +++ b/doc/server/plugins/generators/rules.txt @@ -118,7 +118,14 @@ Service Tag +------------+-------------------------------+---------------------------------------------------------+ | Name | Description | Values | +============+===============================+=========================================================+ -| mode | Per Service Mode (New in 1.0) | (manual | default | supervised | interactive_only ) | +| restart | Whether to restart the | ( true | false | interactive ) | +| | service when the bundle | | +| | changes (new in 1.3; replaces | | +| | "mode" attribute) | | ++------------+-------------------------------+---------------------------------------------------------+ +| install | Whether to install the | ( true | false ) | +| | service (new in 1.3; replaces | | +| | "mode" attribute) | | +------------+-------------------------------+---------------------------------------------------------+ | name | Service name or regular | String or regex | | | expression | | @@ -139,29 +146,33 @@ Service Tag | | (Upstart services only) | | +------------+-------------------------------+---------------------------------------------------------+ -Service mode descriptions -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. versionadded:: 1.0.0 - -* manual - - * do not start/stop/restart this service - * service installation is not performed - -* interactive_only - - * only attempt to start/stop/restart this service if the client is run interactively - * service installation is performed - -* default - - * perform appropriate service operations - -* supervised - - * default and ensure service is running (or stopped) when verification is performed - * deprecates supervised='true' +Service mode specification +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. versionadded:: 1.3.0 + +In the 1.3.0 release, the "mode" attribute has been replaced by a pair +of attributes, "restart" and "install," which control how a service is +handled more granularly than the old "mode" attribute. The old "mode" +attribute values are equivalent as follows: + ++-----------------------------+------------------------------------------+ +| Mode attribute | Equivalent | ++=============================+==========================================+ +| ``mode="default"`` | ``restart="true" install="true"`` | ++-----------------------------+------------------------------------------+ +| ``mode="interactive_only"`` | ``restart="interactive" install="true"`` | ++-----------------------------+------------------------------------------+ +| ``mode="supervised"`` | ``restart="true" install="true"`` | ++-----------------------------+------------------------------------------+ +| ``mode="manual"`` | ``restart="false" install="false"`` | ++-----------------------------+------------------------------------------+ + +The default is ``restart="true" install="true"`` + +Previously, "supervised" could be used to start a service during the +verification phase; this is no longer supported. Services that have +been stopped on a client will be started during the install phase. Service status descriptions ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |