karel/salt-gitea-formula
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Update template

Browse Source
This commit is contained in:
jeanluc
2023-02-05 18:55:53 +01:00
parent f3a5dead23
commit c58b3ea081
53 changed files with 672 additions and 265 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
docs/README.rst
View File

@@ -73,64 +73,92 @@ Configuration
-------------
An example pillar is provided, please see `pillar.example`. Note that you do not need to specify everything by pillar. Often, it's much easier and less resource-heavy to use the ``parameters/<grain>/<value>.yaml`` files for non-sensitive settings. The underlying logic is explained in `map.jinja`.
Available states
----------------
The following states are found in this formula:
.. contents::
:local:
``gitea``
^^^^^^^^^
*Meta-state (This is a state that includes other states)*.
gitea
^^^^^
*Meta-state*.
This installs the gitea package,
manages the gitea configuration file and then
starts the associated gitea service.
manages the gitea configuration file
and then starts the associated gitea service.
``gitea.package``
^^^^^^^^^^^^^^^^^
gitea.package
^^^^^^^^^^^^^
This state will install the gitea package only.
``gitea.config``
^^^^^^^^^^^^^^^^
This state will configure the gitea service and has a dependency on ``gitea.install``
via include list.
gitea.config
^^^^^^^^^^^^
This state will configure the gitea service
and has a dependency on ``gitea.install`` via include list.
``gitea.service``
^^^^^^^^^^^^^^^^^
This state will start the gitea service and has a dependency on ``gitea.config``
via include list.
gitea.service
^^^^^^^^^^^^^
This state will start the gitea service
and has a dependency on ``gitea.config`` via include list.
``gitea.clean``
^^^^^^^^^^^^^^^
*Meta-state (This is a state that includes other states)*.
gitea.go
^^^^^^^^
This state will undo everything performed in the ``gitea`` meta-state in reverse order, i.e.
gitea.mods.rst
^^^^^^^^^^^^^^
gitea.clean
^^^^^^^^^^^
*Meta-state*.
This state will undo everything performed in the ``gitea`` meta-state
in reverse order, i.e.
stops the service,
removes the configuration file and
then uninstalls the package. Some paths are left to avoid accidental data loss (namely ``GITEA_WORKDIR``, ``APP_DATA_PATH`` and the gitea user home).
removes the configuration file and then
uninstalls the package.
Some paths are left to avoid accidental data loss
(namely ``GITEA_WORKDIR``, ``APP_DATA_PATH`` and the gitea user home).
``gitea.service.clean``
^^^^^^^^^^^^^^^^^^^^^^^
This state will stop the gitea service and disable it at boot time.
gitea.package.clean
^^^^^^^^^^^^^^^^^^^
This state will remove the gitea package and has a depency on
``gitea.config.clean`` via include list.
``gitea.config.clean``
^^^^^^^^^^^^^^^^^^^^^^
gitea.config.clean
^^^^^^^^^^^^^^^^^^
This state will remove the configuration of the gitea service and has a
dependency on ``gitea.service.clean`` via include list.
``gitea.package.clean``
^^^^^^^^^^^^^^^^^^^^^^^
This state will remove the gitea package and has a depency on
``gitea.config.clean`` via include list.
gitea.service.clean
^^^^^^^^^^^^^^^^^^^
This state will stop the gitea service and disable it at boot time.
gitea.go.clean
^^^^^^^^^^^^^^
gitea.mods.rst.clean
^^^^^^^^^^^^^^^^^^^^
Contributing to this repo
-------------------------