Skip to content
Proud to collaborate with Microsoft for Startups

cluster.provision-mgc-kubernetes ​

Provision a Magalu Cloud Kubernetes cluster, optional node pools, and return a Kubernetes credential payload.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-clusters
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID for tenant isolation and parent cluster correlation.
mgc_connection_uuiduuidYes—Magalu CloudConnection UUID used for provider calls.
cluster_namestringYes—Magalu Kubernetes cluster name.
versionstringNo—Requested Kubernetes version such as v1.30.0.
descriptionstringNo—Optional provider cluster description.
node_poolsjsonNo—Optional list of node pools to create after cluster creation.
nodepool_namestringNo—Convenience single node pool name when node_pools is omitted.
flavorstringNo—Convenience single node pool flavor.
replicasintegerNo—Convenience single node pool initial replica count.
min_replicasintegerNo—Convenience single node pool autoscale minimum.
max_replicasintegerNo—Convenience single node pool autoscale maximum.
fetch_kubeconfigbooleanNo—Fetch kubeconfig after cluster readiness; defaults true.
actorstringNo—Caller initiating the workflow.
timeout_secondsintegerNo—Timeout while polling provider readiness.
poll_intervalintegerNo—Provider readiness polling interval.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID echoed from input.
mgc_connection_uuiduuidNo—Magalu CloudConnection UUID used.
cluster_namestringNo—Magalu Kubernetes cluster name.
versionstringNo—Requested Kubernetes version.
descriptionstringNo—Provider cluster description.
node_poolsjsonNo—Optional list of node pools to create after cluster creation.
nodepool_namestringNo—Convenience single node pool name when node_pools is omitted.
flavorstringNo—Convenience single node pool flavor.
replicasintegerNo—Convenience single node pool initial replica count.
min_replicasintegerNo—Convenience single node pool autoscale minimum.
max_replicasintegerNo—Convenience single node pool autoscale maximum.
fetch_kubeconfigbooleanNo—Fetch kubeconfig after cluster readiness; defaults true.
actorstringNo—Caller initiating the workflow.
timeout_secondsintegerNo—Timeout while polling provider readiness.
poll_intervalintegerNo—Provider readiness polling interval.
create_clusterjsonNo—Output from mgc.kubernetes.create_cluster.
create_nodepoolsjsonNo—Outputs from mgc.kubernetes.create_nodepool fanout.
get_clusterjsonNo—Last output from mgc.kubernetes.get_cluster.
get_kubeconfigjsonNo—Output from mgc.kubernetes.get_kubeconfig.
cluster_idstringNo—Provider cluster id.
provider_cluster_refstringNo—Provider-neutral alias for cluster_id.
clusterjsonNo—Provider cluster object.
nodepoolsjsonNo—Created provider node pool objects.
kubeconfigjsonNo—Kubeconfig material returned by Magalu provider.
credential_payloadjsonNo—Kubernetes credential payload for cluster.register-kubernetes-connection.
statusstringNo—Normalized provision status.
phasestringNo—Raw or normalized provider phase.
readybooleanNo—True when provider status indicates the cluster is ready.
completed_atstringNo—ISO completion timestamp.
failure_reasonstringNo—Human-readable failure reason.
failed_stepjsonNo—Failed logical step or child workflow.
failed_layerjsonNo—Engine failed layer when applicable.
failed_at_statejsonNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.
failed_atstringNo—ISO failure timestamp.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—create_cluster—
creating_clusterNoNo—create_nodepools—
creating_nodepoolsNoNo—wait_cluster_ready—
fetching_kubeconfigNoNo—complete—
waiting_cluster_readyNoNo—fetch_kubeconfig—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingcreate_clustercreating_cluster—
creating_clustercreate_nodepoolscreating_nodepools—
creating_nodepoolswait_cluster_readywaiting_cluster_ready—
waiting_cluster_readyfetch_kubeconfigfetching_kubeconfig—
fetching_kubeconfigcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "cluster.provision-mgc-kubernetes",
  "initial_data": {
    "organization_uuid": "value",
    "mgc_connection_uuid": "value",
    "cluster_name": "value"
  }
}