diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/SO_R1_Interface.rst | 114 | ||||
| -rw-r--r-- | docs/release-notes.rst | 53 |
2 files changed, 120 insertions, 47 deletions
diff --git a/docs/SO_R1_Interface.rst b/docs/SO_R1_Interface.rst index df68005d80..8346e2b98c 100644 --- a/docs/SO_R1_Interface.rst +++ b/docs/SO_R1_Interface.rst @@ -197,6 +197,7 @@ Platform Object +-------------------------+------------------+-------------------------------------------------+ LineOfBusiness Object + +-------------------------+------------------+-------------------------------------------------+ |Attribute |Content |Description | +=========================+==================+=================================================+ @@ -1025,7 +1026,7 @@ Request Object +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |Attribute |Qualifier|Cardinality|Content |Description | +===================+=========+===========+==========================+===========================================+ -|requestId |M |1 |String |Request Id | +|requestId |M |1 |String |Request Id. | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |startTime |M |1 |request Object |Start time. | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ @@ -1767,50 +1768,37 @@ Request Body: Service Object -+----------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+================+==================+=================================================+ -|name |String |Service instance name. | -+----------------+------------------+-------------------------------------------------+ -|description |String |Service instance description | -+----------------+------------------+-------------------------------------------------+ -|serviceDef ID |String |The service invariantUUID. It is defined in SDC. | -+----------------+------------------+-------------------------------------------------+ -|templateId |String |The service Template UUID. It is defined in SDC. | -+----------------+------------------+-------------------------------------------------+ -|parameters |Parameter Object |Parameter Object | -+----------------+------------------+-------------------------------------------------+ - -Parameter Object - -+----------------------+------------------+-----------------------------------------------------+ -|Attribute |Content |Description | -+======================+==================+=====================================================+ -|globalSubscriberId |String |The subscriber id. It is defined in AAI | -+----------------------+------------------+-----------------------------------------------------+ -|subscriberName |String |The subscriber name. It is defined in AAI | -+----------------------+------------------+-----------------------------------------------------+ -|serviceType |String |The service type. It is defined in AAI | -+----------------------+------------------+-----------------------------------------------------+ -|templateName |String |The service Template name | -+----------------------+------------------+-----------------------------------------------------+ -|resources |Object |This field manages parameters of resources | -+----------------------+------------------+-----------------------------------------------------+ -|resourceName |String |The resource name | -+----------------------+------------------+-----------------------------------------------------+ -|resouceDefId |String |The resource invariantUUID. It is defined in SDC. | -+----------------------+------------------+-----------------------------------------------------+ -|resourceId |String |The resource UUID. It is defined in SDC. | -+----------------------+------------------+-----------------------------------------------------+ -|nsParameters |String |Parameters for current resource object. | -+----------------------+------------------+-----------------------------------------------------+ -|locationConstraints |String |The DC location info for each VNF of current service | -+----------------------+------------------+-----------------------------------------------------+ -|vnfProfileId |String |VNFD id | -+----------------------+------------------+-----------------------------------------------------+ -|additionalParamForNs |String |The parameter for current resource | -+----------------------+------------------+-----------------------------------------------------+ - ++------------------------------+-----------------+------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+====================================+ +|modelName |String |Service instance name. | ++------------------------------+-----------------+------------------------------------+ +|description |String |Service instance description | ++------------------------------+-----------------+------------------------------------+ +|modelUUID |String |Model UUID | ++------------------------------+-----------------+------------------------------------+ +|modelInvariantUUID |String |Model Invariant UUID | ++------------------------------+-----------------+------------------------------------+ +|created |Timestamp |Cretaed Timestamp | ++------------------------------+-----------------+------------------------------------+ +|toscaCsarArtifactUUID |String |tosca Csar Artifact UUID | ++------------------------------+-----------------+------------------------------------+ +|modelVersion |String |Model Version | ++------------------------------+-----------------+------------------------------------+ +|category |String |category | ++------------------------------+-----------------+------------------------------------+ +|serviceType |String |service Type | ++------------------------------+-----------------+------------------------------------+ +|serviceRole |String |service Role | ++------------------------------+-----------------+------------------------------------+ +|environmentContext |String |environment Context | ++------------------------------+-----------------+------------------------------------+ +|workloadContext |String |workload Context | ++------------------------------+-----------------+------------------------------------+ +|recipes |Object |recipes | ++------------------------------+-----------------+------------------------------------+ +|serviceResourceCustomizations |Object |serviceResourceCustomizations | ++------------------------------+-----------------+------------------------------------+ Response: @@ -1983,6 +1971,10 @@ Request Parameters: +-------------------+---------+-----------+-------+-----------------------+ |service-type |M |1 |String |Service Type | +-------------------+---------+-----------+-------+-----------------------+ +|subscriber-name |O |1 |String |Subscriber name | ++-------------------+---------+-----------+-------+-----------------------+ +|subscriber-type |O |1 |String |Subscriber type | ++-------------------+---------+-----------+-------+-----------------------+ Response: @@ -2568,7 +2560,7 @@ https://developer.openstack.org/api-ref/compute/#create-server +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |Interface Definition|Description | +====================+=======================================================================================================================+ -|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers | +|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.37/{tenant_id}/servers | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |Operation Type |POST | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ @@ -2652,6 +2644,8 @@ Response: +-------------------------+------------------+------------------------------------------------------------------------------+ |Attribute |Content |Description | +=========================+==================+==============================================================================+ +|Location |String |The location URL of the server. | ++-------------------------+------------------+------------------------------------------------------------------------------+ |server |object |A server object. | +-------------------------+------------------+------------------------------------------------------------------------------+ |id |String |The UUID of the server. | @@ -2820,6 +2814,10 @@ Request Body: +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |description |O |1 |string |A human-readable description for the resource. | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ +|is_default |O |1 |boolean |The network is default or not. | ++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ +|availability_zone_hints |O |1 |array |The availability zone candidate for the network. | ++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ Response: @@ -2834,10 +2832,16 @@ Response: +-----------------------------+------------------+------------------------------------------------------------------------------+ |availability_zones |array |The availability zone for the network. | +-----------------------------+------------------+------------------------------------------------------------------------------+ +|created_at |String |Time at which the resource has been created (in UTC ISO8601 format). | ++-----------------------------+------------------+------------------------------------------------------------------------------+ |dns_domain |String |A valid DNS domain. | +-----------------------------+------------------+------------------------------------------------------------------------------+ |id |String |The ID of the network. | +-----------------------------+------------------+------------------------------------------------------------------------------+ +|ipv4_address_scope |String |The ID of the IPv4 address scope that the network is associated with. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|ipv6_address_scope |String |The ID of the IPv6 address scope that the network is associated with. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ |mtu |integer |The maximum transmission unit (MTU) value to address fragmentation. | +-----------------------------+------------------+------------------------------------------------------------------------------+ |name |String |Human-readable name of the network. | @@ -2868,10 +2872,14 @@ Response: +-----------------------------+------------------+------------------------------------------------------------------------------+ |tenant_id |String |The ID of the project. | +-----------------------------+------------------+------------------------------------------------------------------------------+ +|updated_at |String |Time at which the resource has been updated (in UTC ISO8601 format). | ++-----------------------------+------------------+------------------------------------------------------------------------------+ |vlan_transparent |boolean |Indicates the VLAN transparency mode of the network. | +-----------------------------+------------------+------------------------------------------------------------------------------+ |description |String |A human-readable description for the resource. | +-----------------------------+------------------+------------------------------------------------------------------------------+ +|is_default |boolean |The network is default pool or not. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ Delete Network +++++++++++++++ @@ -2893,7 +2901,7 @@ Request Body: +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |Attribute |Qualifier|Cardinality|Content |Description | +============================+=========+===========+==========================+==============================================================+ -|network_id |M |1 |Object |The ID of the network. | +|network_id |M |1 |String |The ID of the network. | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ Create Subnet @@ -2952,6 +2960,8 @@ Request Body: +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |use_default_subnetpool |O |1 |boolean |Whether to allocate this subnet from the default subnet pool. | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ +|service_types |O |1 |array |The service types associated with the subnet. | ++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ Response: @@ -3082,6 +3092,8 @@ Request Body: +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |project_id |O |1 |string |The ID of the project that owns the resource. | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ +|qos_policy_id |O |1 |string |QoS policy associated with the port. | ++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |security_groups |O |1 |array |The IDs of security groups applied to the port. | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |tenant_id |O |1 |string |The ID of the project that owns the resource. | @@ -3130,6 +3142,8 @@ Response: +-----------------------------+------------------+------------------------------------------------------------------------------+ |id |string |The ID of the resource. | +-----------------------------+------------------+------------------------------------------------------------------------------+ +|ip_allocation |string |Indicates when ports use either deferred, immediate or no IP allocation (none)| ++-----------------------------+------------------+------------------------------------------------------------------------------+ |mac_address |string |The MAC address of the port. | +-----------------------------+------------------+------------------------------------------------------------------------------+ |name |string |Human-readable name of the resource. | @@ -3142,6 +3156,8 @@ Response: +-----------------------------+------------------+------------------------------------------------------------------------------+ |revision_number |integer |The revision number of the resource. | +-----------------------------+------------------+------------------------------------------------------------------------------+ +|qos_policy_id |string |The ID of the QoS policy associated with the port. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ |security_groups |array |The IDs of security groups applied to the port. | +-----------------------------+------------------+------------------------------------------------------------------------------+ |status |string |The port status. Values are ACTIVE, DOWN, BUILD and ERROR. | @@ -3218,6 +3234,10 @@ Response: +-----------------------------+------------------+------------------------------------------------------------------------------+ |project_id |string |The ID of the project. | +-----------------------------+------------------+------------------------------------------------------------------------------+ +|created_at |string |Time at which the resource has been created (in UTC ISO8601 format). | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|updated_at |string |Time at which the resource has been updated (in UTC ISO8601 format). | ++-----------------------------+------------------+------------------------------------------------------------------------------+ |revision_number |integer |The revision number of the resource. | +-----------------------------+------------------+------------------------------------------------------------------------------+ |name |string |Human-readable name of the resource. | diff --git a/docs/release-notes.rst b/docs/release-notes.rst index a806fe3e9b..f05f9ce938 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -8,6 +8,59 @@ Service Orchestrator Release Notes The SO provides the highest level of service orchestration in the ONAP architecture. +Version: 1.2.2 +-------------- + +:Release Date: 2018-05-24 + +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. +* Ability to perform change management. +* Integrated to APPC +* 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>`_. + +**Known Issues** + +**Security Issues** +SO CII Badging details can be found `here<https://bestpractices.coreinfrastructure.org/en/projects/1702>`_. +The remaining security issues and their workarounds are captured `here <https://wiki.onap.org/pages/viewpage.action?pageId=28377799>`_. + +**Upgrade Notes** + +**Deprecation Notes** + + +Version: 1.1.2 +-------------- + +:Release Date: 2018-01-18 + +Bug Fixes +--------- +The key defects fixed in this release : + +- `SO-344 <https://jira.onap.org/browse/SO-344>`_ + Only pass one VNF to DoCreateVnfAndModules. + +- `SO-348 <https://jira.onap.org/browse/SO-348>`_ + Json Analyze Exception in PreProcessRequest. + +- `SO-352 <https://jira.onap.org/browse/SO-352>`_ + SO failed to create VNF - with error message: Internal Error Occurred in CreateVnfInfra QueryCatalogDB Process. + +- `SO-354 <https://jira.onap.org/browse/SO-354>`_ + Change the Service Type And Service Role + + Version: 1.1.1 -------------- |