[skip ci] chg docs
This commit is contained in:
parent
a457c1d05e
commit
5572aa87ba
4 changed files with 59 additions and 45 deletions
|
@ -11,7 +11,7 @@ This uberjar is a Java jar-file including all required dependencies.
|
||||||
## Task
|
## Task
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
fun Prov.provisionK8s() = task { /* ... code and subtasks come here ... */ }
|
fun Prov.provisionK3s() = task { /* ... code and subtasks come here ... */ }
|
||||||
```
|
```
|
||||||
|
|
||||||
If you're having a deeper look into the provs code, you'll see regularly a task definition like this and might wonder ...
|
If you're having a deeper look into the provs code, you'll see regularly a task definition like this and might wonder ...
|
||||||
|
|
|
@ -1,35 +0,0 @@
|
||||||
@startuml
|
|
||||||
autonumber
|
|
||||||
|
|
||||||
Application -> Prov: create
|
|
||||||
|
|
||||||
activate Prov
|
|
||||||
Application -> DesktopService.kt: provisionDesktop(prov, ...)
|
|
||||||
DesktopService.kt -> Install.kt: aptInstall(prov, lambda=cmd "apt install", ..)
|
|
||||||
Install.kt -> Prov: taskWithResult
|
|
||||||
|
|
||||||
activate Prov
|
|
||||||
Prov -> Prov: evaluate
|
|
||||||
|
|
||||||
activate Prov
|
|
||||||
Prov -> Prov: initProgress (bei level 0)
|
|
||||||
Prov -> Prov: progress
|
|
||||||
|
|
||||||
activate Prov
|
|
||||||
Prov -> Prov: lambda
|
|
||||||
|
|
||||||
activate Prov
|
|
||||||
Prov -> Processor: exec
|
|
||||||
deactivate Prov
|
|
||||||
|
|
||||||
Prov <-- Prov: ProvResult
|
|
||||||
deactivate Prov
|
|
||||||
|
|
||||||
Prov -> Prov: endProgress (bei level 0)
|
|
||||||
Prov -> Prov: printResults (bei level 0)
|
|
||||||
|
|
||||||
deactivate Prov
|
|
||||||
deactivate Prov
|
|
||||||
Install.kt <-- Prov: ProvResult
|
|
||||||
|
|
||||||
@enduml
|
|
45
doc/ProvTaskExecSequence.md
Normal file
45
doc/ProvTaskExecSequence.md
Normal file
|
@ -0,0 +1,45 @@
|
||||||
|
```plantuml
|
||||||
|
@startuml
|
||||||
|
autonumber
|
||||||
|
|
||||||
|
participant Application
|
||||||
|
participant DesktopService
|
||||||
|
participant Install
|
||||||
|
participant Prov
|
||||||
|
participant Processor
|
||||||
|
|
||||||
|
Application -> Prov: create
|
||||||
|
|
||||||
|
activate Prov
|
||||||
|
Application -> DesktopService: provisionDesktop(prov, ...)
|
||||||
|
DesktopService -> Install: aptInstall(prov, lambda=cmd "apt install", ..)
|
||||||
|
Install -> Prov: taskWithResult
|
||||||
|
|
||||||
|
activate Prov
|
||||||
|
Prov -> Prov: evaluate
|
||||||
|
|
||||||
|
activate Prov
|
||||||
|
Prov -> Prov: initProgress (bei level 0)
|
||||||
|
Prov -> Prov: progress
|
||||||
|
|
||||||
|
activate Prov
|
||||||
|
Prov -> Prov: lambda
|
||||||
|
|
||||||
|
activate Prov
|
||||||
|
Prov -> Processor: exec
|
||||||
|
Prov <-- Processor: exec
|
||||||
|
deactivate Prov
|
||||||
|
|
||||||
|
deactivate Prov
|
||||||
|
|
||||||
|
Prov -> Prov: endProgress (if level 0)
|
||||||
|
Prov -> Prov: printResults (if level 0)
|
||||||
|
|
||||||
|
deactivate Prov
|
||||||
|
deactivate Prov
|
||||||
|
Install <-- Prov: ProvResult
|
||||||
|
DesktopService <-- Install
|
||||||
|
Application <-- DesktopService
|
||||||
|
|
||||||
|
@enduml
|
||||||
|
```
|
|
@ -13,6 +13,7 @@ box "application" #LightBlue
|
||||||
participant Application
|
participant Application
|
||||||
participant CliArgumentsParser
|
participant CliArgumentsParser
|
||||||
participant DesktopCliCommand
|
participant DesktopCliCommand
|
||||||
|
participant ProvWithSudo
|
||||||
end box
|
end box
|
||||||
|
|
||||||
box #White
|
box #White
|
||||||
|
@ -21,8 +22,7 @@ participant "Prov (local or remote...)" as ProvInstance
|
||||||
end box
|
end box
|
||||||
|
|
||||||
box "domain" #LightGreen
|
box "domain" #LightGreen
|
||||||
participant "DesktopService\n.provisionDesktopCommand" as DesktopService1
|
participant "DesktopService"
|
||||||
participant "DesktopService\n.provisionDesktop" as DesktopService2
|
|
||||||
end box
|
end box
|
||||||
|
|
||||||
box "infrastructure" #CornSilk
|
box "infrastructure" #CornSilk
|
||||||
|
@ -36,14 +36,18 @@ Application -> CliArgumentsParser : parseCommand
|
||||||
Application -> DesktopCliCommand : isValid ?
|
Application -> DesktopCliCommand : isValid ?
|
||||||
Application -> CliUtils : createProvInstance
|
Application -> CliUtils : createProvInstance
|
||||||
ProvInstance <- CliUtils : create
|
ProvInstance <- CliUtils : create
|
||||||
Application -> DesktopService1 : provisionDesktopCommand ( provInstance, desktopCliCommand )
|
|
||||||
DesktopService1 -> ConfigRepository : getConfig
|
|
||||||
DesktopService1 -> DesktopService2 : provisionDesktop( config )
|
|
||||||
|
|
||||||
DesktopService2 -> Infrastructure_functions: Various calls like:
|
Application -> ProvWithSudo : ensureSudoWithoutPassword
|
||||||
DesktopService2 -> Infrastructure_functions: install ssh, gpg, git ...
|
Application -> DesktopService : provisionDesktopCommand ( provInstance, desktopCliCommand )
|
||||||
DesktopService2 -> Infrastructure_functions: installVirtualBoxGuestAdditions
|
|
||||||
DesktopService2 -> Infrastructure_functions: configureNoSwappiness, ...
|
DesktopService -> ConfigRepository : getConfig
|
||||||
|
|
||||||
|
DesktopService -> DesktopService : provisionDesktop( config )
|
||||||
|
|
||||||
|
DesktopService -> Infrastructure_functions: Various calls like:
|
||||||
|
DesktopService -> Infrastructure_functions: install ssh, gpg, git ...
|
||||||
|
DesktopService -> Infrastructure_functions: installVirtualBoxGuestAdditions
|
||||||
|
DesktopService -> Infrastructure_functions: configureNoSwappiness, ...
|
||||||
|
|
||||||
@enduml
|
@enduml
|
||||||
```
|
```
|
Loading…
Reference in a new issue