Skip to content

execution-profile

Generated reference page for spec/v1/schemas/common/execution-profile.json.

Metadata

  • Type: JSON Schema
  • Source: spec/v1/schemas/common/execution-profile.json
  • Raw: View Raw

Summary

Source

json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://agent-service.spec/v1/schemas/common/execution-profile.json",
  "$defs": {
    "ActionRetryPolicy": {
      "type": "object",
      "additionalProperties": false,
      "required": ["times", "backoff"],
      "properties": {
        "times": {
          "type": "integer",
          "minimum": 0
        },
        "backoff": {
          "type": "string",
          "enum": ["fixed", "exponential"]
        },
        "interval": {
          "type": "integer",
          "minimum": 0
        },
        "maxInterval": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "ActionStep": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name", "uses"],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "uses": {
          "type": "string",
          "minLength": 1
        },
        "with": {},
        "workingDirectory": {
          "type": "string"
        },
        "timeout": {
          "type": "integer",
          "minimum": 0
        },
        "retry": {
          "$ref": "#/$defs/ActionRetryPolicy"
        },
        "continueOnError": {
          "type": "boolean"
        },
        "skipSameRunSpace": {
          "type": "boolean"
        }
      }
    },
    "SecretRef": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name", "ref"],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "ref": {
          "type": "string",
          "minLength": 1
        },
        "required": {
          "type": "boolean",
          "default": true
        }
      }
    },
    "ExecutionClass": {
      "type": "object",
      "additionalProperties": false,
      "required": ["runKind", "runEnv"],
      "properties": {
        "runKind": {
          "$ref": "./enums.json#/$defs/taskRunKind"
        },
        "runEnv": {
          "$ref": "./enums.json#/$defs/taskRunEnv"
        },
        "providerHints": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "RuntimeTemplate": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "image": {
          "type": "string"
        },
        "cwd": {
          "type": "string"
        },
        "entrypoint": {
          "type": "string"
        },
        "runCode": {
          "type": "string"
        },
        "env": {
          "type": "object",
          "default": {},
          "additionalProperties": {
            "type": "string"
          }
        },
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ActionStep"
          }
        }
      }
    },
    "LeasePolicy": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "runSpaceRelease": {
          "$ref": "./enums.json#/$defs/taskRunSpaceReleasePolicy"
        },
        "sessionMaxTTL": {
          "type": "integer",
          "minimum": 0
        },
        "successGraceTTL": {
          "type": "integer",
          "minimum": 0
        },
        "kvExpire": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "RunPolicy": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "maxRetries": {
          "type": "integer",
          "minimum": 0
        },
        "runTimeoutMs": {
          "type": "integer",
          "minimum": 0
        },
        "idleTimeoutMs": {
          "type": "integer",
          "minimum": 0
        },
        "priorityClass": {
          "$ref": "./enums.json#/$defs/runPriorityClass"
        },
        "quotaPolicyRef": {
          "type": "string"
        }
      }
    },
    "ExecutionProfile": {
      "type": "object",
      "additionalProperties": false,
      "required": ["executionClass"],
      "properties": {
        "executionClass": {
          "$ref": "#/$defs/ExecutionClass"
        },
        "runtimeTemplate": {
          "$ref": "#/$defs/RuntimeTemplate"
        },
        "leasePolicy": {
          "$ref": "#/$defs/LeasePolicy"
        }
      }
    }
  }
}

白皮书与规范内容以仓库真源为准。