Skip to content
Proud to collaborate with Microsoft for Startups

kubernetes.ingress.ensure ​

Create or replace a namespaced Kubernetes Ingress (networking.k8s.io/v1)

Creates an Ingress in the given namespace; replaces it if it already exists (patch). Accepts a pre-built ingress_spec dict matching the Kubernetes V1IngressSpec schema (networking.k8s.io/v1) so callers build the spec however they want.

Inputs:

  • connection_uuid: Cloud connection UUID (required)
  • namespace: Target namespace (required)
  • name: Ingress name (required)
  • ingress_spec: Full V1IngressSpec dict (required). Supports ingressClassName, rules, tls, and defaultBackend.

Outputs:

  • existed: True if the Ingress was patched, False if it was created.
  • address: Load-balancer IP or hostname from status.load_balancer.ingress[0] once provisioned; null if not yet assigned.

Plugin required: context.get_plugin("connection").kubernetes_runner_clients(connection_uuid, organization_uuid) must expose networking_v1 (NetworkingV1Api) with read_namespaced_ingress, patch_namespaced_ingress, create_namespaced_ingress.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-kubernetes
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes——
namespacestringYes——
namestringYes——
ingress_specjsonYes——
workflow_run_idstringNo—Engine workflow run id for DAG step execution
organization_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo——
organization_uuiduuidNo——
namespacestringNo——
namestringNo——
ingress_specjsonNo——
existedbooleanNo——
addressstringNo——
workflow_run_idstringNo—Engine workflow run id for DAG step execution
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "kubernetes.ingress.ensure",
  "initial_data": {
    "connection_uuid": "value",
    "namespace": "value",
    "name": "value",
    "ingress_spec": "value"
  }
}