Skip to main content

PolicyJobSpec

Description

PolicyJobSpec defines the desired state of PolicyJob


NearRtRicId field of tag nearRtRicId

Near-RT RIC identifier. NearRtRicId is the identifier of the Near-RT RIC that is to be used for the policy deployment. The format should look like the following: <ric-name>.<network-name>

Kind: FullTag
Tag: nearRtRicId
Data Type: string
Optional: False


Scopes field of tag scopes

Scopes are optional logical separators. The Workloads in the different scopes would not recognize each other and the Operator would not populate their link information to each other.

Kind: Array of gitlab.eurecom.fr/br/t9s/athena/base-operator/api/v1.NameTag
Tag: scopes
Data Type: Slice
Default Values: "default"
Optional: True


PolicyTypeId field of tag policyTypeId

Policy type identifier as defined in A1AP specification PolicyTypeId is the identifier of the policy type that is to be used for the policy deployment. Use policyTypeId to identify the composion model name.

Kind: FullModel
Tag: policyTypeId
Data Type: string
Optional: False


PolicyObject field of tag policyObject

O-RAN standard Policy Definition Policy Object is a JSON representation of an A1 policy; the A1 policies are specified in A1TD.

Tag: policyObject
Data Type: Struct
Optional: False


XAppPreferences field of tag xAppPreferences

XAppPreferences is a list of preferences for the xApps to be deployed.

Kind: *./api/v1.XAppPreference
Tag: xAppPreferences
Data Type: Pointer
Optional: False


Stimulators field of tag stimulators

Stimulators are triggers that any of them being true would initiate the deployment of the xApp. In other words, these triggers are ORed together. If not defined, the deployment would be immediate.

Tag: stimulators
Data Type: Slice
List Map Key: name
List Type: map
Optional: True


Preconditions field of tag preconditions

Preconditions are triggers that all of them being true would initiate the deployment of the xApp. They are evaluated after the Stimulators and are ANDed together. If not defined, the deployment would be immediate after the Stimulators are evaluated.

Tag: preconditions
Data Type: Slice
List Map Key: name
List Type: map
Optional: True


Breakers field of tag breakers

Breakers are triggers that any of them being true would result in ending the deployment of the xApp. In other words, these triggers are ORed together. If not defined, the deployment would be executed until they are completed or the Timeout is reached.

Tag: breakers
Data Type: Slice
List Map Key: name
List Type: map
Optional: True


Timeout field of tag timeout

Timeout is the maximum amount of time that the deployment should take. If not defined, the deployment would be executed until they are completed or the Breakers are triggered.

Kind: *k8s.io/apimachinery/pkg/apis/meta/v1.Duration
Tag: timeout
Data Type: Pointer
Optional: True