Skip to content
Proud to collaborate with Microsoft for Startups

cluster.azure-vm.collect-kubeconfig ​

Collect the admin kubeconfig produced by a Azure VM Kubernetes bootstrap process.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-clusters-azure
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
workflow_run_idstringNo—Engine-stamped parent DAG run id when invoked as a Step target
organization_uuiduuidNo—Organization UUID; scopes the collected credential.
subscription_idstringNo—Azure subscription override; defaults to the connection subscription.
connection_uuiduuidYes—Azure CloudConnection UUID.
resource_groupstringYes—Explicit Azure subscription override.
vm_namestringYes—VM name that ran the Kubernetes bootstrap.
cluster_namestringNo—Logical cluster name for kubeconfig context normalization.
bootstrap_output_sourcestringNo—serial-port
timeout_secondsintegerNo—Timeout for polling bootstrap output.
poll_interval_secondsintegerNo—Poll interval for bootstrap output.

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—Azure CloudConnection UUID echoed from input.
resource_groupstringYes—Resolved Azure subscription.
zonestringNo—Azure region.
vm_namestringNo—VM name.
cluster_namestringNo—Logical cluster name.
kubeconfigstringNo—Kubeconfig YAML collected from bootstrap output.
api_serverstringNo—Kubernetes API server URL parsed from kubeconfig.
ca_certificatestringNo—CA certificate data parsed from kubeconfig.
context_namestringNo—Normalized kubeconfig context name.
collected_atstringNo—ISO timestamp when kubeconfig was collected.
sourcestringNo—Bootstrap output source used.
failure_reasonstringNo—Human-readable failure reason.
failed_stepstringNo—Failed logical step.
failed_layerjsonNo—Engine failed layer if applicable.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.
failed_atstringNo—ISO failure timestamp.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—collect—
collectingNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingcollectcollecting—
collectingcompletecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "cluster.azure-vm.collect-kubeconfig",
  "initial_data": {
    "connection_uuid": "value",
    "resource_group": "value",
    "vm_name": "value"
  }
}