diff --git a/doc/ForDevelopers.md b/doc/ForDevelopers.md index 6085ce8..3b179e0 100644 --- a/doc/ForDevelopers.md +++ b/doc/ForDevelopers.md @@ -11,7 +11,7 @@ This uberjar is a Java jar-file including all required dependencies. ## Task ```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 ... diff --git a/doc/ProvSequence.puml b/doc/ProvSequence.puml deleted file mode 100644 index ec3e82d..0000000 --- a/doc/ProvSequence.puml +++ /dev/null @@ -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 \ No newline at end of file diff --git a/doc/ProvTaskExecSequence.md b/doc/ProvTaskExecSequence.md new file mode 100644 index 0000000..b0535d4 --- /dev/null +++ b/doc/ProvTaskExecSequence.md @@ -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 +``` \ No newline at end of file diff --git a/doc/ProvisionDesktopSequence.md b/doc/ProvisionDesktopSequence.md index e70f203..84311ab 100644 --- a/doc/ProvisionDesktopSequence.md +++ b/doc/ProvisionDesktopSequence.md @@ -13,6 +13,7 @@ box "application" #LightBlue participant Application participant CliArgumentsParser participant DesktopCliCommand +participant ProvWithSudo end box box #White @@ -21,8 +22,7 @@ participant "Prov (local or remote...)" as ProvInstance end box box "domain" #LightGreen -participant "DesktopService\n.provisionDesktopCommand" as DesktopService1 -participant "DesktopService\n.provisionDesktop" as DesktopService2 +participant "DesktopService" end box box "infrastructure" #CornSilk @@ -36,14 +36,18 @@ Application -> CliArgumentsParser : parseCommand Application -> DesktopCliCommand : isValid ? Application -> CliUtils : createProvInstance ProvInstance <- CliUtils : create -Application -> DesktopService1 : provisionDesktopCommand ( provInstance, desktopCliCommand ) -DesktopService1 -> ConfigRepository : getConfig -DesktopService1 -> DesktopService2 : provisionDesktop( config ) - -DesktopService2 -> Infrastructure_functions: Various calls like: -DesktopService2 -> Infrastructure_functions: install ssh, gpg, git ... -DesktopService2 -> Infrastructure_functions: installVirtualBoxGuestAdditions -DesktopService2 -> Infrastructure_functions: configureNoSwappiness, ... + +Application -> ProvWithSudo : ensureSudoWithoutPassword +Application -> DesktopService : provisionDesktopCommand ( provInstance, desktopCliCommand ) + +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 ``` \ No newline at end of file