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

Constraining Detailed Architecture Usage in Patterns #817

Open
jpgough-ms opened this issue Jan 23, 2025 · 5 comments
Open

Constraining Detailed Architecture Usage in Patterns #817

jpgough-ms opened this issue Jan 23, 2025 · 5 comments
Labels

Comments

@jpgough-ms
Copy link
Member

Feature Request

Description of Problem:

detailed-architecture provides a "drill down" feature in CALM. A node can provide a detailed architecture link, which corresponds to another CALM architecture with more details of a node.

When using the detailed-architecture feature in patterns, it would be helpful to constrain the detailed-architecture to a specific pattern.

Potential Solutions:

One solution is to provide an optional detailed-pattern or detailed-architecture-pattern, this would constrain the downstream architecture and enable the architect to define any input and output nodes or relationships relevant to the pattern.

It would also enable the downstream pattern to constrain the downstream architecture where necessary and have that also conform to a pattern.

@jpgough-ms
Copy link
Member Author

Changing node to have something like

"details": {
          "type": "object",
            "properties": {
                "detailed-architecture": {
                  "type": "string"
                },
                "detailed-pattern": {
                  "type": "string"
                }
            }
        }

Could work really well with patterns.

  • It enables a pattern author to say you must provide a detailed-architecture where on is needed.
  • It can be constrained to point at a specific detailed architecture (for known systems that have a well established set of components and controls)
  • It can be used to say you must provide a detailed architecture and it is constrained by this pattern

cc/ @Budlee @rocketstack-matt

@rocketstack-matt
Copy link
Member

Would the name reference-pattern or required-pattern be more appropriate in terms of intent?

@jpgough-ms
Copy link
Member Author

@rocketstack-matt that is definitely better.

jpgough-ms added a commit to jpgough-ms/architecture-as-code that referenced this issue Jan 23, 2025
@jpgough-ms jpgough-ms mentioned this issue Jan 24, 2025
2 tasks
rocketstack-matt pushed a commit that referenced this issue Jan 27, 2025
@Budlee
Copy link
Member

Budlee commented Jan 28, 2025

The required-pattern is a nice add here and I believe should resolve what we require

@Budlee
Copy link
Member

Budlee commented Feb 6, 2025

@rocketstack-matt is this going to be in the new draft?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants