Skip to main content

MonitoringJobSpec

Description

MonitoringJobSpec defines the desired state of MonitoringJob


Target field of tag target

Target identifier. based on the task, the targer is interpered as a different thing. For example, if the task is "deploy-xapp", the target is near rt ric to be deployed. The format should look like the following: <element-name>.<network-name>

Kind: FullTag
Tag: target
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


MonitoringTypeId field of tag monitoringTypeId

Monitoring type identifier MonitoringTypeId is the identifier of the monitoring type that is to be used for the monitoring deployment. Use MonitoringTypeId to identify the composion model name. TODO: Use Control Model to have objective based monitoring.

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


MonitoringObject field of tag monitoringObject

Monitoring Object is a JSON representation.

Tag: monitoringObject
Data Type: Struct
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