diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Install_Docker.rst | 2 | ||||
| -rw-r--r-- | docs/SO_Interface.rst (renamed from docs/SO_R1_Interface.rst) | 251 | ||||
| -rw-r--r-- | docs/images/SO_1.png | bin | 0 -> 83586 bytes | |||
| -rw-r--r-- | docs/images/SO_Architecture_1.png | bin | 108239 -> 123253 bytes | |||
| -rw-r--r-- | docs/images/SO_R1_1.png | bin | 64882 -> 0 bytes | |||
| -rw-r--r-- | docs/index.rst | 2 | ||||
| -rw-r--r-- | docs/installation.rst | 4 | ||||
| -rw-r--r-- | docs/offered_consumed_apis.rst | 4 | ||||
| -rw-r--r-- | docs/release-notes.rst | 16 |
9 files changed, 251 insertions, 28 deletions
diff --git a/docs/Install_Docker.rst b/docs/Install_Docker.rst index 5712691dbf..22a76a4fbf 100644 --- a/docs/Install_Docker.rst +++ b/docs/Install_Docker.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 Huawei Technologies Co., Ltd.
+.. Copyright 2018 Huawei Technologies Co., Ltd.
Install Docker
===============
diff --git a/docs/SO_R1_Interface.rst b/docs/SO_Interface.rst index bd654083e3..15e75fa8c6 100644 --- a/docs/SO_R1_Interface.rst +++ b/docs/SO_Interface.rst @@ -1,11 +1,11 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 Huawei Technologies Co., Ltd. +.. Copyright 2018 Huawei Technologies Co., Ltd. SO Interfaces ================================ -.. image:: images/SO_R1_1.png +.. image:: images/SO_1.png SO APIs ================================= @@ -1771,33 +1771,65 @@ Service Object +------------------------------+-----------------+------------------------------------+ |Attribute |Content |Description | +==============================+=================+====================================+ -|modelName |String |Service instance name. | +|name |String |Service instance name. | +------------------------------+-----------------+------------------------------------+ |description |String |Service instance description | +------------------------------+-----------------+------------------------------------+ -|modelUUID |String |Model UUID | +|serviceUuid |String |Model UUID | +------------------------------+-----------------+------------------------------------+ -|modelInvariantUUID |String |Model Invariant UUID | +|serviceInvariantUuid |String |Model Invariant UUID | +------------------------------+-----------------+------------------------------------+ -|created |Timestamp |Cretaed Timestamp | +|gloabalSubscriberId |String |Customer Id | +------------------------------+-----------------+------------------------------------+ -|toscaCsarArtifactUUID |String |tosca Csar Artifact UUID | +|serviceType |String |service Type | +------------------------------+-----------------+------------------------------------+ -|modelVersion |String |Model Version | +|parameters |Object |Parameter Object | +------------------------------+-----------------+------------------------------------+ -|category |String |category | + +Parameter Object + +------------------------------+-----------------+------------------------------------+ -|serviceType |String |service Type | +|Attribute |Content |Description | ++==============================+=================+====================================+ +|locationConstraints |List of object |location infor for each vnf | ++------------------------------+-----------------+------------------------------------+ +|resource |List of Resource |resource of service/resource | ++------------------------------+-----------------+------------------------------------+ +|requestInputs |key-value map |input of service/resource ++------------------------------+-----------------+------------------------------------+ + +LocationConstraint Object + ++------------------------------+-----------------+------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+====================================+ +|vnfProfileId |String |Customization id for VNF | ++------------------------------+-----------------+------------------------------------+ +|locationConstraints |Object |DC location info of VNF | +------------------------------+-----------------+------------------------------------+ -|serviceRole |String |service Role | + +VnfLocationConstraint Object + ++------------------------------+-----------------+------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+====================================+ +|vimId |String |VIM id from ESR definition | ++------------------------------+-----------------+------------------------------------+ + +Resource Object + ++------------------------------+-----------------+------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+====================================+ +|resourceName |String |The resource name | +------------------------------+-----------------+------------------------------------+ -|environmentContext |String |environment Context | +|resourceInvariantUuid |String |The resource invariant UUID. | +------------------------------+-----------------+------------------------------------+ -|workloadContext |String |workload Context | +|resourceUuid |String |The resource UUID. | +------------------------------+-----------------+------------------------------------+ -|recipes |Object |recipes | +|resourceCustomizationUuid |String |The resource customization UUID. | +------------------------------+-----------------+------------------------------------+ -|serviceResourceCustomizations |Object |serviceResourceCustomizations | +|parameters |Object |Parameter of resource | +------------------------------+-----------------+------------------------------------+ Response: @@ -4257,4 +4289,191 @@ HTTP Response Code: |401 |Unauthorized | +------------------+---------------------+ |500 |Error | -+------------------+---------------------+
\ No newline at end of file ++------------------+---------------------+ + + +OOF/HAS create update API ++++++++++++++++++++++++++ + ++--------------------+--------------------------+ +|Interface Definition|Description | ++====================+==========================+ +|URI |/api/oof/v1/placement | ++--------------------+--------------------------+ +|Operation Type |POST | ++--------------------+--------------------------+ + + +Request Parameters: + ++-------------------+---------+-----------+-------+-------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=============================================================+ +|requestInfo |Y |1 |Object |The content of the RequestInfo object. | ++-------------------+---------+-----------+-------+-------------------------------------------------------------+ +|placementInfo |Y |1 |Object |The Content of the PlacementInfo object. | ++-------------------+---------+-----------+-------+-------------------------------------------------------------+ +|licenseInfo |N |1 |Object |The Content of the LicenseInfo object. | ++-------------------+---------+-----------+-------+-------------------------------------------------------------+ +|serviceInfo |Y |1 |Object |The Content of the ServiceInfo object. | ++-------------------+---------+-----------+-------+-------------------------------------------------------------+ + + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|transactionId |Y |1 |String |A unique ID to track an ONAP transaction. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|requestId |Y |1 |String |A unique ID to track multiple requests. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|callbackUrl |Y |1 |String |The end point of a callback service where recommendations are posted. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|callbackHeader |N |1 |String |The header information a client expecting in a async callback. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|sourceId |Y |1 |String |The unique ID of a client making an optimization call. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|requestType |Y |1 |String |The type of a request | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|numSolutions |N |1 |Integer|Expected number of solutions. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|optimizers |Y |1..N |List of Strings|A list of optimization services. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|timeout |N |1 |Integer|A tolerance window (in secs) for expecting solutions. Default is 600 secs.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + + +PlacementInfo Object + ++-------------------+---------+-----------+-------+-------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=============================================================+ +|requestParameters |C |1 |String |A JSON object conaining service and customer-specific data. A client or service designer is required to specify the parameters of interest for a given service and their location in the JSON blob through optimization query policies. This attribute is only required if a request contains service or customer-specific information.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|placementDemands |Y |1..N |List of PlacementDemand Object|The resource information for a placement service.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|subscriberInfo |N |1 |Object |The information of a service subscriber. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + +PlacementDemand Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|resourceModuleName |Y |1 |String |A resource name as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|tenantId |N |1 |String |A tenant Id as defined in the ordering system. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|resourceModelInfo |Y |1 |Object |Resource model information as defined in SDC. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|existingCandidates |N |1..N |List of Candidates Objects | The existing placement information of a resource. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|excludedCandidates |N |1..N |List of Candidates Objects |Candidates that need to be excluded from solutions.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|requiredCandidates |N |1..N |List of Candidates Objects |Candidates that must be included in solutions. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + + +SubscriberInfo Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|globalSubscriberId |Y |1 |String |An ID of a subscriber. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|subscriberName |Y |1.N |String |The name of a subscriber. If the name is not known, the value must be 'unknown'.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|subscriberCommonSiteId |N |1 |String |Id representing a subscriber location. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + +ModelMetaData Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|modelInvariantId |Y |1 |String |A model invariant Id as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|modelVersionId |Y |1 |String |A unique model Id as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|modelName |N |1 |String |A model name as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|modelType |N |1 |String |A model type as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|modelVersion |N |1 |String |A model version as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|modelCustomizationName |N |1 |String |A model customization name as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + + +Candidates Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|identifierType |Y |1 |String |The type of a candidate. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|identifiers |Y |1..N |List |A list of identifiers. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|cloudOwner |C |1 |String |The name of a cloud owner. Only required if identifierType is cloud_region_id.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + + +ServiceInfo Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|serviceInstanceId |Y |1 |String |A service instance id associated with a request. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|modelInfo |Y |1 |ModelMetaData Object |A list of identifiers. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|serviceName |Y |1 |String |The name of a service | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + +LicenseInfo Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|licenseDemands |Y |1..N |List of LicenseDemands Object |A list of resources for license selection. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + +LicenseDemand Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|resourceModuleName |Y |1 |String |A resource name as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|resourceModelInfo |Y |1 |ModelMetaData Object |Resource model information as defined in a service model.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|existingLicenses |N |1 |LicenseModel Object |Existing license information assigned to a resource. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + +LicenseModel Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|entitlementPoolUUID|Y |1..N |List |Entitlement pool UUIDs associated with a resource. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|licenseKeyGroupUUID|Y |1..N |List |License key groups associated with a resource. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + + +Response Body + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|requestId |Y |1 |String |A unique Id for an ONAP transaction. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|transactionId |Y |1 |String |A unique ID to track multiple requests associated with a transaction. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|statusMessage |N |1 |String |Reasoning if a requestStatus is failed. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|requestStatus |Y |1 |String |The status of a request. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
\ No newline at end of file diff --git a/docs/images/SO_1.png b/docs/images/SO_1.png Binary files differnew file mode 100644 index 0000000000..8e477acc46 --- /dev/null +++ b/docs/images/SO_1.png diff --git a/docs/images/SO_Architecture_1.png b/docs/images/SO_Architecture_1.png Binary files differindex a50c01bdd9..53836ffd8c 100644 --- a/docs/images/SO_Architecture_1.png +++ b/docs/images/SO_Architecture_1.png diff --git a/docs/images/SO_R1_1.png b/docs/images/SO_R1_1.png Binary files differdeleted file mode 100644 index 06d9eb3727..0000000000 --- a/docs/images/SO_R1_1.png +++ /dev/null diff --git a/docs/index.rst b/docs/index.rst index 9fd4cc3f97..86b6447017 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 Huawei Technologies Co., Ltd.
+.. Copyright 2018 Huawei Technologies Co., Ltd.
ONAP SO
========================================
diff --git a/docs/installation.rst b/docs/installation.rst index 07f534e1b3..cde26e021a 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,7 +1,7 @@ -.. _open_cli_schema_version_1_0: +.. _onap_so_schema_version_2_0: .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 Huawei Technologies Co., Ltd. +.. Copyright 2018 Huawei Technologies Co., Ltd. Install and Configure Service Orchestrator ========================================== diff --git a/docs/offered_consumed_apis.rst b/docs/offered_consumed_apis.rst index 8888c6437e..f18b5bdd60 100644 --- a/docs/offered_consumed_apis.rst +++ b/docs/offered_consumed_apis.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 Huawei Technologies Co., Ltd.
+.. Copyright 2018 Huawei Technologies Co., Ltd.
SO Offered and Consumed APIs
=====================================
@@ -12,4 +12,4 @@ All the Service Orchestrator APIs, both inward and outward are documented in the .. toctree::
:maxdepth: 1
- SO_R1_Interface.rst
+ SO_Interface.rst
diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 50bed2c553..b27b2a3eca 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 Huawei Intellectual Property. All rights reserved. +.. Copyright 2018 Huawei Intellectual Property. All rights reserved. Service Orchestrator Release Notes @@ -16,6 +16,7 @@ Version: 1.2.2 The Beijing release is the second release of the Service Orchestrator (SO) project. **New Features** + * Enhance Platform maturity by improving CLAMP maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Beijing+Release+Platform+Maturity>`_. * Manual scaling of network services and VNFs. * Homing and placement capabiliities through OOF interaction. @@ -24,18 +25,21 @@ The Beijing release is the second release of the Service Orchestrator (SO) proje * Integrated to OOF * Integrated to OOM -Bug Fixes ---------- -The defects fixed in this release could be found `here<https://jira.onap.org/issues/?jql=project%20%3D%20SO%20AND%20affectedVersion%20%3D%20%22Beijing%20Release%22%20AND%20status%20%3D%20Closed%20>`_. +**Bug Fixes** + + The defects fixed in this release could be found `here <https://jira.onap.org/issues/?jql=project%20%3D%20SO%20AND%20affectedVersion%20%3D%20%22Beijing%20Release%22%20AND%20status%20%3D%20Closed%20>`_. **Known Issues** - NA + + SO docker image is still on ecmop and not onap in the repository. + This will be addressed in the next release. **Security Notes** -SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377799>`_. + SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377799>`_. Quick Links: + - `SO project page <https://wiki.onap.org/display/DW/Service+Orchestrator+Project>`_ - `Passing Badge information for SO <https://bestpractices.coreinfrastructure.org/en/projects/1702>`_ - `Project Vulnerability Review Table for SO <https://wiki.onap.org/pages/viewpage.action?pageId=28377799>`_ |
