app-config.schema.json

Go to the documentation of this file.

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://nvidia.com/dw/app-config.schema.json",
    "title": "DW Application Config Descriptor",
    "description": "The descriptor to override the configuration of a DriveWorks application. The keys in JSON should appear in the same order as the properties are documented in the schema.",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "comment": {
            "description": "In a manually written JSON file this field can contain an arbitrary text. When the JSON file is generated, the tool should include its own name and optionally reference the authoritive source of information.",
            "type": "string"
        },
        "componentParameters": {
            "description": "The component parameters to override. The order should be alphabetical.",
            "type": "object",
            "additionalProperties": false,
            "patternProperties": {
                "^([a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*)?$": {
                    "description": "The key is the fully qualified name of the subcomponent (in the form of 1 or multiple 'subcomponentInstanceName' separated by dots). An empty key refers to the parameters of the application. The order should be alphabetical. The value contains a mapping from parameter names to parameter values.",
                    "type": "object",
                    "additionalProperties": false,
                    "patternProperties": {
                        "^[a-z][a-zA-Z0-9_]*(\\.[a-z][a-zA-Z0-9_]*)?$": {
                            "description": "The key is the parameter name from the component. The value is the parameter value which must match the type of the parameter defined in the component descriptor. The order should be alphabetical.",
                            "type": [
                                "array",
                                "boolean",
                                "number",
                                "string"
                            ]
                        }
                    }
                }
            }
        },
        "skipNodes": {
            "description": "The nodes to skip from being scheduled. The order should be alphabetical.",
            "type": "object",
            "additionalProperties": false,
            "patternProperties": {
                "^[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$": {
                    "description": "The key is the fully qualified name of the node. Refering to a graphlet implicitly refers to all recursive nodes. The value identifies the 'stmSchedules' the skip applies to (and empty list means skipping the node in all schedules).",
                    "type": "array",
                    "items": {
                        "type": "string",
                        "pattern": "[a-z][a-zA-Z0-9_]*$"
                    },
                    "uniqueItems": true
                }
            }
        },
        "stmSchedules": {
            "description": "The key is a STM schedule identifier, value is the STM schedule. Only hyperepoch and epoch periods can be modified. The order should be alphabetical.",
            "type": "object",
            "additionalProperties": false,
            "patternProperties": {
                "^[a-z][a-zA-Z0-9_]*": {
                    "description": "The information needed to modify the STM schedule.",
                    "type": "object",
                    "required": [
                        "hyperepochs"
                    ],
                    "additionalProperties": false,
                    "properties": {
                        "hyperepochs": {
                            "description": "The hyperepochs. The order should be alphabetical.",
                            "type": "object",
                            "additionalProperties": false,
                            "patternProperties": {
                                "^[a-z][a-zA-Z0-9_]*$": {
                                    "description": "The key is the name of the hyperepoch (in camelCase) which must be unique within the collection of hyperepochs in this schedule. The value describes the hyperepoch itself.",
                                    "type": "object",
                                    "required": [
                                        "epochs"
                                    ],
                                    "additionalProperties": false,
                                    "properties": {
                                        "period": {
                                            "description": "The period length of the hyperepoch (in nanoseconds).",
                                            "type": "integer",
                                            "minimum": 0
                                        },
                                        "monitoringPeriod": {
                                            "description": "The pfm monitoring threshold of the hyperepoch (in nanoseconds).",
                                            "type": "integer",
                                            "minimum": 0
                                        },
                                        "epochs": {
                                            "description": "The epochs. The order should be alphabetical.",
                                            "type": "object",
                                            "additionalProperties": false,
                                            "patternProperties": {
                                                "^[a-z][a-zA-Z0-9_]*$": {
                                                    "description": "The key is the name of the epoch (in camelCase) which must be unique within the hyperepoch. The value describes the epoch itself.",
                                                    "type": "object",
                                                    "required": [
                                                        "period"
                                                    ],
                                                    "additionalProperties": false,
                                                    "properties": {
                                                        "period": {
                                                            "description": "The period length of the epoch (in nanoseconds)",
                                                            "type": "integer",
                                                            "minimum": 0
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "processes": {
            "description": "The process attributes to override. The order should be alphabetical.",
            "type": "object",
            "additionalProperties": false,
            "patternProperties": {
                "^[a-zA-Z][a-zA-Z0-9_]*$": {
                    "description": "The key is the name of the process (in snake_case). The value describes the process itself.",
                    "additionalProperties": false,
                    "properties": {
                        "executableDir": {
                            "description": "The absolute path of the directory (without a trailing slash) to override where the executable (identified by the basename of the 'executable' value) is located.",
                            "type": "string"
                        },
                        "argv": {
                            "description": "The command line arguments passed to the executable",
                            "type": "object",
                            "additionalProperties": false,
                            "patternProperties": {
                                "^[a-zA-Z0-9_-]+$": {
                                    "description": "The key is one command line argument. The value is not used (if it is the boolean value true), a second argument (if it is a string), multiple additional arguments (if it is an array of strings). If the value is 'null' value the key is removed and not passed to the process.",
                                    "anyOf": [
                                        {
                                            "type": "boolean",
                                            "const": true
                                        },
                                        {
                                            "type": "string"
                                        },
                                        {
                                            "type": "array",
                                            "items": {
                                                "type": [
                                                    "string"
                                                ]
                                            }
                                        },
                                        {
                                            "type": "null"
                                        }
                                    ]
                                }
                            }
                        },
                        "data": {
                            "description": "The provided content is combined with the base application using JSON merge patch",
                            "type": "object"
                        }
                    }
                }
            }
        },
        "requiredSensors": {
            "description": "The required sensors to remove or update. The order is user defined.",
            "type": "object",
            "additionalProperties": false,
            "patternProperties": {
                "^[a-zA-Z][a-zA-Z0-9 .:_-]*$": {
                    "description": "The key is the required sensor name which could be either rig sensor name or a key of sensor mappings. The value is either a json null to remove this required sensor or an object to update this required sensor attributes.",
                    "anyOf": [
                        {
                            "type": "null"
                        },
                        {
                            "description": "Attributes for each required sensor. Only support \"typeIndex\" attribute currently. For those sensor types of which sensor is unique in the app, \"typeIndex\" can be ignored.",
                            "type": "object",
                            "additionalProperties": false,
                            "properties": {
                                "typeIndex": {
                                    "description": "The sensor index of certain sensor type, applied in the app.",
                                    "type": "integer",
                                    "minimum": 0
                                },
                                "connectedTo": {
                                    "description": "An array containing the machine names this sensor is connected to (machine0, machine1 ... machineN).",
                                    "type": "array",
                                    "items": {
                                        "type": "string",
                                        "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
                                    }
                                }
                            }
                        }
                    ]
                }
            }
        },
        "extraInfo": {
            "description": "DEPRECATED! Override key-value pairs from the extraInfo JSON file",
            "type": "object"
        },
        "Recorder": {
            "description": "Parameters for the Recorder",
            "type": "object"
        },
        "RoadCastService": {
            "description": "Parameters for the RoadCast service",
            "type": "object"
        }
    }
}