meissa/provs
7
1
Fork 0
Code Issues Pull requests Projects Releases 12 Packages Wiki Activity

adjust readme

Browse source
This commit is contained in:
jerger 2022-02-25 17:03:55 +01:00
parent 6be97d82de
commit a20d3ff9e5
1 changed files with 17 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -1,26 +1,26 @@
# Provs framework
Provs is a framework for automating tasks for provisioning reasons and other purposes.
# provs
[![pipeline status](https://gitlab.com/domaindrivenarchitecture/provs/badges/master/pipeline.svg)](https://gitlab.com/domaindrivenarchitecture/provs/-/commits/master)
It combines
[<img src="https://domaindrivenarchitecture.org/img/delta-chat.svg" width=20 alt="DeltaChat"> chat over e-mail](mailto:buero@meissa-gmbh.de?subject=community-chat) | [<img src="https://meissa-gmbh.de/img/community/Mastodon_Logotype.svg" width=20 alt="team@social.meissa-gmbh.de"> team@social.meissa-gmbh.de](https://social.meissa-gmbh.de/@team) | [Website & Blog](https://domaindrivenarchitecture.org)
## Purpose
provs provide cli-tools for provisioning desktop // server
* provs-desktop minimal - provides as minimal virtual-box able setup (e.g. swappiness / randomutils)
* provs-desktop offic - provides enhancements like zim / gopass / fakturama
* provs-desktop ide - provides development environments for java / kotlin / python / clojure / terraform
* provs-server k3s - provides a production ready & dualstack able k3s setup
In general provs combines
* being able to use the power of shell commands
* a clear and detailed result summary of the built-in execution handling (incl. failure handling and reporting)
* the convenience and robustness of a modern programming language
## Status
### Write once, run everywhere
Tasks can be run
* locally
* remotely
* in a local docker container
* in a remote container
Additionally, it is possible to define a custom processor if needed.
## Usage
under development - we are working hard on seting up our environments using provs.
## Try out
### Prerequisites
* A **Java Virtual machine** (JVM) is required.
@ -29,7 +29,7 @@ Additionally, it is possible to define a custom processor if needed.
* Make the jar-file executable by `chmod +x provs-desktop.jar`
* For server functionality (e.g. k3s) download the latest `provs-server.jar` from: https://gitlab.com/domaindrivenarchitecture/provs/-/releases
### Usage format
### provs-desktop
`provs-desktop.jar <type> <target> [<options>]`
@ -47,13 +47,7 @@ Additionally, it is possible to define a custom processor if needed.
**options**
* `-p` for interactive password question
#### Show usage options
`provs-desktop.jar -h`
### Examples
#### Provision a basic desktop workplace locally
`provs-desktop.jar basic local`