diff --git a/docs/README.md b/docs/README.md index 813382b..0c47862 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,32 +1,6 @@ This repository holds the documentation of the provs framework. -# Provs framework - -Provs is an easy-to-use provisioning framework for automating shell-commands or other tasks for provisioning reasons and other purposes. - -It combines -* convenience and robustness of a modern programming language -* the power of shell commands -* clear and detailed result summary of the built-in execution handling - -The provs framework consists of several layers. The most important are -* provs-core -* provs-ubuntu -* provs-ubuntu-extensions - -### Write once, run everywhere - -Tasks can be run - -* locally -* remotely -* in a local docker container -* and also in a remote container - -Besides, it is possible to define a custom processor. - - -## Usage +# Design principles For usage examples it is recommended to have a look at [provs-scripts](https://gitlab.com/domaindrivenarchitecture/provs-scripts) or [provs-ubuntu-extensions](https://gitlab.com/domaindrivenarchitecture/provs-ubuntu-extensions). @@ -48,27 +22,25 @@ On the other hand, the built-in functions of the provs framework also provide im Idempotence means that you can run the same function once or several times without problems, you'll always get the same result. However, there are cases where you don't want strict idempotence. E.g. if you are installing a program or cloning a git repo a second time, you might want to get just the latest version, even if an older version has already been installed earlier. This behavior is also known as quasi-idempotence. -The provs framework uses quasi-idempotence where "real" idempotence is not possible or does not make sense. -For example, if you invoke "gitClone" a second time for the same repo, it will perform a "git pull" in order to retrieve the latest version of the repo. -Note, that git itself would throw an error if you would attempt to clone a repository twice. +The provs framework uses quasi-idempotence where "real" idempotence is not possible or does not make sense. + +In the following document we describe how we implement idempotence: + +https://gitlab.com/domaindrivenarchitecture/overview/-/blob/master/adr-provs/quasi-idempotence.md ## Architecture -Multiple layers provide different levels of functionality: +Multiple architectural layers provide different levels of functionality: ![provs layers](resources/provs-architecture-7.png "Provs architecture") ## Module structure -![resources/provs-module-structure-4.png](resources/provs-module-structure-4.png) +For the modules we use domain-drive design according to: -Explanation: -* **Convention**: contains at least one function that provides the main functionality of this module. -* **Base**: contains functions that provide more low-level functionalities of this module. - -About the dependencies have a look at the explanations in the chapter below. +https://gitlab.com/domaindrivenarchitecture/overview/-/blob/master/adr-provs/ddd-structure.md ## Module dependencies @@ -79,22 +51,22 @@ __Explanation__: Modules: