Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore-xxx: added scheduler documentation #1103

Merged
merged 2 commits into from
Mar 22, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ _**For better traceability add the corresponding GitHub issue number in each cha
- #695 OAuth2.0 Client scope configuration
- #606 Added error message into notifications on failure
- #596 Added Policy management documentation
- Added overview of the scheduled tasks in documentation

### Changed
- #709 Bumped spring-core from 6.0.17 to 6.1.5
Expand Down
1 change: 1 addition & 0 deletions docs/src/docs/arc42/runtime-view/full.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ include::data-consumption.adoc[leveloffset=+1]
include::data-provisioning.adoc[leveloffset=+1]
include::data-sovereignty.adoc[leveloffset=+1]
include::policies.adoc[leveloffset=+1]
include::scheduled.adoc[leveloffset=+1]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
include::scheduled.adoc[leveloffset=+1]
include::scheduler.adoc[leveloffset=+1]

4 changes: 4 additions & 0 deletions docs/src/docs/arc42/runtime-view/scheduled.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
= Scheduler

include::scheduled/scheduled.adoc[leveloffset=+1]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
include::scheduled/scheduled.adoc[leveloffset=+1]
include::scheduler/scheduler.adoc[leveloffset=+1]


8 changes: 8 additions & 0 deletions docs/src/docs/arc42/runtime-view/scheduled/scheduled.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
An overview of the scheduled tasks configured in the system.

[options="header"]
|===
|Scheduler Name | Execution Interval | Description
|PublishAssetsJob | Every hour at 30min | Publishes assets in IN_SYNCHRONIZATION state to core services. The process combines 'as-built' and 'as-planned' assets and initiates their publication for synchronization in the traceability system.
|AssetsRefreshJob | Every 2 hours | Invokes the synchronization of asset shell descriptors with the decentralized registry. It ensures the latest asset information is fetched and updated in the system from external sources.
|===