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

[skip ci] update README.md

Browse source
This commit is contained in:
ansgarz 2022-02-25 14:35:39 +01:00
parent 614e23b1c0
commit 800c974668
3 changed files with 31 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

69
README.md
View file

@ -24,55 +24,48 @@ Additionally, it is possible to define a custom processor if needed.
### Prerequisites ### Prerequisites
* A **Java Virtual machine** (JVM) is required. * A **Java Virtual machine** (JVM) is required.
* Download the latest `provs.jar` from: https://gitlab.com/domaindrivenarchitecture/provs/-/releases * Install `jarwrapper` (e.g. `sudo apt install jarwrapper`)
* For server functionality (such as install k3s) download the latest `provs-server.jar` from: https://gitlab.com/domaindrivenarchitecture/provs/-/releases * 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
### Usage format
`provs-desktop.jar <type> <target> [<options>]`
**type** can be:
* basic - install some basic packages)
* office - install office software (LibreOffice), E-Mail (Thunderbird), etc
* ide - same as office with additionally ide-software (VSCode, IntelliJ, etc)
**target** can be:
* `local`
* `user123:mypassword@myhost.com` - general format is: <user[:password]@host> -
* if password is omitted, then ssh-keys will be used for authentication
* if password is omitted but option `-p` is provided the password will be prompted interactively
**options**
* `-p` for interactive password question
### Show usage options #### Show usage options
`provs-desktop.jar -h`
`java -jar provs.jar -h` ### Examples
### Provision a desktop workplace locally #### Provision a basic desktop workplace locally
Ensure a config file is in place (default config file name is "WorkplaceConfig.yaml") with at least the workplace type specified, e.g. `provs-desktop.jar basic local`
```type: MINIMAL```
Possible types are currently: MINIMAL, OFFICE or IDE. #### Provision an office desktop workplace remotely
Run: `provs-desktop.jar office myuser@myhost.com -p`
`java -jar provs.jar -l` You'll be prompted for the password of the remote user due to option `-p`.
### Provision a desktop workplace remotely
`java -jar provs.jar -i -r <ip> -u <remote_username>`
You'll be prompted for the password of the remote user.
### Provision k3s ### Provision k3s
```bash ```bash
java -jar provs-server.jar -i -r <ip or hostname> -u <remote_username> provs-server.jar k3s myuser@myhost.com
# Example:
java -jar provs-server.jar -i -r 192.168.56.141 -u testuser
``` ```
You'll be prompted for the password of the remote user.
## For developers
### Build the jar-file yourself
* Clone this repo
* Build the fatjar file by `./gradlew fatJarLatest`
* In folder build/libs you'll find the file `provs.jar`
The fatjar is a Java jar-file incl. all required dependencies.
### Sequence diagram
Find below an example of a sequence diagram when provisioning a workplace:
![img.png](doc/resources/provision-workplace-sequence.diagram.png)

3
src/test/resources/TestWorkplaceConfig.yaml
View file

@ -1,6 +1,3 @@
# type is required
type: OFFICE # IDE, OFFICE or MINIMAL
# fields below are optional, either remove them or update them with your data # fields below are optional, either remove them or update them with your data
ssh: ssh:
sourceType: FILE # FILE or GOPASS sourceType: FILE # FILE or GOPASS

1
src/test/resources/WorkplaceConfigExample.json
View file

@ -1,5 +1,4 @@
{ {
"type": "MINIMAL",
"ssh": null, "ssh": null,
"gpg": null, "gpg": null,
"gitUserName": "mygitusername", "gitUserName": "mygitusername",