diff --git a/doc/architecture/CRIDGE/CRIDGEforDevelopers.md b/doc/architecture/CRIDGE/CRIDGEforDevelopers.md index c8e707fc87c3bc0dfe5a5a4adf88d2b605ddfe67..10cd9ac45c80ad5606af1fa18d611b753ad261fd 100644 --- a/doc/architecture/CRIDGE/CRIDGEforDevelopers.md +++ b/doc/architecture/CRIDGE/CRIDGEforDevelopers.md @@ -214,7 +214,7 @@ OSOM sends to CRIDGE a message with the following information: --- -## What's next? +## Probe further - See examples of exposing operators via OpenSlice: - [Exposing Kubernetes Operators as a Service : Offering "Calculator as a Service" through OpenSlice](../../service_design/examples/ExposingCRDs_aaS_Example_Calculator/ExposingCRDs_aaS_Example_Calculator.md) diff --git a/doc/index.md b/doc/index.md index 8d1b7a4cb80420c9b3198a3dc96c7ea2ce47af49..eb0d7755c75f184683cf94700b3f1d02f6453c3e 100644 --- a/doc/index.md +++ b/doc/index.md @@ -78,12 +78,9 @@ Check a live demo of OpenSlice in the following pages: > > -# What's next +# Probe further -Installing OpenSlice. See the [Deployment](deployment.md) of OpenSlice - -Lear more on [how OpenSlice supports Network as a Service(NaaS)](./naas/introduction.md) - -Who is implementing OpenSlice? See [OSL ETSI SDG](https://osl.etsi.org/) - -How OpenSlice works? See the [Architecture](./architecture/architecture.md) of OpenSlice +* Installing OpenSlice. See the [Deployment](deployment.md) of OpenSlice +* Learn more on [how OpenSlice supports Network as a Service(NaaS)](./naas/introduction +* Who is implementing OpenSlice? See [OSL ETSI SDG](https://osl.etsi.org/) +* How OpenSlice works? See the [Architecture](./architecture/architecture.md) of OpenSlice diff --git a/doc/lcm.md b/doc/lcm.md index b668b908c58da2c6972e11a0b6ca50450fd02176..3eb28e926439b0eb526a36f91995a42f6d900a66 100644 --- a/doc/lcm.md +++ b/doc/lcm.md @@ -13,7 +13,7 @@ LCM Rules are used for defining complex conditions and actions during the lifecy The following figure displays the different phases that the rules are performed, during the lifecycle of a Network Slice Instance. -[](../images/lcm/lcmfig1.png) +[](./images/lcm/lcmfig1.png) * PRE_PROVISION rules: Run only once just before creating a service with a given priority. * CREATION rules: Run while the referenced service dependencies of a service are created diff --git a/doc/naas/gst_to_gsma/img01.png b/doc/naas/gst_to_gsma/img01.png new file mode 100644 index 0000000000000000000000000000000000000000..f72c1855e08903dfcca60a213b88a106775b8130 Binary files /dev/null and b/doc/naas/gst_to_gsma/img01.png differ diff --git a/doc/naas/gst_to_tmf.md b/doc/naas/gst_to_tmf.md new file mode 100644 index 0000000000000000000000000000000000000000..8de472024ac206982ef938b28e86ffdf51584fe2 --- /dev/null +++ b/doc/naas/gst_to_tmf.md @@ -0,0 +1,31 @@ +# Generic Slice Template as a Service Specification + +## Intended Audience: Service Designers + +GSMA Generic Slice Template (GST) Defines customer-oriented service requirements, E.g. Availability, Area of service, delay tolerance, etc. and attempts to narrow down the gap between (network) service customers and vendors + +Moreove it Proposes standardized Network Slice Templates (NESTs) to target specific use cases + + +In OpenSlice we made an effort and translated the GST to a Service Specification model. So Service Designers can use it as a template to design a new Service. + +The image illustrates the relationship between the GSMA Generic Slice Template (GST), TM Forum Service Specification, and how they are utilized within OpenSlice to offer network services. + +[](./gst_to_gsma/img01.png) + +The GST to TM Forum via OpenSlice: + + * GST Attributes List: A comprehensive list of service attributes, such as availability, delay tolerance, downlink throughput, energy efficiency, isolation level, mission-critical support, and many others. + * TMF Service Specification: Demonstrates the transformation of GST attributes into a TM Forum service specification, showing JSON code snippets that define service parameters. + * Offered Service based on GST: Represents the final offered service, an example of a GST-based service shown as an entry in a catalog, ready to be consumed by customers. + +What was our flow: + + * Started with defining service requirements and attributes using GST. + * Translated these GST attributes into a formal TM Forum service specification. + * Service Offering in OpenSlice: The service specification is then used to create and offer a specific network service within OpenSlice, available for customer selection and deployment. + + +## Probe further + +See v9 of the GST model in GSMA [here](https://www.gsma.com/newsroom/wp-content/uploads//NG.116-v9.0-1.pdf) \ No newline at end of file diff --git a/doc/naas/introduction.md b/doc/naas/introduction.md index 469b19ebf1985f368b6f04ada0a5fc45d4e6ffec..24f2edaa578b2c9496ebc8b007f02956530a2c4a 100644 --- a/doc/naas/introduction.md +++ b/doc/naas/introduction.md @@ -17,7 +17,7 @@ OpenSlice makes extensive use of TMFORUM's models and APIs. Therefore if one is To deliver NaaS we need to incorporate various APIs (see TMF909 API Suite Specification for NaaS). OpenSlice implements various TMF APIs to deliver NaaS and support the lifecycle functions required to manage the network capabilities exposed as Network as a Service and managed by operational domains. -## What's next +## Probe further * For a complete list of supported APIs, see [Supported APIs](exposed_apis.md) * Check the defined user roles of OpenSlice in our [Terminology](../terminology.md) \ No newline at end of file diff --git a/doc/naas/lcm_intro.md b/doc/naas/lcm_intro.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..63494fb49dcb0bfdd8b4c02da813e66819fade2b 100644 --- a/doc/naas/lcm_intro.md +++ b/doc/naas/lcm_intro.md @@ -0,0 +1,2 @@ + +- Lifecycle Management: The orchestration framework handles updates, scaling, and any necessary modifications throughout the service lifecycle. diff --git a/doc/naas/service_catalog.md b/doc/naas/service_catalog.md index a06a01a0662c9a80725c3f348d64be10182314ff..a11afbbd2e925e09815aa3e21b932a2ce01e51d3 100644 --- a/doc/naas/service_catalog.md +++ b/doc/naas/service_catalog.md @@ -44,7 +44,7 @@ Scenario: A service provider wants to offer a new managed XXXX service to enterp * Service Delivery/Order: Provision Service by Using the orchestration system to provision and configure the XXXX service based on customer orders. -## What's next +## Probe further * Read the model of Service Catalogs in TMF [TMF633 Service Catalog API User Guide v4.0.0](https://www.tmforum.org/resources/specification/tmf633-service-catalog-api-user-guide-v4-0-0/) * Check a demo of the API [here](http://portal.openslice.io/tmf-api/swagger-ui/index.html?urls.primaryName=tmf-api-633-ServiceCatalogManagement-v4.0.0) diff --git a/doc/naas/service_inventory.md b/doc/naas/service_inventory.md index f3f2f31b87da64c47774542320b8eaeb91945171..49c1fdca60183fc1e2c4f3d8e21b3fd385746930 100644 --- a/doc/naas/service_inventory.md +++ b/doc/naas/service_inventory.md @@ -28,7 +28,7 @@ endpoint examples: /serviceInventory/v4/service List or find Service objects -## What's next ## +## Probe further * See [Ordering Services from catalogs](../service_ordering/ordering_services.md) * See [Service Design](../service_design/intro.md) diff --git a/doc/naas/service_ordering.md b/doc/naas/service_ordering.md index f67e5abd635ad8c9fdd430df633a3b1c22b262d0..347091d334b0930e2ba0df2458e826c96167f366 100644 --- a/doc/naas/service_ordering.md +++ b/doc/naas/service_ordering.md @@ -19,7 +19,25 @@ Ongoing monitoring and other actions can be performed by the Life Cycle manageme <i>***Future developments***: In future releases it might be possible the ongoing monitoring and support provided to ensure continuous performance and reliability. The service could undergoe a series of tests to ensure it meets the specified performance metrics and SLAs before delivering</i> -## What's next ## +## UI management + +Through the menu and dedicated forms the administrator can manage the Service Orders. Various examples in this document will guide you to the usage and the management of the Service Orders. + +## API exposed + +When installing OpenSlice the API endpoints can be browsed at: +``` +[YOURDOMAIN]/tmf-api/swagger-ui/index.html?urls.primaryName=tmf-api-641-ServiceOrdering-v4.0.0 +``` + +endpoint examples: + +/serviceOrdering/v4/serviceOrder List or find ServiceOrder objects + + + + +## Probe further * See [Ordering Services from catalogs](../service_ordering/ordering_services.md) * See [Service Design](../service_design/intro.md) \ No newline at end of file diff --git a/doc/naas/service_spec.md b/doc/naas/service_spec.md index 792d8419a6656668c55698024ba5781acb365572..5a3289f205299a3f21197ac7e44e16254ab01099 100644 --- a/doc/naas/service_spec.md +++ b/doc/naas/service_spec.md @@ -63,7 +63,7 @@ Scenario: A service provider wants to offer a new managed XXXX service to enterp * Service Definition: Create a service specification template for the XXXX service, including specifications for bandwidth, network features, and performance metrics. -## What's next +## Probe further * Read the model of Service Catalogs in TMF [TMF633 Service Catalog API User Guide v4.0.0](https://www.tmforum.org/resources/specification/tmf633-service-catalog-api-user-guide-v4-0-0/) * Check a demo of the API [here](http://portal.openslice.io/tmf-api/swagger-ui/index.html?urls.primaryName=tmf-api-633-ServiceCatalogManagement-v4.0.0) diff --git a/doc/naas/so_intro.md b/doc/naas/so_intro.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..e3b01db8453c8f7fb150cafb0108bdbbb8b51d05 100644 --- a/doc/naas/so_intro.md +++ b/doc/naas/so_intro.md @@ -0,0 +1,10 @@ +# Service Orchestration + +- Service Orchestration: The orchestration engine evaluates the request, determines the necessary resources, and initiates the automated workflows.It interacts with underlying controller components (e.g. 5G Core, Radios, Containerized controllers, NFV, SDN controllers ) to provision and configure the required network functions and connectivity. + +## Intended Audience: Service Designers + +OpenSlice end-to-end (E2E) service orchestration framework is designed to manage and automate the entire lifecycle of services across multiple domains and technologies. For delivering, Network as a Service (NaaS) OpenSlice automates and manages the entire lifecycle of network services, from provisioning to monitoring and decommissioning, while ensuring seamless integration, operation, and delivery of services from the initial request to the final delivery, spanning all involved components and layers. + +This section provides an overview of the Service Orchestration process + diff --git a/doc/service_design/intro.md b/doc/service_design/intro.md index bae9fc8b0f9ca89100e2ae63185cc0bbee4dfb0b..b52ebe9afea788435070bb07e7ec2c68173e9586 100644 --- a/doc/service_design/intro.md +++ b/doc/service_design/intro.md @@ -9,7 +9,7 @@ Service Designers create detailed service specifications, which are then managed OpenSlice can be used to design service specifications for various services, even not networking related services. Here we cover how service designers can expose services related to the NFV world and the containerized world. -## What's next +## Probe further * [Design and expose services based on containerized resources via the Kubernetes Operator pattern](ExposingKubernetesResources.md) * [Design and expose services based on NFV artifacts](./nfv/design_nfv_services.md) diff --git a/doc/service_design/kubernetes/ExposingKubernetesResources.md b/doc/service_design/kubernetes/ExposingKubernetesResources.md index 441b5763bcff073110c1403edaa5b619d625552a..ade87388eb2de2f30ab269624f72f2b264040071 100644 --- a/doc/service_design/kubernetes/ExposingKubernetesResources.md +++ b/doc/service_design/kubernetes/ExposingKubernetesResources.md @@ -156,7 +156,7 @@ OpenSlice adds automatically as we see the following characteristics: --- -## What's next? +## Probe further - See examples of exposing operators via OpenSlice: