/
AAI Reverse-engineering -- K8S resource

AAI Reverse-engineering -- K8S resource

Owned by Jacqueline Beaulac [Ericsson]
Last updated: Nov 08, 2021


1         Diagrams

1.1        Overview

Qualified Name: AAIModel::Diagrams

1.1.1        Diagrams

Figure 13‑1: Diagram K8S resource and neighbors

1         ObjectClasses

1.1        Overview

Qualified Name: AAIModel::ObjectClasses

1.1.1        Classes

1.1.1.1         generic-vnf class

Qualified Name: AAIModel::ObjectClasses::generic-vnf

Description:

General purpose VNF

Applied Stereotypes:

  • OpenModelClass
  • support: MANDATORY

Table 7‑1 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

vf-module

vf-module

0..*


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



l-interface

l-interface

0..*


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



entitlement

entitlement

0..*


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



license

license

0..*


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



lag-interface

lag-interface

0..*


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vdisk-units

String

1

units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



nf-function

String

1

English description of Network function that the specific VNF deployment is providing



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



software-version

String

1

VNF instance specific software version



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



as-number

String

1

as-number of the VNF



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



heat-stack-id

String

1

Heat stack id corresponding to this instance, managed by MSO



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



management-option

String

1

identifier of managed customer



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



regional-resource-zone

String

1

Regional way of organizing pservers, source of truth should define values



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



nm-lan-v6-address

String

1

v6 Loopback address



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



orchestration-status

String

1

Orchestration status of this VNF, used by MSO.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



nm-profile-name

String

1

Network Management profile of this VNF



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vnf-discriptor-name

String

1

vnf discriptor name



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vnf-name

String

1

Name of VNF.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



model-version-id

String

1

the ASDC model version for this resource or service model.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



model-customization-id

String

1

captures the id of all the configuration used to customize the resource for the service.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



nf-naming-code

String

1

string assigned to this model used for naming purposes



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vmemory

Integer

1

number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



resource-version

String

1

Used for optimistic concurrency.  Must be empty on create, valid on update and delete.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



nf-role

String

1

role in the network that this model will be providing



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



widget-model-id

String

1

the ASDC data dictionary widget model. This maps directly to the A&AI widget.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vnf-type

String

1

String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



persona-model-version

String

1

the ASDC model version for this resource or service model.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vnf-instance-id

String

1

vnf instance id.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



equipment-role

String

1

Client should send valid enumerated value



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



mso-catalog-key

String

1

Corresponds to the SDN-C catalog id used to configure this VCE



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



nvm

Integer

1

number of vms in vnf.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



nf-type

String

1

Generic description of the type of NF



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vmemory-units

String

1

units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



ipv4-oam-gateway-address

String

1

Gateway address



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



ipv4-oam-address

String

1

Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



ipv4-oam-gateway-address-prefix-length

Integer

1

Prefix length for oam-address



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



management-v6-address

String

1

v6 management address



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



encrypted-access-flag

Boolean

1

indicates whether generic-vnf access uses SSH



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



nnet

Integer

1

number of network in vnf.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vnf-id

String

1

Unique id of VNF.  This is unique across the graph.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vdisk

Integer

1

number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vnf-name2

String

1

Alternate name of VNF.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



regional-resource-subzone

String

1

represents sub zone of the rr plane



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vcpu-units

String

1

units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vnf-package-name

String

1


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



in-maint

Boolean

1

used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



nshd

Integer

1

number of associated SHD in vnf.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vlan-id-outer

Integer

1

Temporary location for S-TAG to get to VCE



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vcpu

Integer

1

number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



is-closed-loop-disabled

Boolean

1

used to indicate whether closed loop function is enabled on this node



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



job-id

String

1

job id corresponding to vnf



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



widget-model-version

String

1

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



operational-status

String

1

Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



model-invariant-id

String

1

the ASDC model id for this resource or service model.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



application-id

String

1

vnf application-id



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



selflink

String

1

Path to the controller object.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



ipv4-loopback0-address

String

1

v4 Loopback0 address



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



prov-status

String

1

Trigger for operational monitoring of this resource by Service Assurance systems.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY




1.1.1.1         tenant class

Qualified Name: AAIModel::ObjectClasses::tenant

Description:

Openstack tenant

Applied Stereotypes:

  • OpenModelClass
  • support: MANDATORY

Table 7‑1 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

vserver

vserver

0..*


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



nos-server

nos-server

0..*


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



parent-id

String

1

tenant parent-id



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



tenant-context

String

1

This field will store the tenant context.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



resource-version

String

1

Used for optimistic concurrency.  Must be empty on create, valid on update and delete.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



tenant-id

String

1

Unique id relative to the cloud-region.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



tenant-name

String

1

Readable name of tenant



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



k8s-resource

k8s-resource

0..*


OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY




1.1.1.1         vf-module class

Qualified Name: AAIModel::ObjectClasses::vf-module

Description:

a deployment unit of VNFCs

Applied Stereotypes:

  • OpenModelClass
  • support: MANDATORY

Table 7‑1 Attributes for Package ObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

resource-version

String

1

Used for optimistic concurrency.  Must be empty on create, valid on update and delete.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



widget-model-id

String

1

the ASDC data dictionary widget model. This maps directly to the A&AI widget.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



heat-stack-id

String

1

Heat stack id corresponding to this instance.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vf-module-id

String

1

Unique ID of vf-module.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



persona-model-version

String

1

the ASDC model version for this resource or service model.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



automated-assignment

Boolean

1

Indicates whether vf-module assignment was done via automation or manually



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



widget-model-version

String

1

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



module-index

Integer

1

the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



orchestration-status

String

1

orchestration status of this vf-module, mastered by MSO



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



operational-status

String

1

Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



vf-module-name

String

1

Name of vf-module



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



model-invariant-id

String

1

the ASDC model id for this resource or service model.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



contrail-service-instance-fqdn

String

1

the Contrail unique ID for a service-instance



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



model-version-id

String

1

the ASDC model version for this resource or service model.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



model-customization-id

String

1

captures the id of all the configuration used to customize the resource for the service.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



selflink

String

1

Path to the controller object.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



is-base-vf-module

Boolean

1

used to indicate whether or not this object is base vf module



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





Related content

Root
Root
ONAP Wiki
More like this
AAI OXM Schema UML
AAI OXM Schema UML
ONAP Wiki
More like this
Proposed Location Model
Proposed Location Model
ONAP Wiki
More like this
AAI EdgeRules UML
AAI EdgeRules UML
ONAP Wiki
More like this
Class: VirtualNetworkInterfaceRequirements
Class: VirtualNetworkInterfaceRequirements
ONAP Wiki
More like this
Comparison of Current R3 Clean Version with IFA011 v2.5.1
Comparison of Current R3 Clean Version with IFA011 v2.5.1
ONAP Wiki
More like this