Skip to content

Commit 726fcab

Browse files
committed
docs(components): update for separation of pkg, config & service
1 parent 4443518 commit 726fcab

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

README.rst

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,12 @@ Available states
4848

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

51-
This installs the template package, and starts the associated template service.
51+
This installs the template package,
52+
manages the template configuration file and then
53+
starts the associated template service.
5254

53-
``template.install``
54-
--------------------
55+
``template.pkg``
56+
----------------
5557

5658
This state will install the template package only.
5759

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

72+
``template.clean``
73+
------------------
74+
75+
Meta-state (This is a state that includes other states)
76+
77+
This state will undo everything performed in the ``template`` meta-state in reverse order, i.e.
78+
stops the service,
79+
removes the configuration file and
80+
then uninstalls the package.
81+
82+
``template.service.clean``
83+
--------------------------
84+
85+
This state will stop the template service only.
86+
87+
``template.config.clean``
88+
-------------------------
89+
90+
This state will remove the configuration of the template service and has a depency on ``template.service.clean``
91+
via include list.
92+
93+
``template.pkg.clean``
94+
----------------------
95+
96+
This state will remove the template package and has a depency on ``template.config.clean``
97+
via include list.
98+

0 commit comments

Comments
 (0)