{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://catalog.lintel.tools/schemas/schemastore/azure-iot-edge-deployment/versions/1.1.json",
  "title": "JSON schema for Azure IoT Edge Deployment version 2.0",
  "x-lintel": {
    "source": "https://www.schemastore.org/azure-iot-edge-deployment-2.0.json",
    "sourceSha256": "2eb4e0299316e8b8b484459d23d153e0c03f05eaa7aea93a7cfbd0657f5c70b3"
  },
  "type": "object",
  "properties": {
    "modulesContent": {
      "type": "object",
      "title": "The configuration for all the modules.",
      "required": [
        "$edgeAgent",
        "$edgeHub"
      ],
      "properties": {
        "$edgeAgent": {
          "type": "object",
          "title": "Configuration for the edgeAgent module",
          "required": [
            "properties.desired"
          ],
          "properties": {
            "properties.desired": {
              "type": "object",
              "required": [
                "schemaVersion",
                "runtime",
                "systemModules",
                "modules"
              ],
              "properties": {
                "schemaVersion": {
                  "type": "string",
                  "examples": [
                    "1.0",
                    "1.1"
                  ]
                },
                "runtime": {
                  "type": "object",
                  "required": [
                    "type",
                    "settings"
                  ],
                  "properties": {
                    "type": {
                      "$ref": "#/$defs/moduleType"
                    },
                    "settings": {
                      "type": "object",
                      "properties": {
                        "minDockerVersion": {
                          "type": "string",
                          "examples": [
                            "v1.25"
                          ]
                        },
                        "loggingOptions": {
                          "type": "string"
                        },
                        "registryCredentials": {
                          "type": "object",
                          "additionalProperties": false,
                          "patternProperties": {
                            "^[^\\.\\$# ]+$": {
                              "type": "object",
                              "required": [
                                "username",
                                "password",
                                "address"
                              ],
                              "properties": {
                                "username": {
                                  "type": "string"
                                },
                                "password": {
                                  "type": "string"
                                },
                                "address": {
                                  "type": "string",
                                  "pattern": "^[^\\s]+$"
                                }
                              },
                              "additionalProperties": false
                            }
                          }
                        }
                      },
                      "additionalProperties": false
                    }
                  },
                  "additionalProperties": false
                },
                "systemModules": {
                  "type": "object",
                  "required": [
                    "edgeAgent",
                    "edgeHub"
                  ],
                  "properties": {
                    "edgeAgent": {
                      "type": "object",
                      "required": [
                        "type",
                        "settings"
                      ],
                      "properties": {
                        "type": {
                          "$ref": "#/$defs/moduleType"
                        },
                        "settings": {
                          "$ref": "#/$defs/moduleSettings"
                        },
                        "env": {
                          "$ref": "#/$defs/env"
                        },
                        "imagePullPolicy": {
                          "$ref": "#/$defs/imagePullPolicy"
                        }
                      },
                      "additionalProperties": false
                    },
                    "edgeHub": {
                      "type": "object",
                      "title": "The Edgehub Schema",
                      "required": [
                        "type",
                        "settings",
                        "status",
                        "restartPolicy"
                      ],
                      "properties": {
                        "type": {
                          "$ref": "#/$defs/moduleType"
                        },
                        "settings": {
                          "$ref": "#/$defs/moduleSettings"
                        },
                        "env": {
                          "$ref": "#/$defs/env"
                        },
                        "status": {
                          "$ref": "#/$defs/status"
                        },
                        "restartPolicy": {
                          "$ref": "#/$defs/restartPolicy"
                        },
                        "imagePullPolicy": {
                          "$ref": "#/$defs/imagePullPolicy"
                        },
                        "startupOrder": {
                          "$ref": "#/$defs/startupOrder"
                        }
                      },
                      "additionalProperties": false
                    }
                  },
                  "additionalProperties": false
                },
                "modules": {
                  "type": "object",
                  "additionalProperties": false,
                  "patternProperties": {
                    "^[a-zA-Z0-9_-]+$": {
                      "type": "object",
                      "required": [
                        "type",
                        "status",
                        "restartPolicy",
                        "settings"
                      ],
                      "properties": {
                        "version": {
                          "type": "string",
                          "examples": [
                            "1.0"
                          ]
                        },
                        "type": {
                          "$ref": "#/$defs/moduleType"
                        },
                        "status": {
                          "$ref": "#/$defs/status"
                        },
                        "restartPolicy": {
                          "$ref": "#/$defs/restartPolicy"
                        },
                        "env": {
                          "$ref": "#/$defs/env"
                        },
                        "settings": {
                          "$ref": "#/$defs/moduleSettings"
                        },
                        "imagePullPolicy": {
                          "$ref": "#/$defs/imagePullPolicy"
                        },
                        "startupOrder": {
                          "$ref": "#/$defs/startupOrder"
                        }
                      },
                      "additionalProperties": false
                    }
                  }
                }
              },
              "additionalProperties": false
            }
          },
          "additionalProperties": false
        },
        "$edgeHub": {
          "type": "object",
          "title": "Configuration for the edgeHub module",
          "required": [
            "properties.desired"
          ],
          "properties": {
            "properties.desired": {
              "type": "object",
              "required": [
                "schemaVersion",
                "routes"
              ],
              "properties": {
                "schemaVersion": {
                  "type": "string",
                  "examples": [
                    "1.0",
                    "1.1"
                  ]
                },
                "routes": {
                  "type": "object",
                  "additionalProperties": false,
                  "patternProperties": {
                    "^[^\\.\\$# ]+$": {
                      "anyOf": [
                        {
                          "type": "object",
                          "required": [
                            "route"
                          ],
                          "properties": {
                            "route": {
                              "type": "string",
                              "examples": [
                                "FROM /* INTO $upstream"
                              ],
                              "pattern": "^.+$"
                            },
                            "priority": {
                              "type": "integer",
                              "minimum": 0,
                              "maximum": 9
                            },
                            "timeToLiveSecs": {
                              "type": "integer",
                              "minimum": 0,
                              "maximum": 4294967295
                            }
                          },
                          "additionalProperties": false
                        },
                        {
                          "type": "string",
                          "examples": [
                            "FROM /* INTO $upstream"
                          ],
                          "pattern": "^.+$"
                        }
                      ]
                    }
                  }
                },
                "storeAndForwardConfiguration": {
                  "type": "object",
                  "required": [
                    "timeToLiveSecs"
                  ],
                  "properties": {
                    "timeToLiveSecs": {
                      "type": "integer",
                      "examples": [
                        7200
                      ]
                    }
                  },
                  "additionalProperties": false
                }
              },
              "additionalProperties": false
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false,
      "patternProperties": {
        "^[a-zA-Z0-9_-]+$": {
          "type": "object",
          "required": [
            "properties.desired"
          ],
          "properties": {
            "properties.desired": {
              "type": "object"
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "required": [
    "modulesContent"
  ],
  "$defs": {
    "moduleType": {
      "enum": [
        "docker"
      ]
    },
    "status": {
      "enum": [
        "running",
        "stopped"
      ]
    },
    "restartPolicy": {
      "enum": [
        "never",
        "on-failure",
        "on-unhealthy",
        "always"
      ]
    },
    "imagePullPolicy": {
      "enum": [
        "never",
        "on-create"
      ]
    },
    "startupOrder": {
      "type": "integer",
      "minimum": 0,
      "maximum": 4294967295
    },
    "moduleSettings": {
      "type": "object",
      "required": [
        "image"
      ],
      "properties": {
        "image": {
          "type": "string",
          "examples": [
            "mcr.microsoft.com/azureiotedge-agent:1.0"
          ]
        }
      },
      "additionalProperties": false,
      "patternProperties": {
        "^(createoptions|createOptions)[0-9]*$": {
          "$ref": "#/$defs/createOptions"
        }
      }
    },
    "env": {
      "type": "object",
      "additionalProperties": false,
      "patternProperties": {
        "^[^\\+#$\\s\\.]+$": {
          "type": "object",
          "required": [
            "value"
          ],
          "properties": {
            "value": {
              "type": [
                "number",
                "string",
                "boolean"
              ]
            }
          },
          "additionalProperties": false
        }
      }
    },
    "createOptions": {
      "type": "string",
      "contentMediaType": "application/json"
    }
  },
  "additionalProperties": false,
  "id": "https://json.schemastore.org/azure-iot-edge-deployment-2.0.json"
}