martinweiler commented on code in PR #2001: URL: https://github.com/apache/incubator-kie-kogito-apps/pull/2001#discussion_r1503119885
########## jobs-service/README.md: ########## @@ -0,0 +1,96 @@ + +# Jobs + +job service constitutes a subsystem within kogito workflow domain. This component is responsible for scheduling jobs. In the case of workflow this module takes care of timers such from boundary events, SLA, throw events relevant to timers. Also is used for things like human tasks notifications. + +The system supports two different types of deployment: + +* Compact Architecture: as a component deployed within the application. +* Distributed architecture: as a microservice deployed independently + +The current support storage is + +* postgresql +* infinspan +* mongodb +* in memmory + +At present jobs only supports quarkus runtimes in compact architecture. + +## How jobs work + + + +The concepts to understand the above picture are: +* transport: the medium used to transfer a message between client component and job service. The transport could be http, kafka or in-vm at the moment. +* sink: is the client endpoint callback. +* storage: is the persistence tier of the jobs being current scheduled. +* job service: it the main component containing the logic of scheduling a job and storing data. + +When a client invokes the job service the client component send a message through the transport tier containing the information required in order to call back the sink once the job times out. +Once the request reaches the job service it creates internally the job and stores the data about the job status in the storage. +After the job times out, the component calls the sink signaling the client using either in-vm or http request. + +## Using job service as Compact architecture + +For using in your project this you need first to include the dependency related to the transport tier. in our case for in-vm we use + + + <dependency> + <groupId>org.kie.kogito</groupId> + <artifactId>kogito-addons-quarkus-jobs-management</artifactId> Review Comment: Will be renamed to `org.kie:kogito-addons-quarkus-jobs-management` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
