Skip to main content
Version: 0.2.0 (Private Preview)

NexoVersionCompat

:::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 0.2.0 Private Preview. Schema acceptance, Operator reconciliation, and runtime enforcement are separate claims; the status above is authoritative.

API identity

PropertyValue
KindNexoVersionCompat
API groupnexo.io
Versionv1alpha1
Resourcenexoversioncompats
Short namenvc
ScopeNamespaced
Operator supportReconciled

Purpose and relationships

Configures MongoDB wire-version compatibility checks and optional compatibility behavior.

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.

FieldTypeRequiredDefaultSchema description
spec.minWireVersioninteger (int32)NoNot declaredNo description is declared in the CRD schema.
spec.maxWireVersioninteger (int32)NoNot declaredNo description is declared in the CRD schema.
spec.blockUnsupportedbooleanNoNot declaredNo description is declared in the CRD schema.
spec.reportOnlybooleanNoNot declaredNo description is declared in the CRD schema.
spec.clientVersionsarray<string>NoNot declaredNo description is declared in the CRD schema.
spec.serverVersionsarray<string>NoNot declaredNo description is declared in the CRD schema.
spec.patchBuildInfobooleanNoNot declaredNo description is declared in the CRD schema.
spec.strictModebooleanNoNot declaredNo description is declared in the CRD schema.
spec.featureDetectionbooleanNoNot declaredNo description is declared in the CRD schema.
spec.negotiationLoggingbooleanNoNot declaredNo description is declared in the CRD schema.
spec.commandTranslationobjectNoNot declaredNo description is declared in the CRD schema.
spec.commandTranslation.enabledbooleanNoNot declaredNo description is declared in the CRD schema.
spec.commandTranslation.translationsobjectNoNot declaredNo description is declared in the CRD schema.
spec.clientUpgradeAdvisorobjectNoNot declaredNo description is declared in the CRD schema.
spec.clientUpgradeAdvisor.enabledbooleanNoNot declaredNo description is declared in the CRD schema.
spec.clientUpgradeAdvisor.minVersionstringNoNot declaredNo description is declared in the CRD schema.
spec.clientUpgradeAdvisor.warnHeaderbooleanNoNot declaredNo description is declared in the CRD schema.

Status fields and conditions

FieldTypeRequiredDefaultSchema description
status.readybooleanNoNot declaredNo description is declared in the CRD schema.
status.observedGenerationinteger (int64)NoNot declaredNo description is declared in the CRD schema.
status.configHashstringNoNot declaredNo description is declared in the CRD schema.
status.conditionsarray<object>NoNot declaredNo description is declared in the CRD schema.
status.conditions[].typestringNoNot declaredNo description is declared in the CRD schema.
status.conditions[].statusstringNoNot declaredNo description is declared in the CRD schema.
status.conditions[].reasonstringNoNot declaredNo description is declared in the CRD schema.
status.conditions[].messagestringNoNot declaredNo description is declared in the CRD schema.
status.conditions[].lastTransitionTimestring (date-time)NoNot declaredNo description is declared in the CRD schema.
status.conditions[].observedGenerationinteger (int64)NoNot declaredNo 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.

The Kind has its own status controller, but it is absent from the pinned NexoProxy watch list. After an update, explicitly requeue the owning NexoProxy and verify graphRevision/appliedRevision.

Runtime execution effect

When successfully rendered, the runtime observes or blocks incompatible wire/client/server behavior according to the selected settings.

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: NexoVersionCompat
metadata:
name: <compat-name>
namespace: <namespace>
spec:
reportOnly: true

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.
  • This immutable page describes Nexo Edge 0.2.0 with Operator 008260c and Proxy 7064b41; later behavior must not be inferred.

Inspect with kubectl

kubectl get nexoversioncompats --namespace <namespace>
kubectl describe nexoversioncompats <name> --namespace <namespace>
kubectl get nexoversioncompats <name> --namespace <namespace> -o yaml
kubectl get crd nexoversioncompats.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

Search Nexo documentation

Type to search titles, headings, and page content.