How to build reusable patterns and compose them?

[raphael-beck]

Hello,
I rather recently discovered CALM and I find it is a beautiful and promising project.
I've been hacking around last two weeks with the repository and I'm stuck with some questions.
Full disclosure: I plan to implement it as a standard for teams in my company.

First issue: Reuse patterns for the same target architecture

I want to define patterns, implement them for portion of architectures and reuse it multiple times in a global architecture. With a microservice pattern, I expect to have it multiple times in my target architecture.

For example: 2 microservices each talking to their own database and the two services linked (the first one calls the second one)

I've defined a pattern for Java microservices microservice-java-calm.pattern.json which is composed of
Nodes:

• a Java micro service with

"$ref": "https://calm.finos.org/release/1.0/meta/core.json#/defs/node",
          "type": "object",
          "properties": {
            "unique-id": {
              "const": "java-microservice"
            },

• a postgresql database with

"$ref": "https://calm.finos.org/release/1.0/meta/core.json#/defs/node",
          "type": "object",
          "properties": {
            "unique-id": {
              "const": "postgresql-database"
            },

• a kubernetes cluster
  Relationships
  Java micro service => postgresql database with

"relationship-type": {
              "const": {
                "connects": {
                  "source": {
                    "node": "java-microservice"
                  },
                  "destination": {
                    "node": "postgresql-database",
                    "interfaces": [
                      "postgresql-port"
                    ]
                  }
                }
              }
            }

kubernetes cluster which contains [Java micro service, postgresql database]

So far so good.
Now I generate a first architecture file with the calm-cli
calm generate -p patterns/microservice-java.pattern.json -s calm/schemas/ -o ems.arch.json
and a second
calm generate -p patterns/microservice-java.pattern.json -s calm/schemas/ -o sme.arch.json

From there I'm lost. I cannot merge the two files to create a single architecture as ids are uniques (unique-id). I cannot change unique-id as it will not validate.

I'm pretty sure I'm missing something on how to use patterns.

Second issue: How to reference a custom JSON schema?

I liked port-interface and container-image-interface from the first versions of calm schemas. In RC1 they have been removed and it's ok but I'd like to extend with my own schemas and from there I'm lost again.

I've created interface_mycompany.json schema

{
  "$schema": "https://calm.finos.org/release/1.0/meta/interface.json",
  "$id": "https://mycompany.com/release/0.1/meta/interface_mycompany.json",
  "title": "mycompany common Architecture Language Model Interfaces",
  "defs": {
    "port-interface": {
      "$ref": "https://calm.finos.org/release/1.0/meta/interface.json#/defs/interface-type",
      "type": "object",
      "properties": {
        "port": {
          "type": "integer"
        }
      },
      "required": [
        "port"
      ]
    },
    "container-image-interface": {
      "$ref": "https://calm.finos.org/release/1.0/meta/interface.json#/defs/interface-type",
      "type": "object",
      "properties": {
        "image": {
          "type": "string"
        }
      },
      "required": [
        "image"
      ]
    }
  }
}

and tried to use it in a pattern

{
          "$ref": "https://calm.finos.org/release/1.0/meta/core.json#/defs/node",
          "type": "object",
          "properties": {
            "unique-id": {
              "const": "java-microservice",
              "type": "string"
            },
            "name": {
              "const": "Java Microservice"
            },
            "description": {
              "const": "Java microservice exposing a REST API on port 8080"
            },
            "node-type": {
              "const": "service"
            },
            "interfaces": {
              "type": "array",
              "minItems": 2,
              "maxItems": 2,
              "prefixItems": [
                {
                  "$ref": "https://mycompany.com/release/0.1/meta/interface_mycompany.json#/defs/port-interface",
                  "properties": {
                    "unique-id": {
                      "const": "rest-api-port"
                    },
                    "port": {
                      "const": 8080
                    }
                  }
                },
                {
                  "$ref": "https://mycompany.com/release/0.1/meta/interface_mycompany.json#/defs/container-image-interface",
                  "properties": {
                    "unique-id": {
                      "const": "java-service-image"
                    }
                  }
                }
              ]
            }
          }
        }

I can generate the architecture
calm generate -p patterns/microservice-java.pattern.json -s calm/schemas/ -o ems-api-mycompany2.arch.json
calm/schemas/ contains interface_mycompany.json

Then I try to validate and it doesn't work
calm validate -p patterns/microservice-java-mycompany.pattern.json -s calm/schemas/ -a ems-api-mycompany2.arch.json

info [file-system-document-loader]:     Document ID https://mycompany.com/release/0.1/meta/interface_mycompany.json does not exist in file system, cannot load.
error [file-system-document-loader]:    Document with id [https://mycompany.com/release/0.1/meta/interface_mycompany.json] and type [schema] was requested but not loaded at initialisation. 
            File system document loader can only load at startup. Please ensure the schemas are present on your directory path or use CALMHub.
error [calm-validate]:    An error occured:Error: schema must be object or boolean
error [calm-validate]:    An error occurred while validating: schema must be object or boolean

There is the suggestion to use the CALM Hub. I've loaded the schema in a local CALM Hub instance but I don't know how to reference the schema from the Hub when validating. By the way I can't load two schema files with the same name

Sorry for the long message but I'm really interested to use CALM!

Thank you for your help