Appearance
runner.group-update.prepare ​
Resolve and validate effective coding storage settings
Resolve the effective coding-storage policy before group mutation.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-runners |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | Yes | — | UUID of the RunnerGroup to patch, picked from the organization's list of runner groups. |
organization_uuid | uuid | No | — | Ignored when present — org is resolved from auth context |
max_count | integer | No | — | — |
min_count | integer | No | — | — |
desired_count | integer | No | — | — |
runner_labels | list | No | — | — |
description | string | No | — | — |
config | dict | No | — | — |
config_strategy | string | No | — | 'merge' (default) or 'replace' |
actor_uuid | uuid | No | — | UUID of the user or service actor who triggered this action, injected server-side from the authenticated request; used for audit/attribution only. Optional — omit for system or service-triggered actions with no human actor. |
coding_runtime_enabled | boolean | No | — | Enable software-development-v1 for this DevKit or Orkestia-hosted Kubernetes or Azure VM agent group. Once enabled, use the audited retirement workflow to disable it. |
coding_artifact_storage_connection_uuid | uuid | No | — | Customer CloudConnection used by the Storage workflow to create or reconcile private coding-artifact storage. |
coding_artifact_retention_days | integer | No | — | Recovery retention for noncurrent versions, 7-90 days. |
coding_artifact_capacity_bytes | integer | No | — | Required hard live-byte ceiling for the customer-owned coding-artifact bucket. Valid range: 512 MiB to 1 TiB. |
coding_artifact_storage_usd_per_gb_month | string | No | — | Customer storage price in USD per decimal GB-month. |
coding_artifact_storage_pricing_revision | string | No | — | Immutable revision identifier for the supplied storage price. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | No | — | UUID of the RunnerGroup this action operates on, picked from the organization's list of runner groups; echoed on output alongside terminal/error payloads. |
organization_uuid | uuid | No | — | UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. Echoed on output alongside terminal/error payloads. |
runner_execution_uuid | uuid | No | — | UUID of the RunnerExecution this action operates on, picked from the organization's (optionally group-scoped) list of executions; echoed on output alongside terminal/error payloads. |
workflow_uuid | string | No | — | Engine workflow-run identifier (or, for GitHub-Actions-triggered flows, an external GitHub Actions run id) associated with this record; not a platform entity foreign key despite the name. No source is attached since there is no list/query workflow for an internal run id. |
status | string | No | — | — |
outcome | string | No | — | — |
initiated_at | string | No | — | — |
completed_at | string | No | — | — |
failed_at | string | No | — | — |
failure_reason | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
actor_uuid | uuid | No | — | UUID of the user or service actor who triggered this action, injected server-side from the authenticated request when available; used for audit/attribution only. Optional — omitted for system or service-triggered actions with no human actor. |
reason | string | No | — | — |
workflow_run_uuid | string | No | — | Engine-stamped correlation/run id for this DAG execution (ADR-015/E1 plumbing), written into state_data by action_start; not a foreign key to any business entity. No source is attached since there is no list/query workflow for an internal run id. |
retry_count | integer | No | — | — |
retried_from | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | json | No | — | — |
failed_at_state | json | No | — | — |
compensation_trigger | json | No | — | — |
comp_current_layer | json | No | — | — |
comp_queue | json | No | — | — |
comp_retry_count | json | No | — | — |
max_count | integer | No | — | — |
min_count | integer | No | — | — |
desired_count | integer | No | — | — |
runner_labels | list | No | — | — |
description | string | No | — | — |
config | dict | No | — | — |
config_strategy | string | No | — | 'merge' (default) or 'replace' |
coding_runtime_enabled | boolean | No | — | Enable software-development-v1 for this DevKit or Orkestia-hosted Kubernetes or Azure VM agent group. Once enabled, use the audited retirement workflow to disable it. |
coding_artifact_storage_connection_uuid | uuid | No | — | Customer CloudConnection used by the Storage workflow to create or reconcile private coding-artifact storage. |
coding_artifact_retention_days | integer | No | — | Recovery retention for noncurrent versions, 7-90 days. |
coding_artifact_capacity_bytes | integer | No | — | Required hard live-byte ceiling for the customer-owned coding-artifact bucket. Valid range: 512 MiB to 1 TiB. |
coding_artifact_storage_usd_per_gb_month | string | No | — | Customer storage price in USD per decimal GB-month. |
coding_artifact_storage_pricing_revision | string | No | — | Immutable revision identifier for the supplied storage price. |
coding_storage_required | boolean | No | — | — |
hosted_coding_pool_refresh_required | boolean | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | prepare | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | prepare | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "runner.group-update.prepare",
"initial_data": {
"runner_group_uuid": "value"
}
}