summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorHui Deng <denghui12@huawei.com>2018-04-11 11:11:29 +0000
committerGerrit Code Review <gerrit@onap.org>2018-04-11 11:11:29 +0000
commit2a8479814720e3afc91f1d9a555b57f700ebac37 (patch)
tree42f03e5742623798268cdf72ace0d77f1d0fb806 /docs
parent83ec7faa573ba8464ba3e55eba9de9c13489277e (diff)
parent98226fe21344aa6a87ec4cc48b79ef4775ef8f17 (diff)
Merge "continue converting wiki page to rst document"
Diffstat (limited to 'docs')
-rw-r--r--docs/ONAP release 2 spec/im/L2AddressData.rst34
-rw-r--r--docs/ONAP release 2 spec/im/L3AddressData.rst55
-rw-r--r--docs/ONAP release 2 spec/im/LifecycleManagementScript.rst164
-rw-r--r--docs/ONAP release 2 spec/im/LocalAffinityOrAntiAffinityRule.rst26
4 files changed, 279 insertions, 0 deletions
diff --git a/docs/ONAP release 2 spec/im/L2AddressData.rst b/docs/ONAP release 2 spec/im/L2AddressData.rst
new file mode 100644
index 0000000..2dfde1d
--- /dev/null
+++ b/docs/ONAP release 2 spec/im/L2AddressData.rst
@@ -0,0 +1,34 @@
+.. Copyright 2018 (Huawei)
+.. 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
+
+Class: L2AddressData
+
++----------------------+-------------+------------------+-----------------+---------------+
+| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied |
+| Name** | | | | Stereotypes** |
++======================+=============+==================+=================+===============+
+| macAddressAssignment | Boolean | 1 | Specify if | support: |
+| | | | the MAC address | MANDATORY |
+| | | | assignment | |
+| | | | is the | |
+| | | | responsibility | |
+| | | | of management | |
+| | | | and | |
+| | | | orchestration | |
+| | | | function or not.| |
+| | | | | |
+| | | | If it is set to | |
+| | | | True, it is the | |
+| | | | management and | |
+| | | | orchestration | |
+| | | | function | |
+| | | | responsibility. | |
+| | | | | |
+| | | | If it is set to | |
+| | | | False, it will | |
+| | | | be provided by | |
+| | | | an external | |
+| | | | entity, e.g. | |
+| | | | OSS/BSS.  | |
++----------------------+-------------+------------------+-----------------+---------------+
diff --git a/docs/ONAP release 2 spec/im/L3AddressData.rst b/docs/ONAP release 2 spec/im/L3AddressData.rst
new file mode 100644
index 0000000..6451fff
--- /dev/null
+++ b/docs/ONAP release 2 spec/im/L3AddressData.rst
@@ -0,0 +1,55 @@
+.. Copyright 2018 (Huawei)
+.. 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
+
+Class: L3AddressData
+
++---------------------+-------------+------------------+-----------------+---------------+
+| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied |
+| Name** | | | | Stereotypes** |
++=====================+=============+==================+=================+===============+
+| iPAddressAssignment | Boolean | 1 | Specify if | support: |
+| | | | the address | MANDATORY |
+| | | | assignment | |
+| | | | is the | |
+| | | | responsibility | |
+| | | | of management | |
+| | | | and | |
+| | | | orchestration | |
+| | | | function or not.| |
+| | | | | |
+| | | | If it is set to | |
+| | | | True, it is the | |
+| | | | management and | |
+| | | | orchestration | |
+| | | | function | |
+| | | | responsibility. | |
++---------------------+-------------+------------------+-----------------+---------------+
+| floatingIpActivated | Boolean | 1 | Specify if the | support: |
+| | | | floating IP | MANDATORY |
+| | | | scheme is | |
+| | | | activated on | |
+| | | | the CP or not. | |
++---------------------+-------------+------------------+-----------------+---------------+
+| iPAddressType | Enum | 0..1 | Define address | support: |
+| | | | type. | MANDATORY |
+| | | | | |
+| | | | NOTE: The | valueRange: |
+| | | | address type | "IPv4", |
+| | | | should be | "IPv6" |
+| | | | aligned with | |
+| | | | the address type| |
+| | | | supported by the| |
+| | | | layerProtocol | |
+| | | | attribute of | |
+| | | | the parent Cpd. | |
++---------------------+-------------+------------------+-----------------+---------------+
+| numberOfIpAddress | Integer | 0..1 | Minimum | support: |
+| | | | number of IP | MANDATORY |
+| | | | addresses to be | |
+| | | | assigned based | |
+| | | | on this | |
+| | | | L3AddressData | |
+| | | | information | |
+| | | | element. | |
++---------------------+-------------+------------------+-----------------+---------------+
diff --git a/docs/ONAP release 2 spec/im/LifecycleManagementScript.rst b/docs/ONAP release 2 spec/im/LifecycleManagementScript.rst
new file mode 100644
index 0000000..3145bfe
--- /dev/null
+++ b/docs/ONAP release 2 spec/im/LifecycleManagementScript.rst
@@ -0,0 +1,164 @@
+.. Copyright 2018 (Huawei)
+.. 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
+
+Class: LifecycleManagementScript
+
++--------------------+-------------+------------------+-------------------+-------------------------------------+
+| **Attribute Name** | **Type** | **Multiplicity** | **Description** | **Applied Stereotypes** |
++====================+=============+==================+===================+=====================================+
+| event | Enum | 0..N | Describes | support: |
+| | | | VNF | MANDATORY |
+| | | | lifecycle | |
+| | | | event(s) or | valueRange: |
+| | | | an external | for |
+| | | | stimulus | lifecycle |
+| | | | detected on | events, |
+| | | | a VNFM | include: |
+| | | | reference | "EVENT_START_INSTANTIATION", |
+| | | | point. | "EVENT_END_INSTANTIATION", |
+| | | | | "EVENT_START_SCALING", |
+| | | | NOTE: At | "EVENT_END_SCALING", |
+| | | | least one | "EVENT_START_SCALING_TO_LEVEL", |
+| | | | of these | "EVENT_END_SCALING_TO_LEVEL", |
+| | | | two | "EVENT_START_HEALING", |
+| | | | attributes | "EVENT_END_HEALING", |
+| | | | shall be | "EVENT_START_TERMINATION", |
+| | | | included. | "EVENT_END_TERMINATION", |
+| | | | | "EVENT_START_VNF_FLAVOR_CHANGE", |
+| | | | | "EVENT_END_VNF_FLAVOR_CHANGE", |
+| | | | | "EVENT_START_VNF_OPERATION_CHANGE", |
+| | | | | "EVENT_END_VNF_OPERATION_CHANGE", |
+| | | | | "EVENT_START_VNF_EXT_CONN_CHANGE", |
+| | | | | "EVENT_END_VNF_EXT_CONN_CHANGE", |
+| | | | | "EVENT_START_VNFINFO_MODIFICATION", |
+| | | | | "EVENT_END_VNFINFO_MODIFICATION"; |
+| | | | | for |
+| | | | | external |
+| | | | | stimulus, |
+| | | | | include: |
+| | | | | receipt of |
+| | | | | request |
+| | | | | message of |
+| | | | | instantiation, |
+| | | | | scaling, |
+| | | | | healing, |
+| | | | | termination, |
+| | | | | change of |
+| | | | | VNF |
+| | | | | flavour, |
+| | | | | change of |
+| | | | | the |
+| | | | | operation |
+| | | | | state of |
+| | | | | the VNF, |
+| | | | | change of |
+| | | | | external |
+| | | | | VNF |
+| | | | | connectivity, |
+| | | | | modification |
+| | | | | of VNF |
+| | | | | information |
+| | | | | or the |
+| | | | | receipt of |
+| | | | | a |
+| | | | | notification |
+| | | | | regarding |
+| | | | | the change |
+| | | | | of a VNF |
+| | | | | indicator |
+| | | | | value. |
++--------------------+-------------+------------------+-------------------+-------------------------------------+
+| lcmTransitionEvent | String | 0..N | Describes | support: |
+| | | | the | MANDATORY |
+| | | | transition | |
+| | | | VNF | |
+| | | | lifecycle | |
+| | | | event(s) | |
+| | | | that cannot | |
+| | | | be mapped | |
+| | | | to any of | |
+| | | | the | |
+| | | | enumerated | |
+| | | | values | |
+| | | | defined for | |
+| | | | the event | |
+| | | | attribute. | |
+| | | | | |
+| | | | NOTE: At | |
+| | | | least one | |
+| | | | of these | |
+| | | | two | |
+| | | | attributes | |
+| | | | shall be | |
+| | | | included. | |
++--------------------+-------------+------------------+-------------------+-------------------------------------+
+| script | String | 1 | Information | support: |
+| | | | to locate a | MANDATORY |
+| | | | VNF LCM | |
+| | | | script | |
+| | | | (e.g. | |
+| | | | written in | |
+| | | | a DSL as | |
+| | | | specified | |
+| | | | in | |
+| | | | requirement | |
+| | | | VNF_PACK.LCM.001) | |
+| | | | triggered | |
+| | | | to react to | |
+| | | | one of the | |
+| | | | events | |
+| | | | listed in | |
+| | | | the event | |
+| | | | attribute. | |
++--------------------+-------------+------------------+-------------------+-------------------------------------+
+| scriptDsl | String | 1 | Defines the | support: |
+| | | | domain | MANDATORY |
+| | | | specific | |
+| | | | language | |
+| | | | (i.e. the | |
+| | | | type) of | |
+| | | | script that | |
+| | | | is | |
+| | | | provided. | |
+| | | | Types of | |
+| | | | scripts | |
+| | | | could | |
+| | | | include | |
+| | | | bash, | |
+| | | | python, | |
+| | | | etc. | |
++--------------------+-------------+------------------+-------------------+-------------------------------------+
+| scriptInput | KeyValuePair| 0..N | Array of | support: |
+| | | | KVP | MANDATORY |
+| | | | requirements | |
+| | | | with the | |
+| | | | key as the | |
+| | | | parameter | |
+| | | | name and | |
+| | | | the value | |
+| | | | as the | |
+| | | | parameter | |
+| | | | that need | |
+| | | | to be | |
+| | | | passed as | |
+| | | | an input to | |
+| | | | the script. | |
+| | | | | |
+| | | | NOTE: The | |
+| | | | scriptInput | |
+| | | | values are | |
+| | | | passed to | |
+| | | | the scripts | |
+| | | | in addition | |
+| | | | to the | |
+| | | | parameters | |
+| | | | received in | |
+| | | | the | |
+| | | | operation | |
+| | | | invocation | |
+| | | | request or | |
+| | | | indicator | |
+| | | | value | |
+| | | | change. | |
++--------------------+-------------+------------------+-------------------+-------------------------------------+
diff --git a/docs/ONAP release 2 spec/im/LocalAffinityOrAntiAffinityRule.rst b/docs/ONAP release 2 spec/im/LocalAffinityOrAntiAffinityRule.rst
new file mode 100644
index 0000000..7fbec96
--- /dev/null
+++ b/docs/ONAP release 2 spec/im/LocalAffinityOrAntiAffinityRule.rst
@@ -0,0 +1,26 @@
+.. Copyright 2018 (Huawei)
+.. 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
+
+Class: LocalAffinityOrAntiAffinityRule
+
++-------------+-------------+------------------+-----------------+----------------+
+| **Attribute | **Type** | **Multiplicity** | **Description** | **Applied |
+| Name** | | | | Stereotypes** |
++=============+=============+==================+=================+================+
+| type | Enum | 1 | Specifies | support: |
+| | | | whether the rule| MANDATORY |
+| | | | is an affinity | |
+| | | | rule or an | valueRange: |
+| | | | anti-affinity | "Affinity", |
+| | | | rule. | "Anti-Affinity"|
++-------------+-------------+------------------+-----------------+----------------+
+| scope | Enum | 1 | Specifies the | support: |
+| | | | scope of the | MANDATORY |
+| | | | rule. | |
+| | | | | valueRange: |
+| | | | | "NFVI-PoP", |
+| | | | | "Zone", |
+| | | | | "ZoneGroup", |
+| | | | | "NFVI-node" |
++-------------+-------------+------------------+-----------------+----------------+