NexoPipeline
:::tip Reconciled
The selected Operator registers this Kind. Runtime effect still requires a valid reference from the owning Proxy graph and a compatible runtime component.
:::
This page documents the current development contract. Schema acceptance, Operator reconciliation, and runtime enforcement are separate claims; the status above is authoritative.
API identity
| Property | Value |
|---|---|
| Kind | NexoPipeline |
| API group | nexo.io |
| Version | v1alpha1 |
| Resource | nexopipelines |
| Short name | npipe |
| Scope | Namespaced |
| Operator support | Reconciled |
Purpose and relationships
Declares the ordered request, response, router, and connection component references for a Proxy graph.
NexoProxy references it through spec.pipelineRef. The Operator resolves its component references and renders their order into the Proxy runtime graph.
Spec field reference
The table is derived from the installed Nexo Edge CRD OpenAPI schema. “Not declared” means the schema publishes no default. A missing schema description is reported explicitly rather than inferred from implementation.
| Field | Type | Required | Default | Schema description |
|---|---|---|---|---|
spec.request | object | No | Not declared | No description is declared in the CRD schema. |
spec.request.steps | array<object> | No | Not declared | No description is declared in the CRD schema. |
spec.request.steps[].name | string | Yes | Not declared | No description is declared in the CRD schema. |
spec.request.steps[].dataAccessOptIn | string | No | Not declared | No description is declared in the CRD schema. Allowed values: metadata-only, field-scoped, full-message. |
spec.request.steps[].ref | object | Yes | Not declared | No description is declared in the CRD schema. |
spec.request.steps[].ref.kind | string | Yes | Not declared | No description is declared in the CRD schema. Allowed values: NexoFilter, NexoLogger, NexoMetrics, NexoIndexAdvisor, NexoRateLimit, NexoCache, NexoRouter, NexoConnectionPooler, NexoEchoUntrusted, NexoAudit, NexoRewrite, NexoShadow, NexoVersionCompat, NexoQuerySizeLimit, NexoQueryGuard, NexoTrafficSplit, NexoTenantIsolation, NexoReadWriteSplit, NexoPIIMasking, NexoFieldEncryption. |
spec.request.steps[].ref.name | string | Yes | Not declared | No description is declared in the CRD schema. |
spec.response | object | No | Not declared | No description is declared in the CRD schema. |
spec.response.steps | array<object> | No | Not declared | No description is declared in the CRD schema. |
spec.response.steps[].name | string | Yes | Not declared | No description is declared in the CRD schema. |
spec.response.steps[].dataAccessOptIn | string | No | Not declared | No description is declared in the CRD schema. Allowed values: metadata-only, field-scoped, full-message. |
spec.response.steps[].ref | object | Yes | Not declared | No description is declared in the CRD schema. |
spec.response.steps[].ref.kind | string | Yes | Not declared | No description is declared in the CRD schema. Allowed values: NexoFilter, NexoLogger, NexoMetrics, NexoIndexAdvisor, NexoRateLimit, NexoCache, NexoRouter, NexoConnectionPooler, NexoEchoUntrusted, NexoAudit, NexoRewrite, NexoShadow, NexoVersionCompat, NexoQuerySizeLimit, NexoQueryGuard, NexoTrafficSplit, NexoTenantIsolation, NexoReadWriteSplit, NexoPIIMasking, NexoFieldEncryption. |
spec.response.steps[].ref.name | string | Yes | Not declared | No description is declared in the CRD schema. |
spec.router | object | No | Not declared | No description is declared in the CRD schema. |
spec.router.ref | object | No | Not declared | No description is declared in the CRD schema. |
spec.router.ref.kind | string | Yes | Not declared | No description is declared in the CRD schema. Allowed values: NexoFilter, NexoLogger, NexoMetrics, NexoIndexAdvisor, NexoRateLimit, NexoCache, NexoRouter, NexoConnectionPooler, NexoEchoUntrusted, NexoAudit, NexoRewrite, NexoShadow, NexoVersionCompat, NexoQuerySizeLimit, NexoQueryGuard, NexoTrafficSplit, NexoTenantIsolation, NexoReadWriteSplit, NexoPIIMasking, NexoFieldEncryption. |
spec.router.ref.name | string | Yes | Not declared | No description is declared in the CRD schema. |
spec.connection | array<object> | No | Not declared | No description is declared in the CRD schema. |
spec.connection[].name | string | Yes | Not declared | No description is declared in the CRD schema. |
spec.connection[].ref | object | Yes | Not declared | No description is declared in the CRD schema. |
spec.connection[].ref.kind | string | Yes | Not declared | No description is declared in the CRD schema. Allowed values: NexoFilter, NexoLogger, NexoMetrics, NexoIndexAdvisor, NexoRateLimit, NexoCache, NexoRouter, NexoConnectionPooler, NexoEchoUntrusted, NexoAudit, NexoRewrite, NexoShadow, NexoVersionCompat, NexoQuerySizeLimit, NexoQueryGuard, NexoTrafficSplit, NexoTenantIsolation, NexoReadWriteSplit, NexoPIIMasking, NexoFieldEncryption. |
spec.connection[].ref.name | string | Yes | Not declared | No description is declared in the CRD schema. |
Status fields and conditions
| Field | Type | Required | Default | Schema description |
|---|---|---|---|---|
status.ready | boolean | No | Not declared | No description is declared in the CRD schema. |
status.observedGeneration | integer (int64) | No | Not declared | No description is declared in the CRD schema. |
status.configHash | string | No | Not declared | No description is declared in the CRD schema. |
status.conditions | array<object> | No | Not declared | No description is declared in the CRD schema. |
status.conditions[].type | string | No | Not declared | No description is declared in the CRD schema. |
status.conditions[].status | string | No | Not declared | No description is declared in the CRD schema. |
status.conditions[].reason | string | No | Not declared | No description is declared in the CRD schema. |
status.conditions[].message | string | No | Not declared | No description is declared in the CRD schema. |
status.conditions[].lastTransitionTime | string (date-time) | No | Not declared | No description is declared in the CRD schema. |
status.conditions[].observedGeneration | integer (int64) | No | Not declared | No description is declared in the CRD schema. |
The pinned/current pipeline controller reports validation and component-resolution conditions. Ready does not prove that every referenced runtime component executes correctly.
Reconciliation and watch behavior
The pipeline controller validates the object and referenced components. The NexoProxy controller separately consumes it when reconciling the owning graph.
The pipeline controller watches NexoPipeline; the Proxy controller also watches installed referenced CRDs and maps changes to affected proxies.
Runtime execution effect
Its resolved references determine which sidecars or runtime components are rendered and in which phase/order.
Example
Use placeholders and validate in a non-production namespace first. For schema-only or ineffective kinds, this example is for schema inspection only and must not be used as evidence of enforcement.
apiVersion: nexo.io/v1alpha1
kind: NexoPipeline
metadata:
name: <pipeline-name>
namespace: <namespace>
spec:
request:
steps:
- name: rate-limit
ref:
kind: NexoRateLimit
name: <rate-limit-name>
Update and reconciliation caveats
- Apply component and pipeline changes before expecting the owning NexoProxy graph to change.
- Check metadata.generation, status.observedGeneration when present, and the owning Proxy graphRevision/appliedRevision after every update.
- A successful kubectl apply proves only schema admission; inspect Operator conditions, generated configuration, rollout state, and runtime behavior separately.
Release-specific limitations
- The API is v1alpha1 and has no conversion webhook or second served version.
- The CRD schema is retained by Helm and can outlive the Operator release that installed it.
- Current documentation can describe unreleased development behavior; verify the exact deployed bundle and image digests.
Inspect with kubectl
kubectl get nexopipelines --namespace <namespace>
kubectl describe nexopipelines <name> --namespace <namespace>
kubectl get nexopipelines <name> --namespace <namespace> -o yaml
kubectl get crd nexopipelines.nexo.io -o yaml
For resources participating in a Proxy graph, also inspect:
kubectl get nexoproxy <proxy-name> --namespace <namespace> \
-o jsonpath='{.status.phase}{" graph="}{.status.graphRevision}{" applied="}{.status.appliedRevision}{"\n"}'
kubectl get nexopipeline <pipeline-name> --namespace <namespace> -o yaml