gcp.gke.build_kubeconfig ​
Build a kubeconfig-shaped credential document for an existing GKE cluster.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | Base-gcp |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | Yes | — | GCP CloudConnection UUID. |
project_id | string | No | — | GCP project override; defaults to the connection project. |
location | string | Yes | — | GKE cluster region or zone. |
name | string | Yes | — | Cluster name. |
context_name | string | No | — | kubeconfig context name override. |
user_name | string | No | — | kubeconfig user name override. |
namespace_default | string | No | — | Default Kubernetes namespace for the context. |
include_raw_cluster | boolean | No | — | Include sanitized cluster response in output. |
include_token | boolean | No | — | Emit a one-shot bearer token (legacy/direct use). Off by default; delegated connections mint tokens at use-time. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | No | — | GCP CloudConnection UUID echoed from input. |
project_id | string | No | — | Effective GCP project. |
authenticated_project_id | string | No | — | Project resolved by credential validation. |
auth_validation | boolean | No | — | True when credential validation succeeded. |
location | string | No | — | GKE cluster region or zone. |
name | string | No | — | Cluster name. |
provider_resource_id | string | No | — | Full provider cluster resource path. |
status | string | No | — | Cluster status observed while building kubeconfig. |
api_server | string | No | — | Kubernetes API server URL. |
endpoint | string | No | — | Kubernetes API endpoint host or address. |
ca_certificate | string | No | — | Cluster CA certificate PEM. |
ca_certificate_data | string | No | — | Base64-encoded cluster CA from GKE. |
bearer_token | string | No | — | OAuth bearer token minted from the GCP connection. |
token_expires_at | string | No | — | ISO expiry for bearer_token when known. |
kubeconfig | string | No | — | Kubeconfig YAML using current-context and token auth. |
context_name | string | No | — | Effective kubeconfig context name. |
cluster_name | string | No | — | Effective kubeconfig cluster entry name. |
user_name | string | No | — | Effective kubeconfig user entry name. |
namespace_default | string | No | — | Default Kubernetes namespace |
include_raw_cluster | boolean | No | — | Include sanitized cluster response in output. |
include_token | boolean | No | — | Whether a one-shot bearer token was emitted (echoed from input). |
auth_mode | string | No | — | kubeconfig auth mode; gke_delegated by default, bearer_token when include_token is true. |
provider_connection_uuid | string | No | — | GCP CloudConnection UUID a delegated Kubernetes connection mints tokens from at use-time. |
cluster | json | No | — | Sanitized cluster response when include_raw_cluster is true. |
failure_reason | string | No | — | Human-readable failure reason. |
failed_step | string | No | — | Failed logical step. |
failed_layer | json | No | — | Engine failed layer. |
failed_at_state | string | No | — | State where failure occurred. |
error | string | No | — | Error message. |
error_type | string | No | — | Error class. |
failed_at | string | No | — | ISO failure timestamp. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | preflight | — |
executing | No | No | — | complete | — |
preflighting | No | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | preflight | preflighting | — |
preflighting | execute | executing | — |
executing | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "gcp.gke.build_kubeconfig",
"initial_data": {
"connection_uuid": "value",
"location": "value",
"name": "value"
}
}