Youki · Schema

Oci Runtime Defs

Definitions used throughout the Open Container Initiative Runtime Specification

ContainersContainer RuntimeOCIRustCNCFCloud NativeKubernetes
View JSON Schema on GitHub

JSON Schema

oci-runtime-defs.json Raw ↑
{
    "description": "Definitions used throughout the Open Container Initiative Runtime Specification",
    "definitions": {
        "int8": {
            "type": "integer",
            "minimum": -128,
            "maximum": 127
        },
        "int16": {
            "type": "integer",
            "minimum": -32768,
            "maximum": 32767
        },
        "int32": {
            "type": "integer",
            "minimum": -2147483648,
            "maximum": 2147483647
        },
        "int64": {
            "type": "integer",
            "minimum": -9223372036854775808,
            "maximum": 9223372036854775807
        },
        "uint8": {
            "type": "integer",
            "minimum": 0,
            "maximum": 255
        },
        "uint16": {
            "type": "integer",
            "minimum": 0,
            "maximum": 65535
        },
        "uint32": {
            "type": "integer",
            "minimum": 0,
            "maximum": 4294967295
        },
        "uint64": {
            "type": "integer",
            "minimum": 0,
            "maximum": 18446744073709551615
        },
        "percent": {
            "type": "integer",
            "minimum": 0,
            "maximum": 100
        },
        "mapStringString": {
            "type": "object",
            "patternProperties": {
                ".{1,}": {
                    "type": "string"
                }
            }
        },
        "UID": {
            "$ref": "#/definitions/uint32"
        },
        "GID": {
            "$ref": "#/definitions/uint32"
        },
        "Umask": {
            "$ref": "#/definitions/uint32"
        },
        "ArrayOfGIDs": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/GID"
            }
        },
        "ArrayOfStrings": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "ArrayOfUint32": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/uint32"
            }
        },
        "FileMode": {
            "description": "File permissions mode (in decimal, not octal)",
            "type": "integer",
            "minimum": 0,
            "maximum": 511
        },
        "FilePath": {
            "type": "string"
        },
        "Env": {
            "$ref": "#/definitions/ArrayOfStrings"
        },
        "Hook": {
            "type": "object",
            "properties": {
                "path": {
                    "$ref": "#/definitions/FilePath"
                },
                "args": {
                    "$ref": "#/definitions/ArrayOfStrings"
                },
                "env": {
                    "$ref": "#/definitions/Env"
                },
                "timeout": {
                    "type": "integer",
                    "minimum": 1
                }
            },
            "required": [
                "path"
            ]
        },
        "ArrayOfHooks": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/Hook"
            }
        },
        "IDMapping": {
            "type": "object",
            "properties": {
                "containerID": {
                    "$ref": "#/definitions/uint32"
                },
                "hostID": {
                    "$ref": "#/definitions/uint32"
                },
                "size": {
                    "$ref": "#/definitions/uint32"
                }
            },
            "required": [
                "containerID",
                "hostID",
                "size"
            ]
        },
        "Mount": {
            "type": "object",
            "properties": {
                "source": {
                    "$ref": "#/definitions/FilePath"
                },
                "destination": {
                    "$ref": "#/definitions/FilePath"
                },
                "options": {
                    "$ref": "#/definitions/ArrayOfStrings"
                },
                "type": {
                    "type": "string"
                },
                "uidMappings": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/IDMapping"
                    }
                },
                "gidMappings": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/IDMapping"
                    }
                }
            },
            "required": [
                "destination"
            ]
        },
        "ociVersion": {
            "description": "The version of Open Container Initiative Runtime Specification that the document complies with",
            "type": "string"
        },
        "annotations": {
            "$ref": "#/definitions/mapStringString"
        }
    }
}