Skip to main content

Subscriber (racora.io/v1alpha1)

Generated at build time from charts/racora-crds/files/subscriber-crd.yaml, the single source of the Subscriber schema; edit the source, not this page.

A Subscriber is a SIM declared to the network: the IMSI and a reference to the Secret holding its keys under spec; the core controller provisions it into the selected core provider and reports the outcome under status. Every field's description below is the schema's own (kubectl explain subscriber.spec shows the same text on a cluster). How to add one, and what each provider does with it, is in Add Subscribers.

racora.io/v1alpha1​

Resource Types:

Subscriber​

↩ Parent

Name Type Description Required
apiVersion string racora.io/v1alpha1 true
kind string Subscriber true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object
false
status object
false

Subscriber.spec​

↩ Parent

Name Type Description Required
credentialsSecretRef object The Secret in this namespace holding the SIM credentials: keys `k` (the subscriber key, 32 hex digits) and `opc` (32 hex digits) or `op`, optionally `amf` (4 hex digits, default 8000).
true
imsi string The subscriber's IMSI (15 digits). A value outside the network's PLMN is provisioned anyway (home and serving PLMN may differ).
true
dnn string Data network name (APN) of the default PDU session the UE requests (provider default when unset; Open5GS: internet)
false
qci integer QoS class identifier of the default bearer (provider default when unset; Open5GS: 9)

Minimum: 1
Maximum: 9
false
slices []object Network slices the subscriber may use (default: the network identity's slices, global.network.slices)
false
staticIp string Static UE address the core assigns this subscriber; must lie in the provider's UE pool. Unset = dynamic.
false

Subscriber.spec.credentialsSecretRef​

↩ Parent

The Secret in this namespace holding the SIM credentials: keys k (the subscriber key, 32 hex digits) and opc (32 hex digits) or op, optionally amf (4 hex digits, default 8000).

Name Type Description Required
name string Name of the Secret
true

Subscriber.spec.slices[index]​

↩ Parent

Name Type Description Required
sst integer Slice/service type

Minimum: 0
Maximum: 255
true
sd integer Slice differentiator (optional)

Minimum: 0
Maximum: 1.6777215e+07
false

Subscriber.status​

↩ Parent

Name Type Description Required
conditions []object Kubernetes-style condition Provisioned (True: Provisioned; False: ProviderNotReady or AdapterFailed while retrying, SecretMissing, Unmanaged).
false
observedGeneration integer The spec generation the status reflects
false
phase string Provisioned, Pending (the provider is not ready yet, retrying), Unmanaged (the selected core provider has no subscriber adapter: provision it in your core) or Error
false
provider string The core provider the subscriber was provisioned into
false

Subscriber.status.conditions[index]​

↩ Parent

Name Type Description Required
lastTransitionTime string When the condition last changed

Format: date-time
false
message string Human-readable detail
false
reason string Machine-readable cause: Provisioned, ProviderNotReady, AdapterFailed, SecretMissing or Unmanaged
false
status enum Whether the condition holds

Enum: True, False, Unknown
false
type string Provisioned
false