generated from finos-labs/project-blueprint
-
Notifications
You must be signed in to change notification settings - Fork 38
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
Add ecosystem to node spec and tie flows into core.json #660
Merged
+1,168
−37
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| ### TraderX Example | ||
|
|
||
| [TraderX](https://github.com/finos/traderX) is a Sample Trading Application, designed to be a distributed reference application in the financial services domain. | ||
|
|
||
| This sample uses the [C4 model](https://github.com/finos/traderX/blob/main/docs/c4/c4-diagram.png) of the TraderX application and shows how to model it using CALM. | ||
|
|
||
| You can see in thus sample how you can use the base CALM vocab is both JSON and YAML documents. |
182 changes: 182 additions & 0 deletions
182
calm/samples/2024-12/traderx/controls/flow-sla-control-requirement.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,182 @@ | ||
| { | ||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||
| "$id": "https://calm.finos.org/traderx/control/flow-sla-control-requirement", | ||
| "title": "Flow SLA Control", | ||
| "type": "object", | ||
| "allOf": [ | ||
| { | ||
| "$ref": "https://calm.finos.org/draft/2024-12/meta/control-requirement.json" | ||
| } | ||
| ], | ||
| "properties": { | ||
| "control-id": { | ||
| "const": "flow-sla-001" | ||
| }, | ||
| "name": { | ||
| "const": "Flow SLA Control" | ||
| }, | ||
| "description": { | ||
| "const": "Ensure that each flow meets the defined Service Level Agreement (SLA)" | ||
| }, | ||
| "latency": { | ||
| "type": "object", | ||
| "properties": { | ||
| "expected-latency": { | ||
| "$ref": "https://calm.finos.org/draft/2024-12/meta/units.json#/defs/time-unit", | ||
| "description": "The expected latency for completion of flow" | ||
| }, | ||
| "alert-threshold": { | ||
| "$ref": "https://calm.finos.org/draft/2024-12/meta/units.json#/defs/time-unit", | ||
| "description": "If latency exceeds this threshold, an alert will be triggered." | ||
| } | ||
| }, | ||
| "required": [ | ||
| "expected-latency", | ||
| "alert-threshold" | ||
| ] | ||
| }, | ||
| "throughput": { | ||
| "type": "object", | ||
| "properties": { | ||
| "expected-message-rate": { | ||
| "$ref": "https://calm.finos.org/draft/2024-12/meta/units.json#/defs/time-unit", | ||
| "description": "Define the expected message rate that the flow should handle e.g. 1000 per second" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "expected-message-rate" | ||
| ] | ||
| }, | ||
| "availability": { | ||
| "type": "object", | ||
| "properties": { | ||
| "uptime-guarantee": { | ||
| "type": "number", | ||
| "description": "Percentage of availability required (e.g., 99.9%).", | ||
| "minimum": 0, | ||
| "maximum": 100 | ||
| } | ||
| }, | ||
| "required": [ | ||
| "uptime-guarantee" | ||
| ] | ||
| }, | ||
| "data-integrity": { | ||
| "type": "object", | ||
| "properties": { | ||
| "message-reliability": { | ||
| "enum": [ | ||
| "atLeastOnce", | ||
| "atMostOnce", | ||
| "exactlyOnce" | ||
| ], | ||
| "description": "Guarantee that messages are delivered in the correct order and without duplication." | ||
| }, | ||
| "loss-tolerance": { | ||
| "type": "number", | ||
| "description": "Specify acceptable levels of message loss as a percentage (e.g., 0 to 100).", | ||
| "minimum": 0, | ||
| "maximum": 100 | ||
| } | ||
| }, | ||
| "required": [ | ||
| "message-reliability", | ||
| "loss-tolerance" | ||
| ] | ||
| }, | ||
| "error-handling": { | ||
| "type": "object", | ||
| "properties": { | ||
| "retry-logic": { | ||
| "type": "object", | ||
| "properties": { | ||
| "max-retries": { | ||
| "type": "integer", | ||
| "description": "Specify the maximum number of retries in case of failures." | ||
| }, | ||
| "retry-interval": { | ||
| "$ref": "https://calm.finos.org/draft/2024-12/meta/units.json#/defs/time-unit", | ||
| "description": "Define the interval between retries." | ||
| } | ||
| }, | ||
| "required": ["max-retries", "retry-interval"] | ||
| } | ||
| }, | ||
| "required": [ | ||
| "retry-logic" | ||
| ] | ||
| }, | ||
| "monitoring": { | ||
| "type": "object", | ||
| "properties": { | ||
| "real-time-monitoring": { | ||
| "type": "string", | ||
| "description": "Define the monitoring systems for tracking performance against the SLA." | ||
| }, | ||
| "consumer-reporting": { | ||
| "$ref": "https://calm.finos.org/draft/2024-12/meta/units.json#/defs/time-unit", | ||
| "description": "Specify the reporting frequency for the consumer, e.g., daily, weekly, or monthly." | ||
| } | ||
| }, | ||
| "required": [ | ||
| "real-time-monitoring", | ||
| "consumer-reporting" | ||
| ] | ||
| }, | ||
| "incident-response": { | ||
| "type": "object", | ||
| "properties": { | ||
| "incident-resolution-time": { | ||
| "$ref": "https://calm.finos.org/draft/2024-12/meta/units.json#/defs/time-unit", | ||
| "description": "Define timeframes for responding to SLA-impacting issues." | ||
| }, | ||
| "escalation-protocols": { | ||
| "type": "object", | ||
| "properties": { | ||
| "incident-start-time-post-alert": { | ||
| "$ref": "https://calm.finos.org/draft/2024-12/meta/units.json#/defs/time-unit", | ||
| "description": "Timeframe for initiating incident response after an alert." | ||
| }, | ||
| "escalation-path": { | ||
| "type": "string", | ||
| "description": "Specify the escalation path for SLA violations." | ||
| } | ||
| }, | ||
| "required": [ | ||
| "incident-start-time-post-alert", | ||
| "escalation-path" | ||
| ] | ||
| } | ||
| }, | ||
| "required": [ | ||
| "incident-resolution-time", | ||
| "escalation-protocols" | ||
| ] | ||
| }, | ||
| "review-adjustments": { | ||
| "type": "object", | ||
| "properties": { | ||
| "sla-review": { | ||
| "$ref": "https://calm.finos.org/draft/2024-12/meta/units.json#/defs/time-unit", | ||
| "description": "Outline a schedule for regularly reviewing the SLA." | ||
| } | ||
| }, | ||
| "required": [ | ||
| "sla-review" | ||
| ] | ||
| } | ||
| }, | ||
| "required": [ | ||
| "control-id", | ||
| "name", | ||
| "description", | ||
| "latency", | ||
| "throughput", | ||
| "availability", | ||
| "data-integrity", | ||
| "error-handling", | ||
| "monitoring", | ||
| "incident-response", | ||
| "review-adjustments" | ||
| ] | ||
| } |
65 changes: 65 additions & 0 deletions
65
...es/2024-12/traderx/flows/add-update-account/add-update-account-control-configuration.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| { | ||
| "$schema": "https://calm.finos.org/traderx/control/flow-sla-control-requirement", | ||
| "$id": "https://calm.finos.org/traderx/control/add-update-account-control-configuration", | ||
| "control-id": "add-update-account-control-configuration", | ||
| "name": "Flow SLA Control for Add or Update Account", | ||
| "description": "Ensure that the Add or Update Account flow meets the defined Service Level Agreement (SLA).", | ||
| "latency": { | ||
| "expected-latency": { | ||
| "value": 100, | ||
| "unit": "milliseconds" | ||
| }, | ||
| "alert-threshold": { | ||
| "value": 150, | ||
| "unit": "milliseconds" | ||
| } | ||
| }, | ||
| "throughput": { | ||
| "expected-message-rate": { | ||
| "value": 500, | ||
| "unit": "seconds" | ||
| } | ||
| }, | ||
| "availability": { | ||
| "uptime-guarantee": 99.9 | ||
| }, | ||
| "data-integrity": { | ||
| "message-reliability": "atLeastOnce", | ||
| "loss-tolerance": 0 | ||
| }, | ||
| "error-handling": { | ||
| "retry-logic": { | ||
| "max-retries": 3, | ||
| "retry-interval": { | ||
| "value": 10, | ||
| "unit": "seconds" | ||
| } | ||
| } | ||
| }, | ||
| "monitoring": { | ||
| "real-time-monitoring": "Use of monitoring tools like Prometheus or Grafana for SLA tracking.", | ||
| "consumer-reporting": { | ||
| "value": 1, | ||
| "unit": "days" | ||
| } | ||
| }, | ||
| "incident-response": { | ||
| "incident-resolution-time": { | ||
| "value": 30, | ||
| "unit": "minutes" | ||
| }, | ||
| "escalation-protocols": { | ||
| "incident-start-time-post-alert": { | ||
| "value": 5, | ||
| "unit": "minutes" | ||
| }, | ||
| "escalation-path": "Notify the incident response team via the dedicated Slack channel." | ||
| } | ||
| }, | ||
| "review-adjustments": { | ||
| "sla-review": { | ||
| "value": 1, | ||
| "unit": "months" | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure what this is for? Will continue looking through the review.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Explained on linked issue. If we don't want to pull over that terminology, happy to go with something else