Skip to main content
Version: Next (Private Preview)

NexoTenantIsolation

:::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

PropertyValue
KindNexoTenantIsolation
API groupnexo.io
Versionv1alpha1
Resourcenexotenantisolations
Short namenti
ScopeNamespaced
Operator supportReconciled

Purpose and relationships

Declares tenant identification, routing, and cross-tenant isolation policy.

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.identificationStrategystringNoNot declaredNo description is declared in the CRD schema. Allowed values: field, header, jwt, connection.
spec.fieldPathstringNoNot declaredNo description is declared in the CRD schema.
spec.headerNamestringNoNot declaredNo description is declared in the CRD schema.
spec.jwtClaimPathstringNoNot declaredNo description is declared in the CRD schema.
spec.connectionMetadataKeystringNoNot declaredNo description is declared in the CRD schema.
spec.unidentifiedRequestBehaviorstringNoNot declaredNo description is declared in the CRD schema. Allowed values: reject, allow_warning, route_default.
spec.rejectUnidentifiedbooleanNoNot declaredNo description is declared in the CRD schema.
spec.logViolationsbooleanNoNot declaredNo description is declared in the CRD schema.
spec.crossTenantBlockingstringNoNot declaredNo description is declared in the CRD schema. Allowed values: strict, audit, disabled.
spec.perTenantRateLimitobjectNoNot declaredNo description is declared in the CRD schema.
spec.perTenantRateLimit.requestsPerSecondinteger (int32)NoNot declaredNo description is declared in the CRD schema. Minimum: 0.
spec.perTenantRateLimit.maxConnectionsinteger (int32)NoNot declaredNo description is declared in the CRD schema. Minimum: 0.
spec.allowlistarray<string>NoNot declaredNo description is declared in the CRD schema.
spec.denylistarray<string>NoNot declaredNo description is declared in the CRD schema.
spec.tenantRoutingarray<object>NoNot declaredNo description is declared in the CRD schema.
spec.tenantRouting[].tenantIdstringNoNot declaredNo description is declared in the CRD schema.
spec.tenantRouting[].targetstringNoNot declaredNo description is declared in the CRD schema.
spec.defaultTargetstringNoNot declaredNo description is declared in the CRD schema.
spec.dedicatedPoolsobjectNoNot declaredNo description is declared in the CRD schema.
spec.dedicatedPools.enabledbooleanNoNot declaredNo description is declared in the CRD schema.
spec.dedicatedPools.poolSizeinteger (int32)NoNot declaredNo description is declared in the CRD schema. Minimum: 0.
spec.dataResidencyarray<object>NoNot declaredNo description is declared in the CRD schema.
spec.dataResidency[].tenantPatternstringNoNot declaredNo description is declared in the CRD schema.
spec.dataResidency[].allowedRegionsarray<string>NoNot declaredNo description is declared in the CRD schema.
spec.breachAlertingobjectNoNot declaredNo description is declared in the CRD schema.
spec.breachAlerting.enabledbooleanNoNot declaredNo description is declared in the CRD schema.
spec.breachAlerting.webhookUrlstringNoNot declaredNo description is declared in the CRD schema.
spec.modestringNoNot declaredNo description is declared in the CRD schema. Allowed values: database, collection_prefix, auth_user, header.
spec.routingobjectNoNot declaredNo description is declared in the CRD schema.
spec.default_targetobjectNoNot declaredNo description is declared in the CRD schema.
spec.default_target.namestringNoNot declaredNo description is declared in the CRD schema.
spec.default_target.addressstringNoNot declaredNo description is declared in the CRD schema.
spec.default_target.tlsbooleanNoNot declaredNo description is declared in the CRD schema.
spec.allow_unknown_tenantsbooleanNoNot declaredNo description is declared in the CRD schema.
spec.blocklistarray<string>NoNot declaredNo description is declared in the CRD schema.
spec.default_rate_limitinteger (int32)NoNot declaredNo description is declared in the CRD schema. Minimum: 0.
spec.prevent_cross_tenantbooleanNoNot 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.

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 router/policy runtime derives an authenticated tenant boundary, blocks cross-tenant access, and may choose a tenant target.

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: NexoTenantIsolation
metadata:
name: <tenant-policy-name>
namespace: <namespace>
spec:
identificationStrategy: connection
connectionMetadataKey: <authenticated-tenant-key>
unidentifiedRequestBehavior: reject
crossTenantBlocking: strict

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