cirros_vnfd
Vendor: OSM
Version: 1.0
Description: Simple VNF example with a cirros
VM Count: 1
vCPU Count: 1
Memory: 512 MB
Storage: 1 GB
", + "certified": false, + "certifiedBy": null, + "validationStatus": "UNDER_REVIEW", + "packagingFormat": "OSMvFIVE", + "supportedMANOPlatforms": [ + { + "id": 1, + "name": "osm fivee", + "version": "osm fivee", + "description": "osm five" + } + ], + "vxfOnBoardedDescriptors": [], + "vfimagesVDU": [ + { + "id": 1, + "name": "cirros034", + "uuid": "d4549610-8abd-42ad-97f4-0a64e1c93977", + "shortDescription": "Automatically created during vxf cirros_vnfd submission. Owner must update.", + "packageLocation": null, + "publicURL": null, + "dateCreated": 1568971426000, + "dateUpdated": null, + "refVxFs": [ + { + "id": 1, + "name": "cirros_vnfd" + } + ], + "owner": { + "id": 1, + "organization": "ee", + "name": "Portal Administrator", + "email": "", + "username": "admin", + "active": true, + "currentSessionID": null, + "apikey": "e41c1cc4-aa56-4b7e-9f4d-64589549d768", + "createdAt": 1568711859000, + "roles": [ + "ADMIN", + "MENTOR" + ] + }, + "published": false, + "termsOfUse": null, + "deployedInfrastructures": [] + } + ] + }, + { + "id": 2, + "owner": { + "id": 1, + "organization": "ee", + "name": "Portal Administrator", + "email": "", + "username": "admin", + "createdAt": null + }, + "uuid": "4ab80095-a63e-4fe7-8598-e1c7e880706e", + "name": "cirros_sriov_vnfd", + "iconsrc": null, + "shortDescription": "cirros_sriov_vnf", + "longDescription": "Simple VNF example with a cirros SRIOV interface", + "version": "1.0", + "packageLocation": "/osapi/packages/4ab80095-a63e-4fe7-8598-e1c7e880706e/cirros_sriov.tar.gz", + "dateCreated": 1568971740000, + "dateUpdated": 1568981100000, + "categories": [ + { + "id": 4, + "name": "tyu", + "productsCount": 1, + "appscount": 0, + "vxFscount": 1 + }, + { + "id": 5, + "name": "tyi", + "productsCount": 1, + "appscount": 0, + "vxFscount": 1 + } + ], + "extensions": [], + "validationJobs": [], + "screenshots": "", + "vendor": "OSM", + "published": false, + "termsOfUse": null, + "descriptor": "vnfd:vnfd-catalog:\n vnfd:\n - connection-point:\n - name: eth0\n type: VPORT\n - name: eth1\n type: VPORT\n description: Simple VNF example with a cirros SRIOV interface\n id: cirros_sriov_vnfd\n logo: cirros-64.png\n mgmt-interface:\n cp: eth0\n name: cirros_sriov_vnf\n short-name: cirros_sriov_vnf\n vdu:\n - count: 1\n description: cirros_sriov_vnfd-VM\n guest-epa:\n cpu-pinning-policy: DEDICATED\n cpu-thread-pinning-policy: PREFER\n mempage-size: SMALL\n numa-node-policy:\n mem-policy: STRICT\n node:\n - id: '1'\n node-cnt: '1'\n id: cirros_sriov_vnfd-VM\n image: cirros-0.3.6-x86_64\n interface:\n - external-connection-point-ref: eth0\n name: eth0\n position: '1'\n type: EXTERNAL\n virtual-interface:\n bandwidth: '0'\n type: VIRTIO\n vpci: 0000:00:0a.0\n - external-connection-point-ref: eth1\n name: eth1\n position: '2'\n type: EXTERNAL\n virtual-interface:\n type: SR-IOV\n name: cirros_sriov_vnfd-VM\n vm-flavor:\n memory-mb: 4096\n storage-gb: 10\n vcpu-count: 4\n vendor: OSM\n version: '1.0'\n", + "descriptorHTML": "
cirros_sriov_vnf
Vendor: OSM
Version: 1.0
Description: Simple VNF example with a cirros SRIOV interface
VM Count: 1
vCPU Count: 1
Memory: 4096 MB
Storage: 10 GB
", + "certified": false, + "certifiedBy": null, + "validationStatus": "UNDER_REVIEW", + "packagingFormat": "OSMvFIVE", + "supportedMANOPlatforms": [ + { + "id": 1, + "name": "osm fivee", + "version": "osm fivee", + "description": "osm five" + } + ], + "vxfOnBoardedDescriptors": [], + "vfimagesVDU": [ + { + "id": 2, + "name": "cirros-0.3.6-x86_64", + "uuid": "be121176-1d62-4a1b-a3c1-7dce2e069d22", + "shortDescription": "Automatically created during vxf cirros_sriov_vnfd submission. Owner must update.", + "packageLocation": null, + "publicURL": null, + "dateCreated": 1568971740000, + "dateUpdated": null, + "refVxFs": [ + { + "id": 2, + "name": "cirros_sriov_vnfd" + } + ], + "owner": { + "id": 1, + "organization": "ee", + "name": "Portal Administrator", + "email": "", + "username": "admin", + "active": true, + "currentSessionID": null, + "apikey": "e41c1cc4-aa56-4b7e-9f4d-64589549d768", + "createdAt": 1568711859000, + "roles": [ + "ROLE_ADMIN", + "ROLE_MENTOR" + ] + }, + "published": false, + "termsOfUse": null, + "deployedInfrastructures": [] + } + ] + } +] +``` + + diff --git a/doc/architecture/nfvweb.md b/doc/architecture/nfvweb.md new file mode 100644 index 0000000000000000000000000000000000000000..b96dee34a9662e14f4c5eb3f41f507817686b094 --- /dev/null +++ b/doc/architecture/nfvweb.md @@ -0,0 +1,11 @@ +# Openslice NFV Web Portal + +The [NFV Web Portal](http://portal.openslice.io/nfvportal) offers a domain-specific UI to manage NFV Services. + +Indicatively, the portal can be used to: +- Register new a new MANO provider (e.g. OSM) +- Synchronize the onboarded VNF/NS packages, and the VIMs of the registered MANO provider +- Onboard/Delete VNF/NS packages on specific MANO provider +- Deploy a NS to a target MANO provider + +More information can be found at [NFV Services](../nfvcatalogs.md). \ No newline at end of file diff --git a/doc/architecture/oauth.md b/doc/architecture/oauth.md new file mode 100644 index 0000000000000000000000000000000000000000..e836842620424d03e68971f2406eba6d11269d7c --- /dev/null +++ b/doc/architecture/oauth.md @@ -0,0 +1,35 @@ +# Authentication Server + +Authentication is based on oAuth2. Our authentication service is a Keycloak server which is deployed with Openslice deployment + +API users needs to authenticate. +All APIs (except grant token request) must include Bearer token in request Authorization header. + + + +##OAuth token + +Get first an oauth token, using your username and password. +``` +curl -X POST http://portal.openslice.io/auth/realms/openslice/protocol/openid-connect/token -H 'Content-Type: application/x-www-form-urlencoded' -d 'username=demouser' -d 'password=demouser' -d 'grant_type=password' -d 'client_id=osapiWebClientId' +``` +response: + +``` + {"access_token":"eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJHZFRjQnpxczg2VW10NTRVZV8ybTJyWHJkV3dzaWdSZE9EUldMYm1memNvIn0.eyJleHAiOjE1ODgyNDA1NzAsImlhdCI6MTU4ODI0MDI3MCwianRpIjoiOGI2ZTU0NWUtNDIyYy00NzFiLWEwN2UtYTUzYzY1NDQ0MzZmIiwiaXNzIjoiaHR0cDovL3BvcnRhbC5vcGVuc2xpY2UuaW8vYXV0aC9yZWFsbXMvb3BlbnNsaWNlIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImExYTI3NjVhLWVjODMtNDQ1Ni1iN2IyLTIwNzMxOTg2ZTAzNSIsInR5cCI6IkJlYXJlciIsImF6cCI6Im9zYXBpV2ViQ2xpZW50SWQiLCJzZXNzaW9uX3N0YXRlIjoiMzM1MGY0OTMtNjYyNy00MzczLTg1NDQtZGVmZDI3YWQzYzc0IiwiYWNyIjoiMSIsImFsbG93ZWQtb3JpZ2lucyI6WyJodHRwOi8vbG9jYWxob3N0OjEzMDgyIiwiaHR0cDovL2xvY2FsaG9zdCIsImh0dHA6Ly9vcGVuc2xpY2UuaW8iLCJodHRwOi8vbG9jYWxob3N0OjEzMDAwIiwiaHR0cDovL2xvY2FsaG9zdDo0MjAwIiwiaHR0cDovL3BvcnRhbC5vcGVuc2xpY2UuaW8iXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIk5GVl9ERVZFTE9QRVIiLCJvZmZsaW5lX2FjY2VzcyIsInVtYV9hdXRob3JpemF0aW9uIiwiRVhQRVJJTUVOVEVSIiwiVVNFUiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoicHJvZmlsZSBlbWFpbCIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJkZW1vdXNlciJ9.TnzzpRLMD94UTKpT5_wkr1h4_3KUQmr4TGvFLpJ7cZx-Klrv8tB_eRkWnPqqzCAM9G21a1qXboL8MLMW8ECzG7HYKpobKOGr7LSczMOTdA2ZDyBCRUSOdW77pchu54tJ0ITEkFaDwSKMKKt04V_Sy4U-eIndj0XzzRlkDolWDnK4Z2lRaXAI6fMwOKx1Toa6RfOcemxtzl3pdtjPx92zo6MaKlbIqHK82lxdK0k8aQQaT6TmIrXbZKV2dU_1d3O0q0dVUEZJ_1kzwqOFkmxr9w0EnndC6ccYJlDAr_-GgUhhhNOn5v6tjYLUQdj5e4KEAsxIPzaCreK4un7mEAPmDw","expires_in":300,"refresh_expires_in":1800,"refresh_token":"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZjUxMDk5Yy0wNTIzLTRjNGQtODM0Zi1iNDc0YzBjOTA1MzkifQ.eyJleHAiOjE1ODgyNDIwNzAsImlhdCI6MTU4ODI0MDI3MCwianRpIjoiZmViOTg5NWEtOTY5ZS00MzIzLWJjY2QtZTY2YzQ0NGE1MzJlIiwiaXNzIjoiaHR0cDovL3BvcnRhbC5vcGVuc2xpY2UuaW8vYXV0aC9yZWFsbXMvb3BlbnNsaWNlIiwiYXVkIjoiaHR0cDovL3BvcnRhbC5vcGVuc2xpY2UuaW8vYXV0aC9yZWFsbXMvb3BlbnNsaWNlIiwic3ViIjoiYTFhMjc2NWEtZWM4My00NDU2LWI3YjItMjA3MzE5ODZlMDM1IiwidHlwIjoiUmVmcmVzaCIsImF6cCI6Im9zYXBpV2ViQ2xpZW50SWQiLCJzZXNzaW9uX3N0YXRlIjoiMzM1MGY0OTMtNjYyNy00MzczLTg1NDQtZGVmZDI3YWQzYzc0Iiwic2NvcGUiOiJwcm9maWxlIGVtYWlsIn0.cDTx9BE1Df8EfGYm3VLr_MNFeymxZtJhMtlK7PVbIuk","token_type":"bearer","not-before-policy":1586797346,"session_state":"3350f493-6627-4373-8544-defd27ad3c74","scope":"profile email"} + +``` + +The `access_token` will be used next as a Bearer. + +``` +curl http://portal.openslice.io/tmf-api/serviceCatalogManagement/v4/serviceCatalog -H 'Authorization: Bearer yJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJHZFRjQnpxczg2VW10NTRVZV8ybTJyWHJkV3dzaWdSZE9EUldMYm1memNvIn0.eyJleHAiOjE1ODgyNDA1MjQsImlhdCI6MTU4ODI0MDIyNCwianRpIjoiYjg0NGYxZDAtMzk3Mi00YTMyLThiMWEtZDAxMDY3OGZjMTQ4IiwiaXNzIjoiaHR0cDovL3BvcnRhbC5vcGVuc2xpY2UuaW8vYXV0aC9yZWFsbXMvb3BlbnNsaWNlIiwic3ViIjoiYTFhMjc2NWEtZWM4My00NDU2LWI3YjItMjA3MzE5ODZlMDM1IiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiYWRtaW4tY2xpIiwic2Vzc2lvbl9zdGF0ZSI6ImFmMmMzZmY1LTE4YWQtNDFkNC1hYTAyLTFlMGJkNzNmOTM5MSIsImFjciI6IjEiLCJzY29wZSI6InByb2ZpbGUgZW1haWwiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoiZGVtb3VzZXIifQ.SMtgV1E44_K_MQumGXZtWsLGVhYNaoM8Pk-DiFIZtUP4Zu-ervOsxHVQMX1frgVERR4jJidBcSshy9TnJ3UjF4l33WujHltbs-1UPy-gaIufVuEpl8RmbjOti3Up70vLfLXbzb6kN6WaahgobWXlbJsSXXwaBPQP6vSX5KigCa8TmzXcuqom14lOrlU-RB2zQTlJ30p7d9ag-a7o3I5m9GZWLJCZW2UYMl1JkskTHKgilA8HFQY4C9DYwWu8YDMyzqQSNumrTlURalBFidFbZvb1kp4dAyct8TysSWSbxxiwaL2RX1PWUqk-5Fpc1Q6BnBC8muMheiukFuoSkuADAg'^C +ubuntu@portal:~$ curl http://portal.openslice.io/tmf-api/serviceCatalogManagement/v4/serviceCatalog -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJHZFRjQnpxczg2VW10NTRVZV8ybTJyWHJkV3dzaWdSZE9EUldMYm1memNvIn0.eyJleHAiOjE1ODgyNDA1NzAsImlhdCI6MTU4ODI0MDI3MCwianRpIjoiOGI2ZTU0NWUtNDIyYy00NzFiLWEwN2UtYTUzYzY1NDQ0MzZmIiwiaXNzIjoiaHR0cDovL3BvcnRhbC5vcGVuc2xpY2UuaW8vYXV0aC9yZWFsbXMvb3BlbnNsaWNlIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImExYTI3NjVhLWVjODMtNDQ1Ni1iN2IyLTIwNzMxOTg2ZTAzNSIsInR5cCI6IkJlYXJlciIsImF6cCI6Im9zYXBpV2ViQ2xpZW50SWQiLCJzZXNzaW9uX3N0YXRlIjoiMzM1MGY0OTMtNjYyNy00MzczLTg1NDQtZGVmZDI3YWQzYzc0IiwiYWNyIjoiMSIsImFsbG93ZWQtb3JpZ2lucyI6WyJodHRwOi8vbG9jYWxob3N0OjEzMDgyIiwiaHR0cDovL2xvY2FsaG9zdCIsImh0dHA6Ly9vcGVuc2xpY2UuaW8iLCJodHRwOi8vbG9jYWxob3N0OjEzMDAwIiwiaHR0cDovL2xvY2FsaG9zdDo0MjAwIiwiaHR0cDovL3BvcnRhbC5vcGVuc2xpY2UuaW8iXSwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIk5GVl9ERVZFTE9QRVIiLCJvZmZsaW5lX2FjY2VzcyIsInVtYV9hdXRob3JpemF0aW9uIiwiRVhQRVJJTUVOVEVSIiwiVVNFUiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoicHJvZmlsZSBlbWFpbCIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJkZW1vdXNlciJ9.TnzzpRLMD94UTKpT5_wkr1h4_3KUQmr4TGvFLpJ7cZx-Klrv8tB_eRkWnPqqzCAM9G21a1qXboL8MLMW8ECzG7HYKpobKOGr7LSczMOTdA2ZDyBCRUSOdW77pchu54tJ0ITEkFaDwSKMKKt04V_Sy4U-eIndj0XzzRlkDolWDnK4Z2lRaXAI6fMwOKx1Toa6RfOcemxtzl3pdtjPx92zo6MaKlbIqHK82lxdK0k8aQQaT6TmIrXbZKV2dU_1d3O0q0dVUEZJ_1kzwqOFkmxr9w0EnndC6ccYJlDAr_-GgUhhhNOn5v6tjYLUQdj5e4KEAsxIPzaCreK4un7mEAPmDw' + +Response: + + +[{"uuid":"9e186cd5-b2b2-4a06-b1d6-895720193bc9","lastUpdate":"2020-03-11T23:19:05Z","@baseType":"BaseEntity","@schemaLocation":null,"@type":"ServiceCatalog","href":null,"name":"Example Facility Services","description":"Example Facility Services","lifecycleStatus":"Active","version":"1.0","validFor":{"endDateTime":"2039-11-20T23:07:21Z","startDateTime":"2019-11-20T23:07:21Z"},"relatedParty":null,"id":"9e186cd5-b2b2-4a06-b1d6-895720193bc9","category":[{"@baseType":"org.etsi.osl.tmf.scm633.model.ServiceCategoryRef","@schemaLocation":null,"@type":"org.etsi.osl.tmf.scm633.model.ServiceCategoryRef","href":null,"name":"Generic Services","@referredType":null,"id":"98b9adf1-a1d6-4165-855f-153ddc2131b1"},{"@baseType":"org.etsi.osl.tmf.scm633.model.ServiceCategoryRef","@schemaLocation":null,"@type":"org.etsi.osl.tmf.scm633.model.ServiceCategoryRef","href":null,"name":"External","@referredType":null,"id":"08ffdb3c-6237-45d0-9f3a-d43b5fc5f0b6"},{"@baseType":"org.etsi.osl.tmf.scm633.model.ServiceCategoryRef","@schemaLocation":null,"@type":"org.etsi.osl.tmf.scm633.model.ServiceCategoryRef","href":null,"name":"eMBB","@referredType":null,"id":"ef2c90dd-b65e-4a9f-a9c3-427c9fb0219b"}]}] + + +``` \ No newline at end of file diff --git a/doc/architecture/osom.md b/doc/architecture/osom.md new file mode 100644 index 0000000000000000000000000000000000000000..173aa8017d603bb3854eb6b4c0e9baa905e512f6 --- /dev/null +++ b/doc/architecture/osom.md @@ -0,0 +1,137 @@ +# Openslice Service Orchestration and Order Management - OSOM + +OSOM is a service responsible for: + +* Service Order Management (SOM) +* Service Orchestration (SO) + +It uses open source Flowable Business process engine (https://www.flowable.org) . + +A Service Order follows the states as defined in TMF641 specification: + +[](../images/service_order_states.png) + + +## Initial state + +When a new order is created, it goes into the Initial state. It is stored in the repository and triggers an Event. + +[](../images/service_order_initial_state.png) + +Administrators are notified usually from the Ticketing System of a new order. They login to Openslice and change the State of the order either to ACKNOWLEDGED or REJECTED. If ACKNOWLEDGED they can Propose a startDate, add Notes, and add any additional service items + +## Order scheduler + +A process checks every 1 minute for ACKNOWLEDGED orders. + +[](../images/order_scheduler_bpm.png) + +[](../images/order_scheduler_diagram.png) + +It retrieves all orders that are in ACKNOWLEDGED state and if the start date is in time it will initialize the process by settingn the order in IN_PROGRESS state. Finally the Start Order Process will start. + + +## Start order process + +This process for now is a draft simple prototype to make a simple orchestration via NFVO. Here the actual Services (TMF638/640 model) are created and attached to Service Order and Service Inventory. + +[](../images/start_order_process_bpm.png) + +[](../images/start_order_process_diagram.png) + +We expect here to check which tasks can be orchestrated by NFVO and which by human. We create the equivalent Services(TMF638/640 model) for this order. + +1. During check it should decide to create Service(s) for this service order O1 and send it to ServiceInventory +2. The Services(TMF638 model) are assigned to the Order O1 In supportService List +3. Each OrderItem OI1 is related to one serviceSpecification +4. Each ServiceSpecification has also related serviceSpecRelationships +5. So if we receive an order O1 for a ServiceSpec A which relates to (a bundle of) 3 specs(2 CFS, 1 RFS) we do the following: + 1. Create a Service S_A(TMF638 model) for ServiceSpec A for Order O1 + 2. We create also 3 Services S_C1, S_C2 and S_R1 equivalent to the serviceSpecRelationships (2 CFS, 1 RFS) + 3. At this point the order will have 1 Local Service Orchestration Process(S_A), 2 supportingServices refs(S_C1, S_C2) and 1 supportingResource(S_R1) + 4. The 3 supportingServices and 1 supportingResource correspond to total 4 Services in ServiceInventory + 5. Service S_A will have: + 1. startMode 1: Automatically by the managed environment + 2. State: RESERVED and the Lifecycle will be handled by OSOM + 6. Services S_C1 and S_C2 we decide that cannot be orchestrated then they have + 1. startMode: 3: Manually by the Provider of the Service + 2. State: RESERVED and the Lifecycle will be handled by OSOM + 3. If the CFS is a bundle spec it is further recursively orchestrated + 7. Service S_R1 will have + 1. startMode 1: Automatically by the managed environment. + 2. State: RESERVED + 3. IF The Service has the characteristic CharacteristicByName( "NSDID") it will be further processed by the NFVO + + +There will be two instances of task "User Task Manual Complete Service" each for Services S_C1 and S_C2. The task is Transient for now. It displays only the services that are not automated! +Here is a flow for future: + +1. We wait here for human decision. +2. From API we get a result: + a. If set to ACTIVE/TERMINATED then we complete the task + b. In any other state we stay in this task until it is resolved as in step a + c. The Status of ORDER O1 is also updated to PARTIAL + +There will be an instance of NFVODeploymentRequest process each for Service S_R1. (see later) + +1. This process is related with the NFVO orchestration +2. It will send a msg to NFVO(s?) for a specific deployment request + + +All services in "Order Complete" are in a status: + +1. Depending on the result the service S_A is either ACTIVE or INACTIVE or TERMINATED +2. The Status of ORDER O1 is also updated to COMPLETED or PARTIAL (in case we have some services running) or FAILED (in cases we have errors) + + +A Service follows the states as defined in TMF638 Service Inventory specification: + +[](../images/service_states.png) + + + +## NFVODeploymentRequest process + + +[](../images/NFVODeploymentReq_process.png) + +This process is related with the NFVO orchestration +It will send a msg to NFVO(s?) for a specific deployment request +Then it checks the deployment status. It will wait 30 secs each time until the deployment is running (or failed) + + + +## Check In Progress orders process + +Every 1 minute the "Check In Progress Orders" process is executed checking if a supported Service changed state (i.e. to ACTIVE) then the whole Order will change state (e.g. go to COMPLETED) + +[](../images/check_inProgress_orders.png) + + +## External Service Provider Deployment Request process + +[](../images/externalSPDeploymentReq.png) + +This process contains tasks for submitting order requests to external partners. +- Submit Order To External Service Provider Task: This task creates automatically a Service Order request to a 3rd party provider SO that hosts the Service Specification +- Check external service order fulfillment task: This task Check external partner for Service creations and updates our local inventory of services the service characteristics of remote Service Inventory + + +## Fetch Partner Services Process + + +[](../images/fetchPartnerServices.png) + +Every 2 minutes the "fetchPartnerServicesProcess" process is executed checking remote Partner Organizations for changes in the published catalogues. +The Fetch and Update External Partner Services Task is executed in paralle l for each Partner Organization + + +## Local Service Orchestration Process + + +[](../images/LocalServiceOrchestrationProcess.png) + +This process handles automatically services that need to be further orchestrated or processed by OSOM. For example, for a CFS Bundled service we create such automated service instances that just aggregate the underlying services. + + + \ No newline at end of file diff --git a/doc/architecture/tmfapi.md b/doc/architecture/tmfapi.md new file mode 100644 index 0000000000000000000000000000000000000000..f7944969741681c840db830a70fc688a0224295e --- /dev/null +++ b/doc/architecture/tmfapi.md @@ -0,0 +1,65 @@ +# TMF OpenAPI specification + +PLease check the complete specification [here](http://portal.openslice.io/tmf-api/swagger-ui/index.html). + +## API interaction + +### OAuth token + +See [oauth](./oauth.md) + +### Request a protected API resource + +Example: Get all Service Catalogs (check the `Authorization:Bearer` to be correct) + +``` +curl -H "Authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX25hbWUiOiJhZG1pbiIsInNjb3BlIjpbIm9wZW5hcGkiLCJhZG1pbiIsInJlYWQiLCJ3cml0ZSJdLCJvcmdhbml6YXRpb24iOiJteW9yZ2FuaXp0aW9uIiwiZXhwIjoxNTc4NTA1MDcyLCJhdXRob3JpdGllcyI6WyJST0xFX01FTlRPUiIsIlJPTEVfQURNSU4iXSwianRpIjoiMTFlNGYxYTUtZDY0Ny00YzA1LWE0ZGMtYWFhYzUyMjk4YzMwIiwiY2xpZW50X2lkIjoib3NhcGlXZWJDbGllbnRJZE91dCJ9.gm7cKdusDrdMRkxEiFU5sENKGRC1xwVj2SgPRmE9xxx" -H "accept: application/json;charset=utf-8" -X GET "http://portal.openslice.io/tmf-api/serviceCatalogManagement/v4/serviceCatalog" + +``` + + +response: + + +``` +[ + { + "uuid": "9e186cd5-b2b2-4a06-b1d6-895720193bc9", + "lastUpdate": "2019-12-19T10:45:55Z", + "@baseType": "BaseEntity", + "@schemaLocation": null, + "@type": "ServiceCatalog", + "href": null, + "name": "Example Facility Services", + "description": "Example Facility Services", + "lifecycleStatus": "Active", + "version": "1.0", + "validFor": { + "endDateTime": "2039-11-20T23:07:21Z", + "startDateTime": "2019-11-20T23:07:21Z" + }, + "relatedParty": null, + "id": "9e186cd5-b2b2-4a06-b1d6-895720193bc9", + "category": [ + { + "@baseType": "org.etsi.osl.tmf.scm633.model.ServiceCategoryRef", + "@schemaLocation": null, + "@type": "org.etsi.osl.tmf.scm633.model.ServiceCategoryRef", + "href": null, + "name": "eMBB", + "@referredType": null, + "id": "ef2c90dd-b65e-4a9f-a9c3-427c9fb0219b" + }, + { + "@baseType": "org.etsi.osl.tmf.scm633.model.ServiceCategoryRef", + "@schemaLocation": null, + "@type": "org.etsi.osl.tmf.scm633.model.ServiceCategoryRef", + "href": null, + "name": "Generic Services", + "@referredType": null, + "id": "98b9adf1-a1d6-4165-855f-153ddc2131b1" + } + ] + } +] +``` \ No newline at end of file diff --git a/doc/architecture/tmfweb.md b/doc/architecture/tmfweb.md new file mode 100644 index 0000000000000000000000000000000000000000..729eed65fa1833982885623ca9108e67b44ab20c --- /dev/null +++ b/doc/architecture/tmfweb.md @@ -0,0 +1,39 @@ +# Openslice TMF Web Portal + +Openslice comprises of a [web landing page](http://portal.openslice.io/) that navigates to the respective TMF Portal. + +- [Services Portal](http://portal.openslice.io/services) +- [Products Portal](http://portal.openslice.io/products) +- [Testing Portal](http://portal.openslice.io/testing) +- [Resources Portal](http://portal.openslice.io/resources) + +The landing page and the TMF portals (Services, Products, Testing, Resources) are written in Angular and are maintained under the same Angular project. + +Following you may find the scope each portal focuses on and the main TMF APIs it supports. + +**Services Portal** is a designated portal for the: +- Service Designer - To design Customer Facing Services as bundles of Resource Facing Services that map to specific Resourses (e.g. NFV, Testing, General Resources). Then, it is charged with the designed Services' exposure to public Service Catalogs. +- Service Customer - To browse the public Service Catalogs and order the offered Services. The fulfilment process of the Service Order is also captured and the final deployed Services are exposed to the Customer. + +**Products Portal** is a designated portal for the: +- Product Designer - To design Products as bundles of available Services. Then, it is charged with the designed Products' exposure to public Product Catalogs. +- Product Customer - To browse the public Product Catalogs and navigate to the respective offered Services. + +**Testing Portal** is a designated portal for the: +- Testing Designer - To design Tests and provide the testing scripts as attachments to the latter. The Tests can be imported as Services at the Services Portal, and can be included in a Service Bundle. + +**Resources Portal** is a designated portal for the: +- Resource Administrator - To view the available Resources that are being synchronized from the underlying infrastructure. + + + + +| | TMF620 | TMF632 | TMF633 | TMF634 | TMF638 | TMF639 | TMF640 | TMF641 | TMF642 | TMF653 | TMF685 | +| ------------- |:------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:| +|**Services Portal** | |x |x | |x | |x |x |x | | | +|**Products Portal** |x |x | | | | | | | | | | +|**Testing Portal** | |x | | | | | | | |x | | +|**Resources Portal** | |x | |x | |x | | | | |x | + + +From the landing page, the user can also navigate towards the NFV portal. See [NFV WEB](./nfvweb.md). \ No newline at end of file diff --git a/doc/catalogs.md b/doc/catalogs.md new file mode 100644 index 0000000000000000000000000000000000000000..3b3538d0b5dcaedf1690154bea22e70caf85551b --- /dev/null +++ b/doc/catalogs.md @@ -0,0 +1,147 @@ +# Catalogs and Templates + +The Openslice Service Catalogue (accessible through the API or Services portal) contains the representation of Service Specifications, either created from the provider defining service attributes, or by supporting the GSMA Generic Slice Templates (GST) as well as the VINNI Service Blueprint. The following scenarios are supported by the Openslice Service Catalogue. + + +## Create/Design a Service Specification + +### First Import some Resources as Resource Facing Services (RFSs) + +If you have any NSDs as NFV artifacts, import them through the UI menu (Import from NSD list). Then an NSD is imported as a resource and an RFS automatically is created. RFSs then later are used to design a Customer Facing Service Specification + +### Create/Design a Customer Facing Service Specification + +Customer Facing Service Specification are the services offered to customers. +You can create a new Service Specification from the menu. The services created through the UI are Customer Facing Services (CFS). Usually you create a CFS as a bundle and then you include Service Specification Relationships with RFSs or/and CFSs. + +Any Service Specification Characteristics from the RFS are copied to the CFS specification. A CFS can include multiple RFS or/and CFSs. +For example you can create a CFS spec called "A 5G Service" which is a bundle of two other services (include them in Service Specification Relationships) such as 5G eMBB Slice and a Customer VPN. So when the user orders "A 5G Service" services from 5G eMBB Slice and a Customer VPN will be created during the order. + +### Initial configuration for OSM deployment + +if you have an initial configuration that needs to be applied in the NSD deployment, then you go to the RFS (or CFS) and in Service Specification Characteristics go and edit the OSM_CONFIG characteristic. +You can add in the Service Characteristic Value, in the Value field something like the following example which gives a floating IP to a VNF: + +``` +{ "nsdId": "e855be91-567b-45cf-9f86-18653e7ea", "vimAccountId": "4efd8bf4-5292-4634-87b7-7b3d49108" , "vnf": [ {"member-vnf-index": "1", "vdu": [ {"id": "MyCharmedVNF-VM", "interface": [{"name": "eth0", "floating-ip-required": true }]}]}]} + +``` + +or a more complex example (beautify it first if you want to view it, but in the parameter OSM_CONFIG must be minified like the example): + +``` +{"nsdId":"e855be91-567b-45cf-9f86-18653e7","vimAccountId":"4efd8bf4-5292-4634-87b7-7b3d491","vnf":[{"member-vnf-index":"1","vdu":[{"id":"haproxy_vdu","interface":[{"name":"haproxy_vdu_eth1","floating-ip-required":true}]}]}],"vld":[{"name":"pub_net","vim-network-name":"OSMFIVE_selfservice01"},{"name":"management","vim-network-name":"OSMFIVE_selfservice01"},{"name":"lba_net","vim-network-name":"lba_net","vnfd-connection-point-ref":[{"member-vnf-index-ref":"1","vnfd-connection-point-ref":"haproxy_private","ip-address":"192.168.28.2"}]},{"name":"backend_net","vim-network-name":"backend_net","vnfd-connection-point-ref":[{"member-vnf-index-ref":"3","vnfd-connection-point-ref":"haproxy_public","ip-address":"192.168.20.2"}]},{"name":"lb_sb_net","vim-network-name":"lb_sb_net","vnfd-connection-point-ref":[{"member-vnf-index-ref":"3","vnfd-connection-point-ref":"haproxy_private","ip-address":"192.168.28.2"}]},{"name":"breaking_point_Spain","vim-network-name":"sb_repo_net"},{"name":"breaking_point_Greece","vim-network-name":"5TONICexternal"}],"additionalParamsForVnf":[{"member-vnf-index":"2","additionalParams":{"target_IP":"192.168.20.2"}},{"member-vnf-index":"4","additionalParams":{"target1_IP":"192.168.21.2","target2_IP":"10.154.252.10"}}]} +``` + +You can leave the Alias and Unit of Measure as is. Check also the is Default. + + + +### Day 2 Primitive Actions + +NFVOs like OSM allow to perform actions while a service is running, for example change attributes or make actions on a specific VNF. To design this do something similar to the following example: + +- Go to the RFS related to the NSD that contains VNFs with primitives +- create a characteristic named Primitive::
+ +1 - Backup your previous database if necessary: +``` +sudo docker exec amysql /usr/bin/mysqldump -u root --password=letmein ostmfdb > backup_ostmfdb.sql +``` + + 2 - Install docker + +_NOTE:_ Since July 2023 Docker Compose V1 stopped receiving updates. Openslice fully reverted to Compose V2, which is integrated in the Docker installation. + + +3 - Download environment preparation script +``` +wget https://raw.githubusercontent.com/openslice/org.etsi.osl.main/master/compose/deploy.sh +``` + +4 - Work with main/master branch: + +``` +sudo ./deploy.sh +``` +Alternatively, work with develop or any other branch: + +``` +sudo ./deploy.sh develop [or replace develop with other branch name] +``` + +5 - Create configuration specific docker compose file +``` +cd org.etsi.osl.main/compose/ +sudo cp docker-compose.yaml.configure docker-compose.yaml +``` + +6 - Configure containers to properly resolve the DNS of your domain + +edit /etc/docker/daemon.json and add: + +``` +{ + "dns": ["8.8.8.8", "8.8.4.4"] +} +``` + +and restart docker daemon. + +
+ +# Configure docker-compose services + + +Edit your configuration specific docker-compose.yaml that is previously created: + +
+ +## 1. mysql-portal container + +In folder mysql-init edit the file 01-databases.sql. Edit the credentials that services connect to the database (if you wish) of portaluser (default is 12345) and keycloak (default is password). + +delete the exposed ports + +## 2.keycloak container + +2.1 Edit the following if you changed mysql credentials +``` +DB_DATABASE: keycloak +DB_USER: keycloak +DB_PASSWORD: password +``` + +2.2 Change the keycloak admin password +``` +KEYCLOAK_PASSWORD: Pa55w0rd +``` + + +## 3.osportalapi container (NFV services) + +Edit the following if you changed mysql and keycloak credentials and adjust properly the domain (if you are using a non-local domain, replace everywhere the http://keycloak:8080) + +``` +SPRING_APPLICATION_JSON: '{ + "spring.datasource.url": "jdbc:mysql://amysql/osdb?createDatabaseIfNotExist=true", + "spring.datasource.username":"root", + "spring.datasource.password":"letmein", + "spring-addons.issuers[0].uri": "http://portal.openslice.io/auth/realms/openslice", + "spring-addons.issuers[0].username-json-path":"$.preferred_username", + "spring-addons.issuers[0].claims[0].jsonPath":"$.realm_access.roles", + "spring-addons.issuers[0].claims[1].jsonPath":"$.resource_access.*.roles", + "spring.security.oauth2.resourceserver.jwt.issuer-uri": "http://portal.openslice.io/auth/realms/openslice", + "springdoc.oAuthFlow.authorizationUrl": "http://portal.openslice.io/auth/realms/openslice/protocol/openid-connect/auth", + "springdoc.oAuthFlow.tokenUrl": "http://portal.openslice.io/auth/realms/openslice/protocol/openid-connect/token", + "springdoc.oauth.client-id" : "osapiWebClientId", + "springdoc.oauth.clientsecret" : "secret", + "spring.activemq.brokerUrl": "tcp://anartemis:61616?jms.watchTopicAdvisories=false", + "spring.activemq.user": "artemis", + "spring.activemq.password": "artemis", + "logging.level.org.springframework" : "INFO" + + +``` + + +## 4.bugzilla container + +If you would like to use the Bugzilla connector + +``` +"bugzillaurl":"bugzillaurl.xx:443/bugzilla/", +"bugzillakey":"exampleKeyeqNNwxBlgxZgMEIne0Oeq0Bz", +"main_operations_product":"Main Site Operations" //this is the default product to issue tickets +``` + +Bugzilla under this product should have components: +- NSD Deployment Request: Component used to schedule deployment req +- Onboarding: Issues related to VNF/NSD Onboarding +- Operations Support: Default component for operations support +- Validation: Use to track validation processes of VNFs and NSDs +- VPN Credentials/Access: Used for requesting VPN Credentials/Access + + +Also in the 'Main Site Operations' product, please create a version named 'unspecified' + + +## 5.osscapi container (TMF-API service) + +Edit the following if you changed mysql and keycloak credentials + +``` +"spring.datasource.username":"xx", +"spring.datasource.password":"xx", +"keycloak-admin-password": "Pa55w0rd", +Edit properly with your domain "swagger.authserver" : "http://localhost/auth/realms/openslice", + +``` + +Delete the exposed ports in other services like activemq + +
+ +# Configure nginx + +``` +cd nginx +sudo cp nginx.conf.default nginx.conf +``` + +Edit server_name + +
+ +# Configure Web UI + +``` +cd org.etsi.osl.portal.web/src/js/ +cp config.js.default config.js +``` + +Edit config.js with your domain + +``` +TITLE: "Openslice demo", + WIKI: "http://localhost", + BUGZILLA: "https://localhost/bugzilla/", + STATUS: "http://status.localhost/", + APIURL: "http://localhost", + WEBURL: "http://localhost", + APIOAUTHURL: "http://localhost/auth/realms/openslice", + APITMFURL: "http://localhost/tmf-api/serviceCatalogManagement/v4" + +``` + +
+ +# Configure TMF Web UI + +There are 3 files available for configuration: + +* config.prod.json (Basic information + API configuration) +* theming.scss (CSS color palette theming) +* config.theming.json (HTML configuration - Logo, Favicon, Footer) + + +The first 2 files above (i.e. config.prod.json, theming.scss) are essential for the successful deployment of Openslice, thus created automatically during the initial deployment at **org.etsi.osl.tmf.web/src/assets/config** directory as a copy of the default ones from the remote repository. + +
+ +Ensure that you check the **config.prod.json** file and readjust to your deployment if needed. + +``` +cd org.etsi.osl.tmf.web/src/assets/config +``` +and edit config.prod.json + +E.g. Edit "TITLE" or "WIKI" property with your domain title + +``` +TITLE: 'Openslice', +WIKI: 'https://openslice.io', +``` + +_NOTE:_ The {BASEURL} placeholder in the file automatically detects the Origin (Protocol://Domain:Port) of the deployment and applies it to every respective property. E.g. If you are attempting a local deployment of Openslice, then {BASEURL} is automatically translated to "http://localhost". Similarly, you may use {BASEURL} to translate to a public deployment configuration, e.g. "https://portal.openslice.io". + +
+ +If further customization, apart from the default provided, is needed for branding (Logo, Footer) then **config.theming.json** needs to be created in **org.etsi.osl.tmf.web/src/assets/config** directory, as follows: + +``` +cd org.etsi.osl.tmf.web/src/assets/config +sudo cp config.theming.default.json config.theming.json +``` + +
+ +> **_IMPORTANT NOTE:_** If you want to apply changes to the JSON configuration files without the need to rebuild the application, you have to apply the changes at the **org.etsi.osl.tmf.web/dist/io-openslice-portal-web/assets/config** directory. Although, it is mandatory to also apply these changes to the **org.etsi.osl.tmf.web/src/assets/config** for persistancy, as after any future rebuild of Openslice the **/dist** directory is being ovewritten along with its contents. The Openslice team strongly recommends to always apply your changes to the TMF web UI configuration files at **org.etsi.osl.tmf.web/src/assets/config** and rebuild the application. + +
+ + +# Deploying docker compose + + + + +Go to compose directory and issue: +``` +sudo docker compose --profile prod down;sudo docker compose --profile prod up -d --build +``` + +Note: Depending on your machine, this process might take time. + + +
+ + +# Validating deployments and container monitoring + +You can monitor containers status with portainer at port 9000 (http://your-ip:9000) + +Initially, you may monitor the local machine at portainer. + +Please check that all containers are in running state. + +
+ +# Kubernetes installation + + +Openslice can be installed in a Kubernetes cluster. (This is a work in progress) + +The related scripts are inside the kubernetes folder. Follow these steps along the lines. You need to configure the ingress properly depending on how you want to expose Openslice. + +1) Create an openslice namespace + +``` +kubectl create namespace openslice +``` + +2) Apply or create an ingress. Ingress exposes HTTP and HTTPS routes from outside the cluster to services within the cluster. Traffic routing is controlled by rules defined on the Ingress resource. +An Ingress may be configured to give Services externally-reachable URLs, load balance traffic, terminate SSL / TLS, and offer name-based virtual hosting. An Ingress controller is responsible for fulfilling the Ingress, usually with a load balancer, though it may also configure your edge router or additional frontends to help handle the traffic. You must have an Ingress controller to satisfy an Ingress. +You may need to deploy an Ingress controller such as ingress-nginx. + +You can also adapt it to connect to public cloud load balancers depending on your needs. + +The following will expose an ingress resource from one of your a k8s nodes on port 80 + +``` + kubectl apply -f openslice-ingress.yaml +``` + + +Finding the ingress IP: + + +``` + +kubectl describe -f openslice-ingress.yaml + + +Name: openslice-ingress +Namespace: openslice +Address: 10.10.10.35 +Default backend: default-http-backend:80 (
+ +# Post installation steps + +
+ +## Configure Keycloak server + +Keycloack server is managing authentication and running on a container at port 8080. It is proxied to your host via nginx under http://localhost/auth. + +* Go to http://domain.com/auth/ or https://domain.com/auth/ , (http://ipaddress:8080/auth/ or https://ipaddress:8443/auth/ are direct with no proxy) + +* Navigate to Administration Console + + +> NOTE: if you are running in HTTP you will get a message: HTTPS required + +Go to https://ipaddress:8443/auth/ + +Login with the credentials from section 2.2 + +user admin and your KEYCLOAK_PASSWORD + +Select the master realm from top left corner, go to login Tab and select "Require SSL": None + +Do the same for realm Openslice + +> NOTE: If you are running in HTTPS, then leave Require SSL to external requests + +
+ +### Configure redirects + +Go to realm Openslice, client, osapiWebClientId and change Root URL to your domain. + +Also, insert your domain, e.g. http://example.org/*, at: +* Valid Redirect URIs +* Web Origins + +
+ +### Configure email in Keycloak + +Keycloak also allows new users to register. + +On Tab Login -> check User registration, Verify email, Forgot password etc. + +Also, enter the details on Realm -> Email -> Enable Authentication + +
+ +### Add an Openslice admin user + +Go to manage/users and add an Openslice admin user, e.g. username=admin. Set a password and go also to Role Mappings and add to Assigned Roles ADMIN and MENTOR. + +> Note: That user is different from the Keycloak admin user. It is used to login and browse the OpenSlice Web UI. The Roles ADMIN and MENTOR guarantee full access through the Openslice UI, thus such a user is always required. + +
+ +## Keycloak at localhost + +> **This is an important step if you run Keycloak on localhost** + +1 - Edit your hosts file, adding the line below + +```127.0.0.1 keycloak``` + +2 - Replace http://localhost/auth/ with http://keycloak:8080/auth/ in your Keycloak config for TypeScript/Angular (see examples below). + + +Hosts File Location: + + - In Linux/Unix, the file's location is at /etc/hosts + + - In Windows, its location is at c:\Windows\System32\Drivers\etc\hosts + +Explanation: + + Nginx uses the http://keycloak:8080 URL, which is accessible via the internal docker system's network. + The Front-end (TS/Angular) shall also use the http://keycloak:8080. + This way, you will not get the invalid token error, as the API is getting the token from http://keycloak:8080 (internally) and the Front-end is getting verified with the same URL, as well. + + + +Nginx serves the Front-end from the project org.etsi.osl.tmf.web. + + + + +If you would like to use the Front-end to test your backend, then: + +1. config.prod.json (org.etsi.osl.tmf.web project) should look similar to the following example: + +``` +{ + "TITLE": "Openslice demo", + "PORTALVERSION":"1.1.0-SNAPSHOT", + "WIKI": "http://wiki.localhost", + "BUGZILLA": "{BASEURL}/bugzilla/", + "STATUS": "http://status.localhost/", + "WEBURL": "{BASEURL}", + "PORTAL_REPO_APIURL": "{BASEURL}/osapi", + "ASSURANCE_SERVICE_MGMT_APIURL": "{BASEURL}/oas-api", + "APITMFURL": "http://localhost:13082/tmf-api", + "OAUTH_CONFIG" : { + "issuer": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth", + "loginUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth", + "tokenEndpoint": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token", + "redirectUri": "{BASEURL}/redirect", + "logoutUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/logout", + "postLogoutRedirectUri": "{BASEURL}/services/services_marketplace", + + "responseType": "code", + "oidc": false, + "clientId": "osapiWebClientId", + "dummyClientSecret": "secret", + + "requireHttps": false, + "useHttpBasicAuth": true, + "clearHashAfterLogin": false, + + "showDebugInformation": true + } +} +``` +> Note the difference in changing {BASEURL} -> http://keycloak:8080 + +2. config.js (org.etsi.osl.portal.web) should look similar to the following example: + +``` +var appConfig = angular.module('portalwebapp.config',[]); + + +appConfig.factory('APIEndPointService', function() { + return { + TITLE: "Openslice", + WIKI: "ROOTURL", + BUGZILLA: "ROOTURL/bugzilla/", + STATUS: "ROOTURL/status/", + APIURL: "http://localhost:13000", + WEBURL: "ROOTURL/nfvportal", + APIOAUTHURL: "http://keycloak:8080/auth/realms/openslice", + APITMFURL: "http://localhost:13082/tmf-api/serviceCatalogManagement/v4" + + }; +}); +``` +> Note the difference in "APIOAUTHURL" property + +
+ +## NFV Portal Landing page + +You may configure the landing page for the NFV Portal at + +``` +org.etsi.osl.portal.web/src/openslicehome/index.html +``` + +
+ +## NFV Orchestrator Configuration + +See [NFV Orchestrator Configuration](./nfvoconfig.md). + +
+ +## Important Note + +There is a case where the first time the services fail to start due to failed mysql connections. Please just issue again: + +`sudo docker compose --profile prod down;sudo docker compose --profile prod up -d --build` + diff --git a/doc/eclipse-java-google-style.xml b/doc/eclipse-java-google-style.xml new file mode 100644 index 0000000000000000000000000000000000000000..7bb6804eb39f988b43f6ac997d66c203272d4969 --- /dev/null +++ b/doc/eclipse-java-google-style.xml @@ -0,0 +1,337 @@ + +
+
+version: 2023-Q3 1.2.0-SNAPSHOT
+
+Openslice is a prototype open source, operations support system. It supports VNF/NSD onboarding to OpenSourceMANO (OSM) and NSD deployment management. It also supports TMFORUM OpenAPIs regarding Service Catalog Management, Ordering, Resource, etc.
+
+
+## Usage
+
+Openslice allows Vertical Customers to browse the available offered service specifications and also allows NFV developers to onboard and manage VNF and Network Service artifacts.
+The following figure displays the usage of Openslice.
+
+[](./images/index_intro_architecture.png)
+
+
+There are two portals offering UI friendly access to users:
+
+* The Services portal allows users to access services and service providers to design services.
+* The NFV portal allows users to self-manage NFV artifacts and onboard them to a target MANO/NFV Orchestrator.
+
+3rd party applications can use Openslice through TMForum Open APIs.
+
+Service Specifications reside into Service Catalogs, grouped in Categories. Openslice offers a Service Orchestrator called [OSOM](./architecture/osom.md). OSOM instantiates Service Specifications by requesting Network Services from target MANOs/NFVOs. NFV artifacts reside into a VNF/NSD catalog and are onboarded to a target MANO/NFV Orchestrator. Service Specifications reference NSD from the VNF/NSD catalog.
+
+Customers make Service Orders and Openslice instantiates the requested Service Specifications of the Service Order. Running Services instantiated by Openslice, reside in Openslice Service Inventory. The following picture displays how Service Specifications are related to Running Services and how Running Services relate with instantiated running Network Services. (See also [Service Inventory](./service_inventory.md) )
+
+[](./images/service_specification_instantiation.png)
+
+## Service Lifecycle Rules
+
+Openslice constains support for defining rules of services, affecting their behavior. See [LCm Rules](./lcm.md)
+
+## Multidomain scenarios and federation
+
+Openslice can be used to exchange service specifications/catalogs and make service orders between Organizations as the following figure displays.
+
+[](./images/multi-domain-organizations.png)
+
+An Identity federation is also possible since our authentication service is based on Keycloak (see [OAuth](./architecture/oauth.md) )
+
+See more on [Consuming Services From External Partner Organizations](./architecture/consumingServicesFromExternalPartners.md)
+
+
+## Live Demo
+
+* Openslice demo: or
username=admin, password=changeme + + +## Video demo + +*
openslice.io an opensource OSSOpenslice demo | http://portal.openslice.io
A portal that allows 5G experimenters to deploy experiment descriptors towards the infrastructure.Openslice demo wiki | https://openslice.readthedocs.io/en/stable/
A wiki containing project documentation.Openslice demo Report Issues | http://portal.openslice.io/bugzilla/
Our issue tracking system.", + "CONNECT_WITH_US_HTML":"", + "FOOTER_HTML":"
openslice.io has received funding from
5GinFIRE | https://5ginfire.eu/ project from the European Horizon 2020 Programme for research, technological development and demonstration under grant agreement number 732497.
5G-VINNI project | https://5g-vinni.eu/ 5G-VINNI project has received funding from the European Horizon 2020 Programme for research, technological development and demonstration under grant agreement number 815279
Openslice demo running openslice.io version 1.1.0-SNAPSHOT| Data Protection Declaration | © 2019-2021 on behalf of openslice.io
openslice.io an opensource OSSOpenslice demo | http://portal.openslice.io
A portal that allows 5G experimenters to deploy experiment descriptors towards the infrastructure.Openslice demo wiki | https://openslice.readthedocs.io/en/stable/
A wiki containing project documentation.Openslice demo Report Issues | http://portal.openslice.io/bugzilla/
Our issue tracking system.", + "CONNECT_WITH_US_HTML":"", + "FOOTER_HTML":"
openslice.io has received funding from
5GinFIRE | https://5ginfire.eu/ project from the European Horizon 2020 Programme for research, technological development and demonstration under grant agreement number 732497.
5G-VINNI project | https://5g-vinni.eu/ 5G-VINNI project has received funding from the European Horizon 2020 Programme for research, technological development and demonstration under grant agreement number 815279
Openslice demo running openslice.io version 1.1.0-SNAPSHOT| Data Protection Declaration | © 2019-2021 on behalf of openslice.io