diff options
| author |   yxpoke <yangxu5@huawei.com> | 2021-11-07 15:35:54 +0800 |
|---|---|---|
| committer | yxpoke <yangxu5@huawei.com> | 2021-11-07 15:37:16 +0800 |
| commit | abba6fda572ea2b058c9f3627fc742e914b4c9ca (patch) | |
| tree | 707a4f4fc10ab33dd7d4b25da8821cb75321c3e5 | |
| parent | 4d57495feaba9a622f05a790e1a0ee71debac2d9 (diff) | |
doc update for R9
Issue-ID: ONAPMODEL-43
Signed-off-by: yxpoke <yangxu5@huawei.com>
Change-Id: Iac756ee4b2d1a52368af8d379024de45b62e108c
| -rw-r--r-- | docs/ONAP Model Spec/im/Runtime/K8sResource.png | bin | 0 -> 357620 bytes | |||
| -rw-r--r-- | docs/ONAP Model Spec/im/Runtime/K8sResource.rst | 180 | ||||
| -rw-r--r-- | docs/ONAP Model Spec/im/index.rst | 1 | ||||
| -rw-r--r-- | docs/Release-notes/release-notes.rst | 31 |
4 files changed, 212 insertions, 0 deletions
diff --git a/docs/ONAP Model Spec/im/Runtime/K8sResource.png b/docs/ONAP Model Spec/im/Runtime/K8sResource.png Binary files differnew file mode 100644 index 0000000..bdc8937 --- /dev/null +++ b/docs/ONAP Model Spec/im/Runtime/K8sResource.png diff --git a/docs/ONAP Model Spec/im/Runtime/K8sResource.rst b/docs/ONAP Model Spec/im/Runtime/K8sResource.rst new file mode 100644 index 0000000..83abe64 --- /dev/null +++ b/docs/ONAP Model Spec/im/Runtime/K8sResource.rst @@ -0,0 +1,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 +================== =========== ========== =========== ========= ===============
\ No newline at end of file diff --git a/docs/ONAP Model Spec/im/index.rst b/docs/ONAP Model Spec/im/index.rst index 390bf07..b8c63db 100644 --- a/docs/ONAP Model Spec/im/index.rst +++ b/docs/ONAP Model Spec/im/index.rst @@ -24,3 +24,4 @@ ONAP Information Model Specifications Common/SelectionCriteria License/LicenseModel Location/Location + Runtime/K8sResource diff --git a/docs/Release-notes/release-notes.rst b/docs/Release-notes/release-notes.rst index c57a69a..057146c 100644 --- a/docs/Release-notes/release-notes.rst +++ b/docs/Release-notes/release-notes.rst @@ -7,6 +7,37 @@ Modeling Spec Release Notes =========================== +Version: 9.0.0 +-------------- + +:Release Date: 2021-11-5 + +**New Features** + +Introduce the following new information model and data model: + +- simplified k8s resource model + +**Bug Fixes** + +**Security Notes** + +Modeling code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. + +Quick Links: +- `Modeling project page <https://wiki.onap.org/display/DW/Modeling+Project>`_ +- `Passing Badge information for Modeling <https://bestpractices.coreinfrastructure.org/en/projects/1774>`_ + +**Known Issues** + None + +**Upgrade Notes** + None + +**Other** + None + Version: 8.0.0 -------------- |
