ray/dashboard/modules/snapshot/snapshot_schema.json
Archit Kulkarni 1b67e6a8ae
[Jobs] [Dashboard] Add job submission id as field to job snapshot (#24303)
Closes https://github.com/ray-project/ray/issues/24300

Adds a field to the job submission snapshot that matches the job name in the existing snapshot.  Before this PR, the job submission name was camelcased because all snapshot keys are automatically camelcased.  This PR allows jobs from the old job field to be linked to ones in the new job submission snapshot.
2022-04-29 10:10:24 -05:00

315 lines
No EOL
9 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://github.com/ray-project/ray/dashboard/modules/snapshot/snapshot_schema.json",
"type": "object",
"properties": {
"result": {
"type": "boolean"
},
"msg": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"snapshot": {
"type": "object",
"properties": {
"ray_version": {
"type": "string"
},
"ray_commit": {
"type": "string"
},
"jobs": {
"type": "object",
"patternProperties": {
"[0-9a-f]*": {
"type": "object",
"properties": {
"status": {
"type": [
"string",
"null"
]
},
"status_message": {
"type": [
"string",
"null"
]
},
"isDead": {
"type": "boolean"
},
"startTime": {
"type": "integer"
},
"endTime": {
"type": "integer"
},
"config": {
"type": "object",
"properties": {
"namespace": {
"type": "string"
},
"metadata": {
"type": "object"
},
"runtimeEnv": {
"type": "object"
}
},
"required": [
"namespace",
"metadata",
"runtimeEnv"
]
}
},
"required": [
"isDead",
"startTime",
"endTime",
"config"
]
}
}
},
"jobSubmission": {
"type": "object",
"patternProperties": {
"[0-9a-f]*": {
"type": "object",
"properties": {
"jobSubmissionId": {
"type": "string"
},
"status": {
"type": [
"string",
"null"
]
},
"entrypoint": {
"type": [
"string",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
},
"errorType": {
"type": [
"string",
"null"
]
},
"startTime": {
"type": [
"integer",
"null"
]
},
"endTime": {
"type": [
"integer",
"null"
]
},
"metadata": {
"type": "object"
},
"runtimeEnv": {
"type": "object"
}
},
"required": [
"jobSubmissionId",
"status",
"entrypoint"
]
}
}
},
"actors": {
"type": "object",
"patternProperties": {
"[0-9a-f]*": {
"jobId": {
"type": "string"
},
"state": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"runtimeEnv": {
"type": "string"
},
"startTime": {
"type": "integer"
},
"endTime": {
"type": "integer"
},
"isDetached": {
"type": "boolean"
},
"resources": {
"type": "object",
"properties": {
".*": {
"type": "number"
}
}
},
"actorClass": {
"type": "string"
},
"currentWorkerId": {
"type": "string"
},
"currentRayletId": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"port": {
"type": "integer"
},
"metadata": {
"type": "object",
"properties": {
"serve": {
"type": "object",
"properties": {
"deploymentName": {
"type": "string"
},
"replicaTag": {
"type": "string"
},
"version": {
"type": [
"string",
"null"
]
}
},
"required": [
"deploymentName",
"replicaTag",
"version"
]
}
}
},
"required": [
"jobId",
"state",
"name",
"namespace",
"runtimeEnv",
"startTime",
"endTime",
"isDetached",
"resources",
"currentWorkerId",
"currentRayletId",
"actorClass",
"ipAddress",
"port"
]
}
}
},
"deployments": {
"type": "object",
"patternProperties": {
"[0-9a-f]*": {
"type": "object",
"properties": {
"className": {
"type": "string"
},
"endTime": {
"type": "integer"
},
"startTime": {
"type": "integer"
},
"httpRoute": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"rayJobId": {
"type": "string"
},
"status": {
"type": "string"
},
"version": {
"type": [
"string",
"null"
]
}
},
"required": [
"className",
"startTime",
"endTime",
"httpRoute",
"name",
"namespace",
"rayJobId",
"status",
"version"
]
}
}
}
},
"sessionName": {
"type": "string"
},
"required": [
"rayVersion",
"rayCommit",
"jobs",
"jobSubmission",
"actors",
"sessionName"
]
}
},
"required": [
"snapshot"
]
}
},
"required": [
"result",
"msg",
"data"
]
}