NexoIndexAdvisor
:::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 | NexoIndexAdvisor |
| API group | nexo.io |
| Version | v1alpha1 |
| Resource | nexoindexadvisors |
| Short name | nia |
| Scope | Namespaced |
| Operator support | Reconciled |
Purpose and relationships
Configures query-pattern sampling and index recommendations.
It has runtime effect only when a NexoPipeline referenced by a NexoProxy includes this object in a compatible phase and the selected Operator/runtime bundle supports the contract.
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.sampleRate | integer (int32) | No | Not declared | No description is declared in the CRD schema. Minimum: 1. Maximum: 100. |
spec.minQueryTimeMs | integer (int64) | No | Not declared | No description is declared in the CRD schema. Minimum: 0. |
spec.flushIntervalSec | integer (int32) | No | Not declared | No description is declared in the CRD schema. Minimum: 0. |
spec.storageDb | string | No | Not declared | No description is declared in the CRD schema. |
spec.storageCollection | string | No | Not declared | No description is declared in the CRD schema. |
spec.ttlDays | integer (int32) | No | Not declared | No description is declared in the CRD schema. Minimum: 0. |
spec.explainEnabled | boolean | No | Not declared | No description is declared in the CRD schema. |
spec.explainTopN | integer (int32) | No | Not declared | No description is declared in the CRD schema. Minimum: 0. |
spec.excludeCollections | array<string> | No | Not declared | No description is declared in the CRD schema. |
spec.excludeDatabases | array<string> | No | Not declared | No description is declared in the CRD schema. |
spec.webhookUrl | string | No | Not declared | No description is declared in the CRD schema. |
spec.reportInterval | string | No | Not declared | No description is declared in the CRD schema. |
spec.costEstimation | object | No | Not declared | No description is declared in the CRD schema. |
spec.costEstimation.enabled | boolean | No | Not declared | No description is declared in the CRD schema. |
spec.detectDuplicates | object | No | Not declared | No description is declared in the CRD schema. |
spec.detectDuplicates.enabled | boolean | No | Not declared | No description is declared in the CRD schema. |
spec.autoExplain | object | No | Not declared | No description is declared in the CRD schema. |
spec.autoExplain.enabled | boolean | No | Not declared | No description is declared in the CRD schema. |
spec.autoExplain.intervalSec | integer (int32) | No | Not declared | No description is declared in the CRD schema. Minimum: 0. |
spec.autoExplain.topN | integer (int32) | No | Not declared | No description is declared in the CRD schema. Minimum: 0. |
spec.usageTracking | object | No | Not declared | No description is declared in the CRD schema. |
spec.usageTracking.enabled | boolean | No | Not declared | No description is declared in the CRD schema. |
spec.failurePolicy | string | No | Not declared | No description is declared in the CRD schema. Allowed values: skip, fail. |
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. |
A Ready or configHash value proves that the Operator accepted/hashed the object; it does not by itself prove runtime execution or policy enforcement.
Reconciliation and watch behavior
The registered controller validates the resource and records status. Data-path changes are applied only when the relevant NexoProxy controller rebuilds or reloads the owning graph.
At startup, the current NexoProxy controller installs a typed watch when the CRD is discoverable. A CRD installed after Operator startup requires an Operator restart before that reference watch is added.
Runtime execution effect
The runtime samples query patterns and produces index recommendations; optional explain behavior can add database load.
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: NexoIndexAdvisor
metadata:
name: <advisor-name>
namespace: <namespace>
spec:
sampleRate: 10
explainEnabled: false
failurePolicy: skip
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 nexoindexadvisors --namespace <namespace>
kubectl describe nexoindexadvisors <name> --namespace <namespace>
kubectl get nexoindexadvisors <name> --namespace <namespace> -o yaml
kubectl get crd nexoindexadvisors.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