[skip ci] update README.md
This commit is contained in:
parent
2525e0f2bb
commit
411003f04a
1 changed files with 28 additions and 20 deletions
48
README.md
48
README.md
|
@ -5,17 +5,12 @@
|
|||
|
||||
## Purpose
|
||||
|
||||
provs provides cli-based tooling for provisioning desktop or server resp. perform system checks.
|
||||
* provs-desktop minimal - provides a minimal setup (e.g. swappiness / randomutils) e.g. for setup on a VirtualBox
|
||||
* provs-desktop office - 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 & k3s setup with dualstack option
|
||||
* provs-syspec - verifies a system according to the provided system spec config file
|
||||
provs provides cli-based tools for
|
||||
* provisioning a desktop (various kinds)
|
||||
* provisioning a k3s server
|
||||
* performing system checks
|
||||
|
||||
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
|
||||
Tasks can be run locally or remotely.
|
||||
|
||||
## Status
|
||||
|
||||
|
@ -26,11 +21,24 @@ under development - we are working hard on setting up our environments using pro
|
|||
|
||||
* A **Java Virtual machine** (JVM) is required.
|
||||
* Install `jarwrapper` (e.g. `sudo apt install jarwrapper`)
|
||||
* Download the latest `provs-desktop.jar` from: https://gitlab.com/domaindrivenarchitecture/provs/-/releases
|
||||
* 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
|
||||
* Then either download the binaries or build them yourself
|
||||
|
||||
### provs-desktop
|
||||
#### Download the binaries
|
||||
|
||||
* Download the latest `provs-desktop.jar`,`provs-server.jar` and/or `provs-syspec.jar` from: https://gitlab.com/domaindrivenarchitecture/provs/-/releases
|
||||
* Preferably into `/usr/local/bin` or any other folder where executables can be found by the system
|
||||
* Make the jar-file executable e.g. by `chmod +x provs-desktop.jar`
|
||||
|
||||
#### Build the binaries
|
||||
|
||||
Instead of downloading the binaries you can build them yourself
|
||||
|
||||
* Clone this repository
|
||||
* In the repository's root folder execute: `./gradlew install`. This will install the binaries in `/usr/local/bin`
|
||||
|
||||
### Provision a desktop
|
||||
|
||||
After having installed `provs-desktop.jar` (see prerequisites) execute:
|
||||
|
||||
`provs-desktop.jar <type> <target> [<options>]`
|
||||
|
||||
|
@ -49,7 +57,7 @@ under development - we are working hard on setting up our environments using pro
|
|||
* `-p` for interactive password question
|
||||
|
||||
|
||||
#### Provision a desktop
|
||||
#### Example
|
||||
|
||||
```bash
|
||||
provs-desktop.jar basic local
|
||||
|
@ -57,9 +65,9 @@ provs-desktop.jar basic local
|
|||
provs-desktop.jar office myuser@myhost.com -p
|
||||
```
|
||||
|
||||
In the last case you'll be prompted for the password of the remote user due to option `-p`.
|
||||
In the second case you'll be prompted for the password of the remote user due to option `-p`.
|
||||
|
||||
### Provision k3s
|
||||
### Provision a k3s Server
|
||||
|
||||
```bash
|
||||
provs-server.jar k3s local
|
||||
|
@ -94,14 +102,14 @@ provs-server.jar k3s myuser@myhost.com -o grafana
|
|||
|
||||
|
||||
|
||||
### Performing a system check
|
||||
### Perform a system check
|
||||
|
||||
The default config-file for the system check is `syspec-config.yaml`, you can specify a different file with option `-c <config-file>`.
|
||||
|
||||
```bash
|
||||
provs-syspec.jar local
|
||||
# or remote:
|
||||
provs-syspec.jar myuser@myhost.com
|
||||
# or remote with a custom config filename
|
||||
provs-syspec.jar myuser@myhost.com -c my-syspec-config.yaml
|
||||
```
|
||||
|
||||
## Get help
|
||||
|
|
Loading…
Reference in a new issue