From 726fcabc6d36f25f4d5b1286d09789eede7623fa Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Mon, 25 Feb 2019 16:23:59 +0000 Subject: [PATCH] docs(components): update for separation of `pkg`, `config` & `service` --- README.rst | 35 ++++++++++++++++++++++++++++++++--- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 1d5d1125..bfacb60c 100644 --- a/README.rst +++ b/README.rst @@ -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. @@ -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. +