Appearance
network.connectivity.plan ​
Plan cross-cloud connectivity between AWS, GCP, and Cloudflare
Plan cross-cloud connectivity between AWS, GCP, and Cloudflare.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-network |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | UUID of the organization |
intent_name | string | No | — | Optional human-readable connectivity intent name |
connectivity_type | string | No | — | auto |
source | json | Yes | — | Source domain: provider, region, cidr_blocks, and optional references |
target | json | Yes | — | Target domain: provider, region, cidr_blocks, and optional references |
allowed_cidrs | list | No | — | Optional explicit routable prefixes |
allowed_services | list | No | — | Optional allowed service or port descriptors |
private_dns | boolean | No | — | Whether private DNS or resolver forwarding should be planned |
public_traffic | boolean | No | — | Whether the intent includes public edge traffic steering |
require_redundancy | boolean | No | — | Whether redundant tunnels/circuits should be planned |
actor | string | No | — | Caller initiating the plan |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
intent_name | string | No | — | — |
connectivity_type | string | Yes | — | — |
architecture | string | Yes | — | — |
readiness | string | Yes | — | — |
supported | boolean | Yes | — | — |
blockers | list | Yes | — | — |
warnings | list | Yes | — | — |
source | json | Yes | — | — |
target | json | Yes | — | — |
provider_services | list | Yes | — | — |
required_artifacts | json | Yes | — | — |
route_plan | json | Yes | — | — |
dns_plan | json | Yes | — | — |
traffic_policy | json | Yes | — | — |
verification_plan | json | Yes | — | — |
apply_available | boolean | Yes | — | — |
teardown_available | boolean | Yes | — | — |
next_workflows | list | Yes | — | — |
planned_at | string | Yes | — | — |
failed_at | string | No | — | — |
failure_reason | string | No | — | Engine-stamped human-readable failure reason |
failed_at_state | string | No | — | Engine-stamped state when the workflow failed |
failed_step | string | No | — | Engine-stamped step name (DAG path) |
failed_layer | integer | No | — | Engine-stamped layer index (DAG path) |
error | string | No | — | Engine-stamped exception message |
error_type | string | No | — | Engine-stamped exception class name |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | plan | — |
failed | No | Yes | No | — | — |
planned | No | Yes | Yes | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | plan | planned | — |
* (any state) | fail | failed | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
planned | SUCCESS | Connectivity plan was produced | readiness, architecture |
failed | FAILURE | Connectivity planning failed | failure_reason |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "network.connectivity.plan",
"initial_data": {
"organization_uuid": "value",
"source": "value",
"target": "value"
}
}