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

• Schema ID: https://agent-service.spec/v1/schemas/common/execution-profile.json
• Defs: 6
• Properties: 0
• Required: 0

Source

{
  "$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
        }
      }
    },
    "ExecutionProfile": {
      "type": "object",
      "additionalProperties": false,
      "required": ["runKind", "runEnv"],
      "properties": {
        "runKind": {
          "$ref": "./enums.json#/$defs/taskRunKind"
        },
        "runEnv": {
          "$ref": "./enums.json#/$defs/taskRunEnv"
        },
        "runSpaceRelease": {
          "$ref": "./enums.json#/$defs/taskRunSpaceReleasePolicy"
        },
        "image": {
          "type": "string"
        },
        "cwd": {
          "type": "string"
        },
        "runCode": {
          "type": "string"
        },
        "env": {
          "type": "object",
          "default": {},
          "additionalProperties": {
            "type": "string"
          }
        },
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ActionStep"
          }
        },
        "sessionMaxTTL": {
          "type": "integer",
          "minimum": 0
        },
        "successGraceTTL": {
          "type": "integer",
          "minimum": 0
        },
        "kvExpire": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "GrayscaleRuleMatch": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type"],
      "properties": {
        "type": {
          "type": "string",
          "enum": ["user", "header", "contextId", "env"]
        },
        "pattern": {
          "type": "string"
        },
        "headerKey": {
          "type": "string"
        },
        "envKey": {
          "type": "string"
        },
        "envValue": {
          "type": "string"
        }
      }
    },
    "GrayscaleRule": {
      "type": "object",
      "additionalProperties": false,
      "required": ["rules", "executionProfile"],
      "properties": {
        "name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean",
          "default": true
        },
        "priority": {
          "type": "integer"
        },
        "rules": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/GrayscaleRuleMatch"
          }
        },
        "executionProfile": {
          "$ref": "#/$defs/ExecutionProfile"
        }
      }
    }
  }
}