diff --git a/doc/service_design/catalogs.md b/doc/service_design/catalogs.md
index 41fbe1ad54c15dfb0dc99e5b6a3da696d3458bd4..5a73ea610fe66067bf9724d974333f1b449bfee5 100644
--- a/doc/service_design/catalogs.md
+++ b/doc/service_design/catalogs.md
@@ -1,74 +1,24 @@
# 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.
+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.
+### Create/Design a Customer Facing Service Specification (CFSS)
-### OSM NS LCM Status
+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 Specifications (CFSSs).
-When a Service is deployed, OpenSlice provides the ability to see the status messages from the NFVO. This status can be regarding NS instantiation, primitive execution, etc.
+While CFSSs can describe an overall offered service, it must also contain the related realization (how this service is going to be offered). Usually you create a CFSS as a bundle and then you include Service Specification Relationships with Resource Facing Service Specifications (RFSSs) or/and other CFSSs. A CFSS can include multiple RFSS or/and CFSs.
-Going to `ResourceFacingService (RFS)` -> `Contextual Features` -> `MANO NSLCM`, you will be able to see a beautified view of the status messages retrieved by OSM.
+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", a 5G eMBB Slice and a Customer VPN will be created during the order.
-<img src="../images/catalogs/mano_nslcm.png" alt="MANO NSLCM Section" width="700"/>
+### Assign Resources as Resource Facing Service Specifications (RFSSs)
-### Day 2 Primitive Actions
+The Resource Facing Service Specifation (RFSS) is the realization of the designed services. It utilizes specific resources to offer the described service.
-NFVOs like OSM allow to perform actions while a service is running, for example change attributes or make actions on a specific VNF.
-OpenSlice supports the invocation of day 2 primitives using Open Source MANO (OSM). This feature allows users to perform various actions while a service is running, such as changing attributes or executing specific actions on a Network Service's (NSD) Virtual Network Function (VNF). This capability enhances the flexibility and control over network services, making it easier to manage them in real-time.
-
-#### Invoking Primitives in OpenSlice
-
-To design and invoke primitives in OpenSlice, do the following steps:
-
-1. When a service is instantiated, go to its `ResourceFacingService (RFS)` -> `Contextual Features` -> `MANO Primitives List`;
- <img src="../images/catalogs/mano_primitives_list.png" alt="MANO Primitives List Section" width="700"/>
-
-2. There, you will find that VNF available primitives;
-3. Click on the `Execute Primitive` button of the chosen VNF;
-4. On the `Execute MANO Primitives` window:
- 1. Select the desired primitive on the `Primitive Parameter Name`;
- 2. Provide the `Primitive Parameter Value`;
-
- <img src="../images/catalogs/execute_mano_primitives.png" alt="Execute MANO Primitives Window" width="500"/>
-
-5. Click on the `Submit` button.
-
-After the previous steps, after a while, you should be able to see the status of the primitive execution above on the same page, on the `MANO NSLCM` section.
-
-> ***IMPORTANT NOTE:***
-As of now, OpenSlice still only supports the invoking of VNF-level primitives. We expect to have VDU-level primitives in the future.
+For instance, OpenSlice can utilize Kubernetes and NFV resource to deploy the respective services through the corresponding stack, as seen in [Probe further section](##probe-further).
@@ -113,28 +63,34 @@ On October 16th 2019 GSMA published NG.116 Version 2.0 which defines the Generi
- User data access
- V2X communication mode
-Openslice offers the GST in a format that is machine readable and aligned with the TMF SID model. Here is a tentative approach in JSON : <https://github.com/openslice/org.etsi.osl.tmf.api/blob/master/src/main/resources/gst.json>
+OpenSlice offers the GST in a format that is machine readable and aligned with the TMF SID model. Here is a tentative approach in JSON : <https://labs.etsi.org/rep/osl/code/org.etsi.osl.tmf.api/-/blob/main/src/main/resources/gst.json>
-Providers can clone a GST as e NEST directly in Openslice Web portal and the adjust the default attributes to their Service Specification
+Providers can clone a GST as e NEST directly in OpenSlice Web portal and the adjust the default attributes to their Service Specification.
## Manage a Service Specification
-You can manage them though the Web UI
+You may manage Service Specifications though the respective Web UI.
## Assign a Service Specification to Service Categories and Publish
-Just create categories and from the menu select the category and add services
+You may create Service Categories and from the menu provided to group Specifications under the same context, and then from the Service Category management UI you may assign Specifications to it.
+
+You cannot publish a Service Specification directly, but you may include the created Service Category into a public Service Catalog, which is exposed through the Service Marketplace. Doing so, all the assigned Service Specification to the Category are exposed and available for ordering, as well.
## Retire/Remove a Service Specification
-Delete it from the category
+Delete it from the assigned Service Category. This action does not delete the actual Service Specification, which can be done from the respective list.
## Consume and expose Service Specifications from other Service Catalogues
-See more on [Consuming Services From External Partner Organizations]( ../architecture/consumingServicesFromExternalPartners.md )
+See more on [Consuming Services From External Partner Organizations]( ../architecture/consumingServicesFromExternalPartners.md)
+
+## Probe further
+[Design Kubernetes-based Service Specifications](./kubernetes/ExposingKubernetesResources.md/)
+[Design NFV/OSM-based Service Specifications](./nfv/design_nfv_services.md)
diff --git a/doc/service_design/kubernetes/ExposingKubernetesResources.md b/doc/service_design/kubernetes/ExposingKubernetesResources.md
index d196c1790ec7c86d1fd2e5568ec0a0c02bd4ded9..e17df5f374b109c1eb95b5a22cd338025dff4a05 100644
--- a/doc/service_design/kubernetes/ExposingKubernetesResources.md
+++ b/doc/service_design/kubernetes/ExposingKubernetesResources.md
@@ -1,10 +1,17 @@
# Expose and manage Kubernetes Custom Resource Definitions (Operators) in a Kubernetes Cluster
-OpenSlice is capable of exposing Kubernetes Resources and Definitions as Service Specifications
+OpenSlice is capable of exposing Kubernetes Resources and Definitions as Service Specifications.
## Intended Audience: Service Designers
-
+
+Use OpenSlice to expose NFV resources in service catalogs and deploy them in complex scenarios (service bundles) involving also other systems:
+
+* Include external resources, e.g. RAN controllers
+* Manage multiple NSDs in linked NFVOs (OSM installations)
+* Combine designed services
+* Control the lifecycle of services and pass values from one service to another
+
> Kubernetes is an orchestration system for automating software deployment, scaling, and management. One can interact though the Kubernetes API and it has a set of objects ready for use out of the box. Custom Resource Definitions (CRDs) is a way that allows to manage things other than Kubernetes itself and allows to create our own objects The use of CRDs makes the possibilities of Kubernetes management almost limitless. You can extend the base Kubernetes API with any object you like using CRDs.
> By allowing the design and lifecycle management of services/resources that expose CRDs/CRs in a Kubernetes cluster via the TMF APIs, OSL can be used in many complex scenarios now involing resources from multiple domains.
@@ -28,7 +35,7 @@ OpenSlice is capable of exposing Kubernetes Resources and Definitions as Service
- OpenSlice can expose CRs in service catalogs, facilitating their deployment in complex scenarios.
- These scenarios may include service bundles that involve multiple systems, such as RAN controllers or other Kubernetes clusters, providing a robust and versatile deployment framework.
-# Approach
+## Approach
> OpenSlice in general is responible for exposing service specifications which are ready to be ordered and orchestrated, through tmforum Open APIs as defined in the OSL Service Spec Catalog. Usually for a service specification a corresponding (one or more) resource specification (resourceSpecificationReference) is registered in the OSL Resource Spec Catalog.
@@ -45,7 +52,7 @@ The following image illustrates the approach.
- Other related resources created by the CRD Controller within the namespace are automatically created in OSL Resource Inventory under the same Service Order
-# Awareness for CRDs and CRs in cluster
+## Awareness for CRDs and CRs in cluster
> CRDs and CRs can appear (disappear) or change status at any time in a cluster. OpenSlice Resource Inventory need to be aware of these events.
@@ -55,7 +62,7 @@ The following image illustrates the approach.
- After the registration of this cluster as a Resource in OSL OSL is always aware of all CRDs and their CRs in the cluster, even if a CRD or CR is added/updated/deleted in the K8S cluster outside of OSL
- Resources created by OpenSlice have labels, e.g. (org.etsi.osl.*)
-# Expose CRDs as Service Specifications in OpenSlice catalogs
+## Expose CRDs as Service Specifications in OpenSlice catalogs
**A CRD by default is exposed as a Resource Specification**
@@ -119,7 +126,7 @@ The following specific characteristics are **added**:
-# Service Orchestration and CRDs/CRs
+## Service Orchestration and CRDs/CRs
OSOM - OpenSlice Service Orchestrator, checks the presence of attribute _CR_SPEC at the RFS to make a request for a CR deployment
diff --git a/doc/service_design/nfv/design_nfv_services.md b/doc/service_design/nfv/design_nfv_services.md
index a376782caed3846b81cc0dcb45f3e5903d068a7f..b3d1f3d7a4cf98351bdcdea24c90676222cb7708 100644
--- a/doc/service_design/nfv/design_nfv_services.md
+++ b/doc/service_design/nfv/design_nfv_services.md
@@ -1 +1,83 @@
-_This section is WIP._
\ No newline at end of file
+# Design NFV services
+
+OpenSlice is capable of exposing NFV-related resources (VNFs/NSDs) as Service Specifications.
+
+## Intended Audience: Service Designers
+
+Use OpenSlice to expose NFV resources in service catalogs and deploy them in complex scenarios (service bundles) involving also other systems:
+
+* Include external resources, e.g. RAN controllers
+* Manage multiple NSDs in linked NFVOs (OSM installations)
+* Combine designed services
+* Control the lifecycle of services and pass values from one service to another
+
+## 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" box.
+
+## OSM NS LCM Status
+
+When a Service is deployed, OpenSlice provides the ability to see the status messages from the NFVO. This status can be regarding NS instantiation, primitive execution, etc.
+
+Going to `ResourceFacingService (RFS)` -> `Contextual Features` -> `MANO NSLCM`, you will be able to see a beautified view of the status messages retrieved by OSM.
+
+<img src="../../images/catalogs/mano_nslcm.png" alt="MANO NSLCM Section" width="700"/>
+
+## 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.
+OpenSlice supports the invocation of day 2 primitives using Open Source MANO (OSM). This feature allows users to perform various actions while a service is running, such as changing attributes or executing specific actions on a Network Service's (NSD) Virtual Network Function (VNF). This capability enhances the flexibility and control over network services, making it easier to manage them in real-time.
+
+### Design a Primitive to be automatically invoked
+
+This example involves a primitive invocation at a Service design level. It is usually used, if the designer wants to automatically invoke the Primitive at a specific landmark throughout the service's lifecycle via the LCM rules.
+
+1. Navigate to the RFSS related to the NSD that contains VNFs with primitives
+2. Create a characteristic named Primitive::<primitive> , e.g. Primitive::touch
+3. Select Value Type: ARRAY
+4. Add Service Characteristic Value:
+ 1) alias=primitive, value=<primitivename> (e.g. touch);
+ 2) alias=member_vnf_index, value=<vnf index> (e.g. 1);
+ 3) add the params that the LCM rule (or user) will change in alias the name of param and in value an initial value (e.g. alias=filename, value=myfile.txt);
+
+At the above example, when the service is running and the LCM rule (or user) MODIFIES it, i.e. changes the value of the alias=filename, value=myfile.txt, to value=secondfile.txt, the primitive will be executed. Then, inside the VNF a file will be created called secondfile.txt.
+
+### Manually invoke a Primitive
+
+Especially, for user-invoked primitives, OpenSlice offers a dedicated UI.
+
+To invoke primitives, do the following steps:
+
+1. When a service is instantiated, go to its `ResourceFacingService (RFS)` -> `Contextual Features` -> `MANO Primitives List`;
+
+ <img src="../../images/catalogs/mano_primitives_list.png" alt="MANO Primitives List Section" width="700"/>
+
+2. There, you will find that VNF available primitives;
+3. Click on the `Execute Primitive` button of the chosen VNF;
+4. On the `Execute MANO Primitives` window:
+ 1. Select the desired primitive on the `Primitive Parameter Name`;
+ 2. Provide the `Primitive Parameter Value`;
+
+ <img src="../../images/catalogs/execute_mano_primitives.png" alt="Execute MANO Primitives Window" width="500"/>
+
+5. Click on the `Submit` button.
+
+After the previous steps, after a while, you should be able to see the status of the primitive execution above on the same page, on the `MANO NSLCM` section.
+
+> ***IMPORTANT NOTE:***
+As of now, OpenSlice still only supports the invoking of VNF-level primitives. We expect to have VDU-level primitives in the future.
+