docs/ONAP Model Spec/im/Runtime/K8sResource.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

.. Copyright 2021
.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode

Simplified K8S Resource Model 
=============================

.. contents::
   :depth: 3
..

Diagrams
--------

K8S Resource 
~~~~~~~~~~~~

.. image:: K8sResource.png

Classes
-------

GenericVnf
~~~~~~~~~~

Applied stereotypes:

-  Experimental

-  OpenModelClass

-  **support: MANDATORY**

K8sResource
~~~~~~~~~~~

A&AI object that represents a resource in K8S

**Parent class:** ResourceInstance

Applied stereotypes:

-  Reference

-  OpenModelClass

-  **support: MANDATORY**

-  Preliminary

=================== ========== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== ========================================================
**Attribute Name**  **Type**   **Mult.** **Stereotypes**                    **Description**                                                                                                                                                                                                                                                                                                                                                        **Defined in**
group               String     1         OpenModelAttribute                 API group of the K8S resource, e.g., "apps"                                                                                                                                                                                                                                                                                                                            Vnf::ObjectClasses::K8sResource::group
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  isInvariant: false                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  valueRange: no range constraint                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  support: MANDATORY                                                                                                                                                                                                                                                                                                                                                                                    
version             String     1         OpenModelAttribute                 API version of the K8S resource, e.g., "v1"                                                                                                                                                                                                                                                                                                                            Vnf::ObjectClasses::K8sResource::version
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  isInvariant: false                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  valueRange: no range constraint                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  support: MANDATORY                                                                                                                                                                                                                                                                                                                                                                                    
kind                String     1         OpenModelAttribute                 type of the K8S resource, e.g., "Deployment"                                                                                                                                                                                                                                                                                                                           Vnf::ObjectClasses::K8sResource::kind
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  isInvariant: false                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  valueRange: no range constraint                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  support: MANDATORY                                                                                                                                                                                                                                                                                                                                                                                    
namespace           String     0..1      OpenModelAttribute                 namespace of the K8S resource                                                                                                                                                                                                                                                                                                                                          Vnf::ObjectClasses::K8sResource::namespace
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  isInvariant: false                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  valueRange: no range constraint                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  support: MANDATORY                                                                                                                                                                                                                                                                                                                                                                                    
labels              String     0..\*     OpenModelAttribute                 labels of the K8S resource                                                                                                                                                                                                                                                                                                                                             Vnf::ObjectClasses::K8sResource::labels
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  isInvariant: false                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  valueRange: no range constraint                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  support: MANDATORY                                                                                                                                                                                                                                                                                                                                                                                    
k8sResourceSelflink String     1         OpenModelAttribute                 URI of the K8S resource                                                                                                                                                                                                                                                                                                                                                Vnf::ObjectClasses::K8sResource::k8sResourceSelflink
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  isInvariant: false                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  valueRange: no range constraint                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  support: MANDATORY                                                                                                                                                                                                                                                                                                                                                                                    
name                String     0..1      OpenModelAttribute                 Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object). Common::Root::RootObjectClasses::RootEntity::name
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  isInvariant: false                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  valueRange: no range constraint                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  support: MANDATORY                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         Preliminary                                                                                                                                                                                                                                                                                                                                                                                              
description         String     0..1      OpenModelAttribute                 Defines a textual free-form description of the object.                                                                                                                                                                                                                                                                                                                 Common::Root::RootObjectClasses::RootEntity::description
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  isInvariant: false                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  valueRange: no range constraint                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  support: MANDATORY                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         Preliminary                                                                                                                                                                                                                                                                                                                                                                                              
id                  Identifier 1         OpenModelAttribute                 Unambiguously distinguishes different object instances. It is the naming attribute of the object.                                                                                                                                                                                                                                                                      Common::Root::RootObjectClasses::RootEntity::id
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  isInvariant: false              Identifier of this information element. This attribute shall be globally unique.                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  valueRange: no range constraint                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         -  support: MANDATORY                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                         Preliminary                                                                                                                                                                                                                                                                                                                                                                                              
=================== ========== ========= ================================== ====================================================================================================================================================================================================================================================================================================================================================================== ========================================================

Tenant
~~~~~~

Applied stereotypes:

-  Experimental

-  OpenModelClass

-  **support: MANDATORY**

VfModule
~~~~~~~~

Applied stereotypes:

-  Experimental

-  OpenModelClass

-  **support: MANDATORY**

Associations
------------

K8sResourceBelongsToTenant
~~~~~~~~~~~~~~~~~~~~~~~~~~

Applied stereotypes:

================== =========== ========== =========== ========= ===============
**Attribute Name** **Aggreg.** **Navig.** **Type**    **Mult.** **Description**
tenant             none        Navig.     Tenant      1        
k8sresource        none        Not navig. K8sResource 1..\*    
================== =========== ========== =========== ========= ===============

GenericVnfHostedOnK8sResource
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Applied stereotypes:

================== =========== ========== =========== ========= ===============
**Attribute Name** **Aggreg.** **Navig.** **Type**    **Mult.** **Description**
k8sresource        none        Navig.     K8sResource 0..\*    
genericvnf         none        Not navig. GenericVnf  1        
================== =========== ========== =========== ========= ===============

VfModuleUsesK8sResource
~~~~~~~~~~~~~~~~~~~~~~~

Applied stereotypes:

================== =========== ========== =========== ========= ===============
**Attribute Name** **Aggreg.** **Navig.** **Type**    **Mult.** **Description**
k8sresource        none        Navig.     K8sResource 0..\*    
vfmodule           none        Not navig. VfModule    1        
================== =========== ========== =========== ========= ===============