Skip to content

Commit

Permalink
docs(components): update for separation of pkg, config & service
Browse files Browse the repository at this point in the history
  • Loading branch information
myii committed Feb 28, 2019
1 parent 4443518 commit 726fcab
Showing 1 changed file with 32 additions and 3 deletions.
35 changes: 32 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,12 @@ Available states

Meta-state (This is a state that includes other states)

This installs the template package, and starts the associated template service.
This installs the template package,
manages the template configuration file and then
starts the associated template service.

``template.install``
--------------------
``template.pkg``
----------------

This state will install the template package only.

Expand All @@ -67,3 +69,30 @@ via include list.
This state will start the template service and has a depency on ``template.config``
via include list.

``template.clean``
------------------

Meta-state (This is a state that includes other states)

This state will undo everything performed in the ``template`` meta-state in reverse order, i.e.
stops the service,
removes the configuration file and
then uninstalls the package.

``template.service.clean``
--------------------------

This state will stop the template service only.

``template.config.clean``
-------------------------

This state will remove the configuration of the template service and has a depency on ``template.service.clean``
via include list.

``template.pkg.clean``
----------------------

This state will remove the template package and has a depency on ``template.config.clean``
via include list.

0 comments on commit 726fcab

Please sign in to comment.