diff options
author | yangyan <yangyanyj@chinamobile.com> | 2018-03-27 16:18:43 +0800 |
---|---|---|
committer | yangyan <yangyanyj@chinamobile.com> | 2018-03-27 16:18:53 +0800 |
commit | cbb9954bb32cdd161ea39d8fd81bd5c93981d504 (patch) | |
tree | 43af27af2ac861e400471061746a61f7b3676d52 /docs/platform | |
parent | d4d1be38adec3ad158ad12bd956e36737695def4 (diff) |
Improve VF-C documnent
Issue-ID: VFC-828
Change-Id: Ibddfb5bf709567e8060c8c3363c1cb8d76920d98
Signed-off-by: yangyan <yangyanyj@chinamobile.com>
Diffstat (limited to 'docs/platform')
-rw-r--r-- | docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst | 1693 | ||||
-rw-r--r-- | docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst | 7 | ||||
-rw-r--r-- | docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst | 2 | ||||
-rw-r--r-- | docs/platform/APIs/index.rst | 8 | ||||
-rw-r--r-- | docs/platform/Auto-healing.png | bin | 0 -> 138954 bytes | |||
-rw-r--r-- | docs/platform/Instantiation.png | bin | 0 -> 260486 bytes | |||
-rw-r--r-- | docs/platform/Termination.png | bin | 0 -> 246810 bytes | |||
-rw-r--r-- | docs/platform/consumedapis.rst | 1 | ||||
-rw-r--r-- | docs/platform/delivery.rst | 44 |
9 files changed, 674 insertions, 1081 deletions
diff --git a/docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst b/docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst index 7188dc7f..6ed6196a 100644 --- a/docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst +++ b/docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst @@ -1,1086 +1,651 @@ Network services lifecycle management northbound APIs
-==========
-
- {
- "swagger": "2.0",
-
- "info": {
-
- "version": "1.0.0",
-
- "title": "ONAP VFC Network Service Lifecycle Management API",
-
- "description": "VFC Network Service Lifecycle Management Rest API.",
-
- "contact": {
-
- "name": "ONAP VFC team",
-
- "email": "onap-discuss@lists.onap.org",
-
- "url": "https://gerrit.onap.org/r/#/admin/projects/vfc/nfvo/lcm"
-
- }
-
- },
-
- "basePath": "/api/nslcm/v1",
-
- "schemes": [
-
- "http",
- "https"
-
- ],
-
- "consumes": [
-
- "application/json"
-
- ],
- "produces": [
-
- "application/json"
-
- ],
- "paths": {
-
- "/ns": {
-
- "post": {
-
- "tags": [
-
- "ns"
-
- ],
- "summary": "ns create",
-
- "description": "ns create",
-
- "operationId": "ns_create",
-
- "parameters": [
-
- {
-
- "in": "body",
-
- "name": "NSCreateRequest",
-
- "description": "NS Instance Create Request",
-
- "required": true,
-
- "schema": {
-
- "$ref": "#/definitions/NsCreateRequest"
-
- }
-
- }
-
- ],
-
- "responses": {
-
- "200": {
-
- "description": "successful operation",
-
- "schema": {
-
- "$ref": "#/definitions/NsCreateResponse"
-
- }
-
- }
-
- }
-
- },
-
- "get": {
-
- "tags": [
-
- "ns"
-
- ],
-
- "summary": "ns get",
-
- "description": "ns get",
-
- "operationId": "ns_get",
-
- "parameters": [],
-
- "responses": {
-
- "200": {
-
- "description": "successful operation",
-
- "schema": {
-
- "$ref": "#/definitions/NsInfo"
-
- }
-
- }
-
- }
-
- }
-
- },
-
- "/ns/{nsInstanceId}/Instantiate": {
-
- "post": {
-
- "tags": [
-
- "ns"
-
- ],
-
- "summary": "ns Instantiate",
-
- "description": "ns Instantiate",
-
- "operationId": "ns_Instantiate",
-
- "parameters": [
-
- {
- "required": true,
-
- "type": "string",
-
- "description": "",
-
- "name": "nsInstanceId",
-
- "in": "path"
-
- },
- {
-
- "in": "body",
-
- "name": "NSInstantiateRequest",
-
- "description": "NS Instantiate Request Body",
-
- "required": true,
-
- "schema": {
-
- "$ref": "#/definitions/NsInstantiateRequest"
-
- }
-
- }
-
- ],
-
- "responses": {
-
- "200": {
-
- "description": "",
-
- "schema": {
-
- "$ref": "#/definitions/JobInfo"
-
- }
-
- },
-
- "201": {
-
- "description": "Invalid Request"
-
- }
-
- }
-
- }
-
- },
-
- "/ns/{nsInstanceId}/scale": {
-
- "post": {
-
- "tags": [
-
- "ns"
-
- ],
-
- "summary": "ns scale",
-
- "description": "ns scale",
-
- "operationId": "ns_scale",
-
- "parameters": [
-
- {
-
- "required": true,
-
- "type": "string",
-
- "description": "",
-
- "name": "nsInstanceId",
-
- "in": "path"
-
- },
-
- {
-
- "in": "body",
-
- "name": "ScaleNSRequest",
-
- "description": "Scale NS Request Body",
-
- "required": true,
-
- "schema": {
-
- "$ref": "#/definitions/NsScaleRequest"
-
- }
-
- }
-
- ],
-
- "responses": {
-
- "200": {
-
- "description": "",
-
- "schema": {
-
- "$ref": "#/definitions/JobInfo"
-
- }
-
- },
-
- "201": {
-
- "description": "Invalid Request"
-
- }
-
- }
-
- }
-
- },
-
- "/ns/{ns_instance_id}/heal": {
-
- "post": {
-
- "tags": [
-
- "ns"
-
- ],
-
- "summary": "ns heal",
-
- "description": "ns heal",
-
- "operationId": "ns_heal",
-
- "parameters": [
-
- {
- "required": true,
-
- "type": "string",
-
- "description": "Identifier of the NS instance.",
-
- "name": "ns_instance_id",
-
- "in": "path"
-
- },
-
- {
-
- "in": "body",
-
- "name": "healVnfData",
-
- "description": "healVnfData",
-
- "required": true,
-
- "schema": {
-
- "$ref": "#/definitions/NsHealRequest"
-
- }
-
- }
-
- ],
-
- "responses": {
-
- "202": {
-
- "description": "",
-
- "schema": {
-
- "$ref": "#/definitions/JobInfo"
-
- }
-
- },
-
- "500": {
-
- "description": "the url is invalid"
-
- }
-
- }
-
- }
-
- },
-
- "/ns/{ns_instance_id}/terminate": {
-
- "post": {
-
- "tags": [
-
- "ns"
-
- ],
-
- "summary": "ns terminate",
-
- "description": "ns terminate",
-
- "operationId": "ns_terminate",
-
- "parameters": [
-
- {
-
- "required": true,
-
- "type": "string",
-
- "description": "Identifier of the NS instance.",
-
- "name": "ns_instance_id",
-
- "in": "path"
-
- },
-
- {
- "in": "body",
-
- "name": "NsTerminateRequest",
-
- "description": "NsTerminateRequest",
-
- "required": true,
-
- "schema": {
-
- "$ref": "#/definitions/NsTerminateRequest"
-
- }
-
- }
-
- ],
-
- "responses": {
-
- "202": {
-
- "description": "",
-
- "schema": {
-
- "$ref": "#/definitions/JobInfo"
-
- }
-
- },
-
- "500": {
-
- "description": "the url is invalid"
-
- }
-
- }
-
- }
-
- },
- "/ns/{ns_instance_id}": {
-
- "delete": {
-
- "tags": [
-
- "ns"
-
- ],
-
- "summary": "ns delete",
-
- "description": "ns delete",
-
- "operationId": "ns_delete",
-
- "parameters": [
-
- {
- "required": true,
-
- "type": "string",
-
- "description": "Identifier of the NS instance.",
-
- "name": "ns_instance_id",
-
- "in": "path"
-
- }
-
- ],
-
- "responses": {
-
- "204": {
-
- "description": "The NS instance resource and the associated NS identifier were deleted successfully."
-
- }
-
- }
-
- }
-
- },
-
- "/jobs/{jobId}": {
-
- "post": {
-
- "tags": [
-
- "job"
-
- ],
-
- "summary": "jobstatus",
-
- "description": "",
-
- "operationId": "jobstatus",
-
- "parameters": [
-
- {
- "required": true,
-
- "type": "string",
-
- "description": "",
-
- "name": "jobId",
-
- "in": "path"
-
- },
-
- {
-
- "in": "body",
-
- "name": "body",
-
- "description": "request param",
-
- "required": true,
-
+=====================================================
+
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "1.0.0",
+ "title": "ONAP VFC Network Service Lifecycle Management API",
+ "description": "VFC Network Service Lifecycle Management Rest API.",
+ "contact": {
+ "name": "ONAP VFC team",
+ "email": "onap-discuss@lists.onap.org",
+ "url": "https://gerrit.onap.org/r/#/admin/projects/vfc/nfvo/lcm"
+ }
+ },
+ "basePath": "/api/nslcm/v1",
+ "schemes": [
+ "http",
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/ns": {
+ "post": {
+ "tags": [
+ "ns"
+ ],
+ "summary": "ns create",
+ "description": "ns create",
+ "operationId": "ns_create",
+ "parameters": [
+ {
+ "in": "body",
+ "name": "NSCreateRequest",
+ "description": "NS Instance Create Request",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/NsCreateRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "successful operation",
+ "schema": {
+ "$ref": "#/definitions/NsCreateResponse"
+ }
+ },
+ "404": {
+ "description": "URL not found"
+ }
+ }
+ },
+ "get": {
+ "tags": [
+ "ns"
+ ],
+ "summary": "ns get",
+ "description": "ns get",
+ "operationId": "ns_instantces_get",
+ "parameters": [
+ {
+ "required": true,
+ "type": "string",
+ "description": "job response message id",
+ "name": "csarId",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "successful operation",
+ "schema": {
+ "$ref": "#/definitions/NsInstancesInfo"
+ }
+ },
+ "404": {
+ "description": "URL not found"
+ }
+ }
+ }
+ },
+ "/ns/{nsInstanceId}/Instantiate": {
+ "post": {
+ "tags": [
+ "ns"
+ ],
+ "summary": "ns Instantiate",
+ "description": "ns Instantiate",
+ "operationId": "ns_Instantiate",
+ "parameters": [
+ {
+ "required": true,
+ "type": "string",
+ "description": "",
+ "name": "nsInstanceId",
+ "in": "path"
+ },
+ {
+ "in": "body",
+ "name": "NSInstantiateRequest",
+ "description": "NS Instantiate Request Body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/NsInstantiateRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "schema": {
+ "$ref": "#/definitions/JobInfo"
+ }
+ },
+ "201": {
+ "description": "Invalid Request"
+ },
+ "404": {
+ "description": "URL not found"
+ }
+ }
+ }
+ },
+ "/ns/{nsInstanceId}/scale": {
+ "post": {
+ "tags": [
+ "ns"
+ ],
+ "summary": "ns scale",
+ "description": "ns scale",
+ "operationId": "ns_scale",
+ "parameters": [
+ {
+ "required": true,
+ "type": "string",
+ "description": "",
+ "name": "nsInstanceId",
+ "in": "path"
+ },
+ {
+ "in": "body",
+ "name": "ScaleNSRequest",
+ "description": "Scale NS Request Body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/NsScaleRequest"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "",
+ "schema": {
+ "$ref": "#/definitions/JobInfo"
+ }
+ },
+ "201": {
+ "description": "Invalid Request"
+ },
+ "404": {
+ "description": "URL not found"
+ }
+ }
+ }
+ },
+ "/ns/{nsInstanceId}/heal": {
+ "post": {
+ "tags": [
+ "ns"
+ ],
+ "summary": "ns heal",
+ "description": "ns heal",
+ "operationId": "ns_heal",
+ "parameters": [
+ {
+ "required": true,
+ "type": "string",
+ "description": "Identifier of the NS instance.",
+ "name": "nsInstanceId",
+ "in": "path"
+ },
+ {
+ "in": "body",
+ "name": "healVnfData",
+ "description": "healVnfData",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/NsHealRequest"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "",
+ "schema": {
+ "$ref": "#/definitions/JobInfo"
+ }
+ },
+ "404": {
+ "description": "URL not found"
+ },
+ "500": {
+ "description": "the url is invalid"
+ }
+ }
+ }
+ },
+ "/ns/{nsInstanceId}/terminate": {
+ "post": {
+ "tags": [
+ "ns"
+ ],
+ "summary": "ns terminate",
+ "description": "ns terminate",
+ "operationId": "ns_terminate",
+ "parameters": [
+ {
+ "required": true,
+ "type": "string",
+ "description": "Identifier of the NS instance.",
+ "name": "nsInstanceId",
+ "in": "path"
+ },
+ {
+ "in": "body",
+ "name": "NsTerminateRequest",
+ "description": "NsTerminateRequest",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/NsTerminateRequest"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "",
+ "schema": {
+ "$ref": "#/definitions/JobInfo"
+ }
+ },
+ "500": {
+ "description": "the url is invalid"
+ }
+ }
+ }
+ },
+ "/ns/{nsInstanceId}": {
+ "get": {
+ "tags": [
+ "ns"
+ ],
+ "summary": "ns get",
+ "description": "ns get",
+ "operationId": "ns_instance_get",
+ "parameters": [
+ {
+ "required": true,
+ "type": "string",
+ "description": "Identifier of the NS instance.",
+ "name": "nsInstanceId",
+ "in": "path"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "successful operation",
+ "schema": {
+ "$ref": "#/definitions/NsInstanceInfo"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "ns"
+ ],
+ "summary": "ns delete",
+ "description": "ns delete",
+ "operationId": "ns_delete",
+ "parameters": [
+ {
+ "required": true,
+ "type": "string",
+ "description": "Identifier of the NS instance.",
+ "name": "nsInstanceId",
+ "in": "path"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "The NS instance resource and the associated NS identifier were deleted successfully."
+ }
+ }
+ }
+ },
+ "/jobs/{jobId}": {
+ "get": {
+ "tags": [
+ "job"
+ ],
+ "summary": "jobstatus",
+ "description": "",
+ "operationId": "get_jobstatus",
+ "parameters": [
+ {
+ "required": true,
+ "type": "string",
+ "description": "job Id",
+ "name": "jobId",
+ "in": "path"
+ },
+ {
+ "required": true,
+ "type": "string",
+ "description": "job response message id",
+ "name": "responseId",
+ "in": "query"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "",
"schema": {
-
- "$ref": "#/definitions/JobProgressRequest"
-
- }
-
- }
-
- ],
-
- "responses": {
-
- "202": {
-
- "description": ""
-
- }
-
- }
-
- }
-
- }
-
- },
-
- "definitions": {
-
- "NsCreateRequest": {
-
- "type": "object",
-
- "properties": {
-
- "context":{
-
- "type": "object",
-
- "properties": {
-
+ "$ref": "#/definitions/JobDetailInfo"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "NsCreateRequest": {
+ "type": "object",
+ "properties": {
+ "context":{
+ "type": "object",
+ "properties": {
"globalCustomerId":{
-
"type": "string",
"description": "the global customer id"
-
},
-
"serviceType":{
"type": "string",
-
"description": "service type"
-
}
-
}
-
- },
-
- "csarId": {
-
- "type": "string",
-
- "description": "the NS package ID"
-
- },
-
- "nsName": {
-
- "type": "string"
-
- },
-
- "description": {
-
- "type": "string"
-
- }
-
- }
-
- },
-
- "NsCreateResponse": {
-
- "type": "object",
-
- "properties": {
-
- "nsInstanceId": {
-
- "type": "string"
-
- }
-
- }
-
- },
- "NsInstantiateRequest": {
-
- "type": "object",
-
- "properties": {
-
- "LocationConstraints": {
-
- "type": "array",
-
- "items": {
-
- "$ref": "#/definitions/LocationConstraint"
-
- }
-
- },
-
- "additionalParamForNs": {
-
- "type": "string"
-
- }
-
- }
-
- },
-
- "LocationConstraint": {
-
- "type": "object",
-
- "properties": {
-
- "vnfProfileId": {
-
- "type": "string"
-
- },
- "locationConstraints": {
-
- "type": "object",
-
- "properties": {
-
- "vimid": {
-
- "type": "string"
-
- }
-
- }
-
- }
-
- }
-
- },
-
- "NsScaleRequest": {
-
+ },
+ "csarId": {
+ "type": "string",
+ "description": "the NS package ID"
+ },
+ "nsName": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ }
+ }
+ },
+ "NsCreateResponse": {
+ "type": "object",
+ "properties": {
+ "nsInstanceId": {
+ "type": "string"
+ }
+ }
+ },
+ "NsInstantiateRequest": {
+ "type": "object",
+ "properties": {
+ "LocationConstraints": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LocationConstraint"
+ }
+ },
+ "additionalParamForNs": {
+ "type": "string"
+ }
+ }
+ },
+ "LocationConstraint": {
+ "type": "object",
+ "properties": {
+ "vnfProfileId": {
+ "type": "string"
+ },
+ "locationConstraints": {
+ "type": "object",
+ "properties": {
+ "vimid": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "NsScaleRequest": {
+ "type": "object",
+ "properties": {
+ "scaleType": {
+ "type": "string"
+ },
+ "scaleNsByStepsData": {
+ "$ref": "#/definitions/NsScaleByStepsData"
+ }
+ }
+ },
+ "NsScaleByStepsData": {
+ "type": "object",
+ "properties": {
+ "scalingDirection": {
+ "type": "string"
+ },
+ "aspectId": {
+ "type": "string"
+ },
+ "numberOfSteps": {
+ "type": "integer"
+ }
+ }
+ },
+ "NsHealRequest": {
+ "type": "object",
+ "properties": {
+ "vnfInstanceId": {
+ "type": "string"
+ },
+ "cause": {
+ "type": "string"
+ },
+ "additionalParams": {
+ "type": "object",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "actionvminfo": {
+ "type": "object",
+ "properties": {
+ "vmid": {
+ "type": "string"
+ },
+ "vmname": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "NsTerminateRequest": {
+ "type": "object",
+ "properties": {
+ "terminationType": {
+ "type": "string"
+ },
+ "gracefulTerminationTimeout": {
+ "type": "string"
+ }
+ }
+ },
+ "JobInfo": {
+ "type": "object",
+ "properties": {
+ "jobId": {
+ "type": "string"
+ }
+ }
+ },
+ "NsInstancesInfo":{
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NsInstanceInfo"
+ }
+ },
+ "NsInstanceInfo": {
+ "type": "object",
+ "properties": {
+ "nsInstanceId": {
+ "type": "string"
+ },
+ "nsName": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "nsdId": {
+ "type": "string"
+ },
+ "vnfInfo": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/vnfInfo"
+ }
+ },
+ "vlInfo": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/vlInfo"
+ }
+ },
+ "vnffgInfo": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/vnffgInfo"
+ }
+ },
+ "nsState": {
+ "type": "string"
+ }
+ }
+ },
+ "vnfInfo": {
+ "type": "object",
+ "properties": {
+ "vnfInstanceId": {
+ "type": "string"
+ },
+ "vnfInstanceName": {
+ "type": "string"
+ },
+ "vnfdId": {
+ "type": "string"
+ }
+ }
+ },
+ "vlInfo": {
+ "type": "object",
+ "properties": {
+ "vlInstanceId": {
+ "type": "string"
+ },
+ "vlInstanceName": {
+ "type": "string"
+ },
+ "vldId": {
+ "type": "string"
+ },
+ "relatedCpInstanceId": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/cpInfo"
+ }
+ }
+ }
+ },
+ "cpInfo": {
+ "type": "object",
+ "properties": {
+ "cpInstanceId": {
+ "type": "string"
+ },
+ "cpInstanceName": {
+ "type": "string"
+ },
+ "cpdId": {
+ "type": "string"
+ }
+ }
+ },
+ "vnffgInfo": {
+ "type": "object",
+ "properties": {
+ "vnffgInstanceId": {
+ "type": "string"
+ },
+ "vnfId": {
+ "type": "string"
+ },
+ "pnfId": {
+ "type": "string"
+ },
+ "virtualLinkId": {
+ "type": "string"
+ },
+ "cpId": {
+ "type": "string"
+ },
+ "nfp": {
+ "type": "string"
+ }
+ }
+ },
+ "jobResponseInfo": {
"type": "object",
-
"properties": {
-
- "scaleType": {
-
- "type": "string"
-
+ "status": {
+ "type": "string"
+ },
+ "progress":{
+ "type": "string"
},
-
- "scaleNsByStepsData": {
-
- "$ref": "#/definitions/NsScaleByStepsData"
-
- }
-
- }
-
- },
-
- "NsScaleByStepsData": {
-
- "type": "object",
-
- "properties": {
-
- "scalingDirection": {
-
- "type": "string"
-
+ "statusDescription": {
+ "type": "string"
},
-
- "aspectId": {
-
- "type": "string"
-
+ "errorCode": {
+ "type": "string"
},
-
- "numberOfSteps": {
-
- "type": "integer"
-
- }
-
+ "responseId": {
+ "type": "string"
+ }
}
-
- },
-
- "NsHealRequest": {
-
- "type": "object",
-
- "properties": {
-
- "vnfInstanceId": {
-
- "type": "string"
-
- },
-
- "cause": {
-
- "type": "string"
-
- },
-
- "additionalParams": {
-
- "type": "object",
-
- "properties": {
-
- "action": {
-
+ },
+ "JobDetailInfo":{
+ "type": "object",
+ "properties": {
+ "jobId": {
"type": "string"
-
},
-
- "actionvminfo": {
-
- "type": "object",
-
- "properties": {
-
- "vmid": {
-
- "type": "string"
-
- },
-
- "vmname": {
-
- "type": "string"
-
- }
-
- }
-
- }
-
+ "responseDescriptor":
+ {
+ "type":"object",
+ "properties": {
+ "status": {
+ "type": "string"
+ },
+ "progress":{
+ "type": "string"
+ },
+ "statusDescription": {
+ "type": "string"
+ },
+ "errorCode": {
+ "type": "string"
+ },
+ "responseId": {
+ "type": "string"
+ },
+ "responseHistoryList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/jobResponseInfo"
+ }
+ }
+ }
}
-
- }
-
- }
-
- },
-
- "NsTerminateRequest": {
-
- "type": "object",
-
- "properties": {
-
- "terminationType": {
-
- "type": "string"
-
- },
-
- "gracefulTerminationTimeout": {
-
- "type": "string"
-
- }
-
- }
-
- },
-
- "JobInfo": {
-
- "type": "object",
-
- "properties": {
-
- "jobId": {
-
- "type": "string"
-
- }
-
- }
-
- },
-
- "JobProgressRequest": {
-
- "type": "object",
-
- "properties": {
-
- "progress": {
-
- "type": "string"
-
- },
-
- "desc": {
-
- "type": "string"
-
- },
-
- "errcode": {
-
- "type": "string"
-
- }
-
- }
-
- },
-
- "NsInfo": {
-
- "type": "object",
-
- "properties": {
-
- "nsInstanceId": {
-
- "type": "string"
-
- },
-
- "nsName": {
-
- "type": "string"
-
- },
-
- "description": {
-
- "type": "string"
-
- },
-
- "nsdId": {
-
- "type": "string"
-
- },
-
- "vnfInfo": {
-
- "type": "array",
-
- "items": {
-
- "$ref": "#/definitions/vnfInfo"
-
- }
-
- },
-
- "vlInfo": {
-
- "type": "array",
-
- "items": {
-
- "$ref": "#/definitions/vlInfo"
-
- }
-
- },
-
- "vnffgInfo": {
-
- "type": "array",
-
- "items": {
-
- "$ref": "#/definitions/vnffgInfo"
-
- }
-
- },
-
- "nsState": {
-
- "type": "string"
-
- }
-
- }
-
- },
-
- "vnfInfo": {
-
- "type": "object",
-
- "properties": {
-
- "vnfInstanceId": {
-
- "type": "string"
-
- },
-
- "vnfInstanceName": {
-
- "type": "string"
-
- },
-
- "vnfdId": {
-
- "type": "string"
-
- }
-
- }
-
- },
-
- "vlInfo": {
-
- "type": "object",
-
- "properties": {
-
- "vlInstanceId": {
-
- "type": "string"
-
- },
-
- "vlInstanceName": {
-
- "type": "string"
-
- },
-
- "vldId": {
-
- "type": "string"
-
- },
-
- "relatedCpInstanceId": {
-
- "type": "array",
-
- "items": {
-
- "$ref": "#/definitions/cpInfo"
-
- }
-
- }
-
- }
-
- },
-
- "cpInfo": {
-
- "type": "object",
-
- "properties": {
-
- "cpInstanceId": {
-
- "type": "string"
-
- },
-
- "cpInstanceName": {
-
- "type": "string"
-
- },
-
- "cpdId": {
-
- "type": "string"
-
- }
-
- }
-
- },
- "vnffgInfo": {
-
- "type": "object",
-
- "properties": {
-
- "vnffgInstanceId": {
-
- "type": "string"
-
- },
-
- "vnfId": {
-
- "type": "string"
-
- },
- "pnfId": {
-
- "type": "string"
-
- },
-
- "virtualLinkId": {
-
- "type": "string"
-
- },
-
- "cpId": {
-
- "type": "string"
-
- },
-
- "nfp": {
-
- "type": "string"
-
- }
-
- }
-
- }
-
- }
-
- }
\ No newline at end of file + }
+ }
+ }
+}
\ No newline at end of file diff --git a/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst b/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst index 8d9cff6a..c5c63c85 100644 --- a/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst +++ b/docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst @@ -8,8 +8,9 @@ **1 Scope**
=============
- The scope of the present document is to describe the GVNFM exposed
- API specification over Or-Vnfm reference point and Ve-Vnfm-vnf reference point.
+The scope of the present document is to describe the GVNFM exposed API specification over Or-Vnfm reference point and Ve-Vnfm-vnf reference point.
+Some content has been updated, about the API Swagger definition, you can find here 'GVNFM_LCM_APIs<https://gerrit.onap.org/r/gitweb?p=vfc/gvnfm/vnflcm.git;a=blob;f=lcm/lcm/swagger/swagger.json;h=f098d282927d3535f5e9e6950f26b9171e04d30c;hb=HEAD>'.
+
**2 Terms, Definitions and Abbreviations**
===========================================
@@ -1681,4 +1682,4 @@ Table 2-1 abbreviations .. |image0| image:: VNFM_API.png
:width: 5.07047in
- :height: 5.6320
\ No newline at end of file + :height: 5.6320in
\ No newline at end of file diff --git a/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst b/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst index c289626d..a88e29e0 100644 --- a/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst +++ b/docs/platform/APIs/VNFMDriver_API/VNFM_Driver_API.rst @@ -8,6 +8,8 @@ **1. Scope**
==============
The scope of the present document is to describe the VNFM driver integrated related API specification.
+Some content has been updated, about the API Swagger definition, you can find here 'VNFM driver development related API<https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob;f=lcm/swagger/vfc.vnfdriver.swagger.json;h=fc35adbdc75df1307ca2c43a11bfb472da2a27c6;hb=HEAD>'
+
**2. Terms, Definitions and Abbreviations**
=============================================
diff --git a/docs/platform/APIs/index.rst b/docs/platform/APIs/index.rst index c6f561be..816bad25 100644 --- a/docs/platform/APIs/index.rst +++ b/docs/platform/APIs/index.rst @@ -3,12 +3,12 @@ VF-C Offered APIs -================= +================== List VF-C APIs offered. VFC Northbound API ----------- +------------------ Network services lifecycle management APIs @@ -20,7 +20,7 @@ Network services lifecycle management APIs VNFM Integration APIs ---------------- +--------------------- VNFM Driver Integration Related APIs @@ -32,7 +32,7 @@ VNFM Driver Integration Related APIs GVNFM Northbound & Southbound APIs ------------ +---------------------------------- GVNFM Northbound & Southbound APIs for VNF Integration diff --git a/docs/platform/Auto-healing.png b/docs/platform/Auto-healing.png Binary files differnew file mode 100644 index 00000000..6ebb8910 --- /dev/null +++ b/docs/platform/Auto-healing.png diff --git a/docs/platform/Instantiation.png b/docs/platform/Instantiation.png Binary files differnew file mode 100644 index 00000000..b26347ca --- /dev/null +++ b/docs/platform/Instantiation.png diff --git a/docs/platform/Termination.png b/docs/platform/Termination.png Binary files differnew file mode 100644 index 00000000..311d78a4 --- /dev/null +++ b/docs/platform/Termination.png diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst index 2aef466e..08439551 100644 --- a/docs/platform/consumedapis.rst +++ b/docs/platform/consumedapis.rst @@ -10,6 +10,7 @@ References to APIs offered by other components - DCAE: Use DCAE Ves collector API to report FCAPS data to DCAE - MSB: Use MSB to register and find microservice - Modeling: Use nfvparser API to parse tosca template + - Multicloud: Use Multicloud API to CRUD virtual resource diff --git a/docs/platform/delivery.rst b/docs/platform/delivery.rst index 13d1e0f8..5f717146 100644 --- a/docs/platform/delivery.rst +++ b/docs/platform/delivery.rst @@ -6,23 +6,21 @@ VF-C includes the following components in R1. .. |image0| image:: components.png :width: 5.97047in - :height: 5.63208in + :height: 4.63208in VF-C includes several components in ONAP R1. -Catalog is used to store the package distributed by SDC, it is a runtime catalog. - -Workflow include two micro service, one is workflow manage service and the other is workflow-activiti engine service, this two service will onboard workflow to workflow engine and parse workflow. +* Catalog is used to store the package distributed by SDC, it is a runtime catalog. +* Workflow include two micro service, one is workflow manage service and the other is workflow-activiti engine service, this two service will onboard workflow to workflow engine and parse workflow. -For NS lifecycle manager,it mainly completes the NS lifecycle management,such as NS Instantiation/termination and auto-healing. +* For NS lifecycle manager,it mainly completes the NS lifecycle management,such as NS Instantiation/termination and auto-healing. -For Resource manager, it will communicate with NS lifecycle manager to update instance data to A&AI. +* For Resource manager, it will communicate with NS lifecycle manager to update instance data to A&AI. -In VF-C southbound, it includes Gvnfmdriver and SVNFM driver which will interact with GVNFM and Vendor VNFM respectively to execute VNF lifecycle management, -VF-C provides vnfm driver northbound api,then Vendor can implement this APIs to integrate with VF-C. +* In VF-C southbound, it includes Gvnfmdriver and SVNFM driver which will interact with GVNFM and Vendor VNFM respectively to execute VNF lifecycle management,VF-C provides vnfm driver northbound api,then Vendor can implement this APIs to integrate with VF-C. -For the EMS driver,it can collect VNF lay’s Fcaps data from Vendor EMS, and then translate and put these data to DCAE Vescollector +* For the EMS driver,it can collect VNF lay’s Fcaps data from Vendor EMS, and then translate and put these data to DCAE Vescollector For the Amsterdam release, VF-C includes the following components: @@ -44,4 +42,30 @@ GVNFM - vfc-gvnfm-vnfres Workflow - workflow-engine-mgr-service - - activiti-extension
\ No newline at end of file + - activiti-extension + +VF-C support VolTE use case in R1 and R2, following are the vVoLTE releated Workflow in VF-C. + +* VoLTE Use Case Instantiation In VF-C + +|image1| + +.. |image1| image:: Instantiation.png + :width: 5.97047in + :height: 5.63208in + +* VoLTE Use Case Termination in VF-C + +|image2| + +.. |image2| image:: Termination.png + :width: 5.97047in + :height: 5.63208in + +* VoLTE Use Case Auto-healing in VF-C + +|image3| + +.. |image3| image:: Auto-healing.png + :width: 5.97047in + :height: 5.63208in
\ No newline at end of file |