architecture-as-code icon indicating copy to clipboard operation
architecture-as-code copied to clipboard

Update core calm concepts docs

Open Budlee opened this issue 11 months ago • 2 comments

Feature Request

Description of Problem:

The Core calm concepts docs are out of date. Since spending more time on the more recent CALM specs there are new fields that I have no clue what they mean or their intention.

A few lines should be added to any missing concepts and their meaning.

Budlee avatar Jan 29 '25 14:01 Budlee

@jpgough-ms and @rocketstack-matt, I have pushed a PR to update the Calm docs defining CALM. I mentioned to @jpgough-ms I have no idea what the instance value is: https://github.com/finos/architecture-as-code/blob/0.5.0/calm/draft/2025-01/meta/core.json#L65

It's completely unused and undocumented. I'd suggest gets removed from the Spec

Budlee avatar Feb 06 '25 19:02 Budlee

Reviewing https://github.com/Budlee/architecture-as-code/commit/b1899ce884ae1f5ceeb6d5a3124373d926e72870 can you confirm expectation on when the same connection requirement might be applied to multiple relationships. I suspect the requirement definition remains the same, what about the configuration? Do they contain the same control Id?

To give another control example.

Let's say I have a general incident response requirement

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://calm.finos.org/traderx/control/incident-response-requirement",
  "title": "Incident Response Requirement",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://calm.finos.org/draft/2024-12/meta/control-requirement.json"
    }
  ],
  "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"]
}

And for argument sake this is defined for every system node in my architecture (and let's assume I have more that two systems), when I generate configuration implementations for both systems, it is still not clear based on examples whether they would have the same control id or not.

LeighFinegold avatar Mar 09 '25 22:03 LeighFinegold