From cb1e130f3633f9a98f89cfd4df9b5d8b40920380 Mon Sep 17 00:00:00 2001
From: Kostis Trantzas <ktrantzas@ece.upatras.gr>
Date: Thu, 18 Jul 2024 13:12:08 +0300
Subject: [PATCH] Documentation housekeeping
---
doc/OpenSlice_deployment_examples.md | 19 +++++++-------
doc/etsi_osl.md | 4 +--
doc/history.md | 5 +---
doc/index.md | 11 ++++----
doc/naas/introduction.md | 2 +-
doc/naas/nfv/intro.md | 1 +
doc/naas/nfv/nfvcatalogs.md | 1 +
doc/naas/nfv/nfvservices.md | 24 +++++++++---------
doc/naas/resource_catalog.md | 4 ++-
doc/naas/resource_inventory.md | 1 +
doc/naas/resource_spec.md | 1 +
doc/naas/service_inventory.md | 4 +--
doc/naas/so_intro.md | 4 +--
.../so_servicespec_to_services_kubernetes.md | 1 +
doc/portals_intro.md | 16 ++++++------
.../HELM_Installation_aaS_Jenkins_Example.md | 0
.../img01.png | Bin
.../img02.png | Bin
.../img03.png | Bin
.../img04.png | Bin
.../img05.png | Bin
.../img06.png | Bin
.../img061.png | Bin
.../img07.png | Bin
.../img08.png | Bin
.../img09.png | Bin
doc/service_design/examples/intro.md | 1 +
doc/service_design/intro.md | 2 +-
doc/service_design/nfv/design_nfv_services.md | 1 +
mkdocs.yml | 2 +-
30 files changed, 56 insertions(+), 48 deletions(-)
rename doc/service_design/{kubernetes/helm => examples/helmInstallation_aaS_Example_Jenkins}/HELM_Installation_aaS_Jenkins_Example.md (100%)
rename doc/service_design/{kubernetes/helm => examples/helmInstallation_aaS_Example_Jenkins}/img01.png (100%)
rename doc/service_design/{kubernetes/helm => examples/helmInstallation_aaS_Example_Jenkins}/img02.png (100%)
rename doc/service_design/{kubernetes/helm => examples/helmInstallation_aaS_Example_Jenkins}/img03.png (100%)
rename doc/service_design/{kubernetes/helm => examples/helmInstallation_aaS_Example_Jenkins}/img04.png (100%)
rename doc/service_design/{kubernetes/helm => examples/helmInstallation_aaS_Example_Jenkins}/img05.png (100%)
rename doc/service_design/{kubernetes/helm => examples/helmInstallation_aaS_Example_Jenkins}/img06.png (100%)
rename doc/service_design/{kubernetes/helm => examples/helmInstallation_aaS_Example_Jenkins}/img061.png (100%)
rename doc/service_design/{kubernetes/helm => examples/helmInstallation_aaS_Example_Jenkins}/img07.png (100%)
rename doc/service_design/{kubernetes/helm => examples/helmInstallation_aaS_Example_Jenkins}/img08.png (100%)
rename doc/service_design/{kubernetes/helm => examples/helmInstallation_aaS_Example_Jenkins}/img09.png (100%)
diff --git a/doc/OpenSlice_deployment_examples.md b/doc/OpenSlice_deployment_examples.md
index 969aa2fa..1c21271e 100644
--- a/doc/OpenSlice_deployment_examples.md
+++ b/doc/OpenSlice_deployment_examples.md
@@ -2,11 +2,11 @@
Here are some examples from past and current efforts that use OpenSlice in various cases.
-## 5GinFIRE EU project(2018)
+## 5GinFIRE EU project (2018)
* MultiVIM approach
* 9 Testbeds
-* Automotive, Smart City, eHeath, PPDR, Media, SDR, Cloud
+* Automotive, Smart City, eHeath, PPDR, Media, SDR, Cloud
* 22 Experiment proposals from Verticals
* 100+ Users
* VxF catalog:
@@ -19,7 +19,7 @@ Here are some examples from past and current efforts that use OpenSlice in vario
* 500+ Deployment requests (orchestrations) performed
-[
+
## 5G-VINNI EU project (2020)
@@ -27,7 +27,7 @@ Here are some examples from past and current efforts that use OpenSlice in vario
* 5G services on multiple sites
* Introduction of TMFORUM models and APIs
-[
+
## 5GASP EU project (2021-2024)
@@ -36,14 +36,14 @@ Here are some examples from past and current efforts that use OpenSlice in vario
* Introducing Service Test models
* Introducing the Product models for a network application marketplace
-[
+
## FIDAL EU project (2023-)
* Support multi-site automated testing
* Multiple testbeds/ different APIs
-[
+
## ACROSS EU project (2023-)
@@ -52,13 +52,13 @@ Here are some examples from past and current efforts that use OpenSlice in vario
* Support Zero-touch provisioning concepts
-[
+
## INCODE EU project (2023-)
* Support the provisioning of end-to-end domain services
-[
+
## IMAGINEB5G EU project (2023-)
@@ -68,6 +68,7 @@ Here are some examples from past and current efforts that use OpenSlice in vario
## ETSI ZSM PoC #2
* Automated Network Slice Scaling in Multi-Site Environments
+* [See more](https://zsmwiki.etsi.org/index.php?title=PoC_2_Automated_Network_Slice_Scaling_in_Multi-Site_Environments)
-[
+
diff --git a/doc/etsi_osl.md b/doc/etsi_osl.md
index 862ca1d8..08f6df2a 100644
--- a/doc/etsi_osl.md
+++ b/doc/etsi_osl.md
@@ -1,3 +1,3 @@
-# The ETSi SDG OSL
+# The ETSI SDG OSL
-OpenSlice is developed by the OSL ETSI Software Development Group [see more info](https://osl.etsi.org/)
\ No newline at end of file
+OpenSlice is developed by the OSL ETSI Software Development Group [see more info](https://osl.etsi.org/).
\ No newline at end of file
diff --git a/doc/history.md b/doc/history.md
index 3b16cf52..5608a95f 100644
--- a/doc/history.md
+++ b/doc/history.md
@@ -1,4 +1,4 @@
-## History
+# History
* The NFV portal part of OpenSlice was initially developed in H2020 European Research project [5GinFIRE](https://5ginfire.eu) by University of Patras, Greece
* OpenSlice core services, APIs was further developed and maintained in H2020 European project [5G-VINNI](https://5g-vinni.eu/) by University of Patras, Greece
@@ -11,7 +11,6 @@
Please cite our [![paper]](https://arxiv.org/abs/2102.03290) if you use OpenSlice in your research
```
-
@misc{tranoris2021openslice,
title={Openslice: An opensource OSS for Delivering Network Slice as a Service},
author={Christos Tranoris},
@@ -20,6 +19,4 @@ Please cite our [![paper]](https://arxiv.org/abs/2102.03290) if you use OpenSlic
archivePrefix={arXiv},
primaryClass={cs.NI}
}
-
-
```
\ No newline at end of file
diff --git a/doc/index.md b/doc/index.md
index eb0d7755..b28ee108 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -70,17 +70,18 @@ There are various portals offering UI friendly access to users acting as Service
Check a live demo of OpenSlice in the following pages:
-(username=admin, password=openslice <br> or <br>username=admin, password=changeme)
-
* OpenSlice demo: <http://portal.openslice.io/>
* OpenSlice Service Catalogs and ordering: <http://portal.openslice.io/services/>
* OpenSlice NFV Services onboarding: <http://portal.openslice.io/nfvportal>
->
->
+
+Login credentials:
+
+* username=admin, password=openslice
+* username=admin, password=changeme
# Probe further
* Installing OpenSlice. See the [Deployment](deployment.md) of OpenSlice
-* Learn more on [how OpenSlice supports Network as a Service(NaaS)](./naas/introduction
+* 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/naas/introduction.md b/doc/naas/introduction.md
index a4783412..e986a8c7 100644
--- a/doc/naas/introduction.md
+++ b/doc/naas/introduction.md
@@ -11,7 +11,7 @@ This section describes some core concepts for Delivering Network as a Service in
In general Network as a Service (NaaS) is a service model that allows users to consume network infrastructure and services , similar to how they would consume other cloud services like Software as a Service (SaaS) or Infrastructure as a Service (IaaS). NaaS abstracts the complexity of managing physical network infrastructure, providing users with virtualized network resources that can be dynamically allocated and managed through software.
-# OpenSlice and NaaS
+## OpenSlice and NaaS
OpenSlice makes extensive use of TMFORUM's models and APIs. Therefore if one is familiar with TMF APIs the terminology and ideas are the same.
diff --git a/doc/naas/nfv/intro.md b/doc/naas/nfv/intro.md
index e69de29b..a376782c 100644
--- a/doc/naas/nfv/intro.md
+++ b/doc/naas/nfv/intro.md
@@ -0,0 +1 @@
+_This section is WIP._
\ No newline at end of file
diff --git a/doc/naas/nfv/nfvcatalogs.md b/doc/naas/nfv/nfvcatalogs.md
index e69de29b..a376782c 100644
--- a/doc/naas/nfv/nfvcatalogs.md
+++ b/doc/naas/nfv/nfvcatalogs.md
@@ -0,0 +1 @@
+_This section is WIP._
\ No newline at end of file
diff --git a/doc/naas/nfv/nfvservices.md b/doc/naas/nfv/nfvservices.md
index ad055840..ffa454d7 100644
--- a/doc/naas/nfv/nfvservices.md
+++ b/doc/naas/nfv/nfvservices.md
@@ -1,16 +1,16 @@
# NFV Services
-NFV Services are managed through a dedicate UI the NFV portal (eg http://portal.openslice.io/nfvportal)
+NFV Services are managed through a dedicated UI, i.e. the NFV portal (eg., [http://portal.openslice.io/nfvportal](http://portal.openslice.io/nfvportal)).
-Users are able through this portal to manage their NFV artifacts towards the NFVO, ( for example onboard VNFs and NSDs to a target OSM)
+Users are able through this portal to manage their NFV artifacts towards the NFVO (for example onboard VNFs and NSDs to a target OSM).
-Openslice NFV Services target to accommodate the following envisaged user roles. All users are assumed to be Authenticated:
+OpenSlice NFV Services target to accommodate the following envisaged user roles. All users are assumed to be Authenticated:
-* NFV developer: This role is responsible to upload VNF and NSD Descriptors in the Openslice services towards NFVO like OSM
-* Services administrator: This role represents the user that are responsible for maintenance of the Openslice services
+* NFV developer: This role is responsible to upload VNF and NSD Descriptors in the OpenSlice services towards NFVO, like OSM
+* Services administrator: This role represents the user that are responsible for maintenance of the OpenSlice services
-(obsolete: )
+(obsolete:)
* Testbed provider: This role represents users that are responsible for testbed administration, configuration, integration, adaptation, support, etc
* Experimenter: This role represents the user that will utilize our services and tools to deploy an experiment. That is the experiment description in terms of e.g.: NSD (Network Service Descriptor) or TOSCA Specification (in future versions)
@@ -21,12 +21,12 @@ Finally an anonymous user role exists who has some really simple usage scenarios
During the onboarding process the following occurs:
-• A NFV developer submits a NFV archive (VNF or NSD) (he can later manage if needed some metadata)
-• The administrator can manage the NFV artifact (e.g. edit it)
-• The administrator On-Boards the NFV artifact to the target MANO
-• The administrator can optionally mark the NFV:
-o As public in order to be publicly visible by all portal users
-o As Certified which means this is certified by a certain entity
+- A NFV developer submits a NFV archive (VNF or NSD) (he can later manage if needed some metadata)
+- The administrator can manage the NFV artifact (e.g. edit it)
+- The administrator On-Boards the NFV artifact to the target MANO
+- The administrator can optionally mark the NFV:
+- As public in order to be publicly visible by all portal users
+- As Certified which means this is certified by a certain entity
## Request a new NSD deployment (this is different in comparison to Services)
diff --git a/doc/naas/resource_catalog.md b/doc/naas/resource_catalog.md
index c7ac604d..145f6795 100644
--- a/doc/naas/resource_catalog.md
+++ b/doc/naas/resource_catalog.md
@@ -3,4 +3,6 @@
#OpenSlice Resource Catalog:
* Resource Specifications: Defines the underlying resources required to deliver services, such as network components, servers, and software.
- * Resource Availability: Tracks the availability and status of resources to ensure efficient service delivery.
\ No newline at end of file
+ * Resource Availability: Tracks the availability and status of resources to ensure efficient service delivery.
+
+_This section is WIP._
\ No newline at end of file
diff --git a/doc/naas/resource_inventory.md b/doc/naas/resource_inventory.md
index e69de29b..a376782c 100644
--- a/doc/naas/resource_inventory.md
+++ b/doc/naas/resource_inventory.md
@@ -0,0 +1 @@
+_This section is WIP._
\ No newline at end of file
diff --git a/doc/naas/resource_spec.md b/doc/naas/resource_spec.md
index e69de29b..a376782c 100644
--- a/doc/naas/resource_spec.md
+++ b/doc/naas/resource_spec.md
@@ -0,0 +1 @@
+_This section is WIP._
\ No newline at end of file
diff --git a/doc/naas/service_inventory.md b/doc/naas/service_inventory.md
index 49c1fdca..f162b499 100644
--- a/doc/naas/service_inventory.md
+++ b/doc/naas/service_inventory.md
@@ -1,6 +1,6 @@
# Service Inventory
-Service Inventory contains refences to running services that realize a Service Order
+Service Inventory contains references to running services that realize a Service Order.
## Intended Audience: Service Designers, OpenSlice administrators, Users
@@ -9,7 +9,7 @@ The Service Inventory is a repository that maintains detailed records of all act
This inventory enables real-time visibility into the status, configuration, and dependencies of each service, facilitating effective management, troubleshooting, and optimization.
-By providing a view of the active services, the Service Inventory includes services/resource allocation, and ensures that services are delivered in alignment with the inital requst.
+By providing a view of the active services, the Service Inventory includes services/resource allocation, and ensures that services are delivered in alignment with the initial request.
## UI management
diff --git a/doc/naas/so_intro.md b/doc/naas/so_intro.md
index 1feb6328..7e454bc6 100644
--- a/doc/naas/so_intro.md
+++ b/doc/naas/so_intro.md
@@ -1,12 +1,12 @@
# 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.
+Definition: 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.
-As next image depicts, service orchestrators follow some predefined workflows. OpenSlice end-to-end (E2E) service orchestrator follows some predefined workflows to manage a service lifecycle (They are described in BPMN language and included in our orchestration engine)
+As next image depicts, service orchestrators follow some predefined workflows. OpenSlice end-to-end (E2E) service orchestrator follows some predefined workflows to manage a service lifecycle (They are described in BPMN language and included in our orchestration engine).
[](./so/img01.png)
diff --git a/doc/naas/so_servicespec_to_services_kubernetes.md b/doc/naas/so_servicespec_to_services_kubernetes.md
index e69de29b..a376782c 100644
--- a/doc/naas/so_servicespec_to_services_kubernetes.md
+++ b/doc/naas/so_servicespec_to_services_kubernetes.md
@@ -0,0 +1 @@
+_This section is WIP._
\ No newline at end of file
diff --git a/doc/portals_intro.md b/doc/portals_intro.md
index 30255764..995cb5de 100644
--- a/doc/portals_intro.md
+++ b/doc/portals_intro.md
@@ -1,15 +1,15 @@
# OpenSlice Portals
-Openslice comprises of a web landing page [See Demo](http://portal.openslice.io/) that navigates to the respective Portal:
+OpenSlice comprises of a web landing page [(See Demo)](http://portal.openslice.io/) that navigates to the respective Portals:
-- Services Portal [See Demo](http://portal.openslice.io/services)
-- NFV Portal [See Demo](http://portal.openslice.io/nfvportal)
-- Products Portal [See Demo](http://portal.openslice.io/products)
-- Testing Portal [See Demo](http://portal.openslice.io/testing)
-- Resources Portal [See Demo](http://portal.openslice.io/resources)
+- Services Portal [(See Demo)](http://portal.openslice.io/services)
+- NFV Portal [(See Demo)](http://portal.openslice.io/nfvportal)
+- Products Portal [(See Demo)](http://portal.openslice.io/products)
+- Testing Portal [(See Demo)](http://portal.openslice.io/testing)
+- Resources Portal [(See Demo)](http://portal.openslice.io/resources)
-Following you may find the scope each portal focuses on and the main TMF APIs it supports.
+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.
@@ -44,4 +44,4 @@ More information can be found at [NFV Services](./naas/nfv/nfvservices.md).
|**Testing Portal** | |x | | | | | | | |x | |
|**Resources Portal** | |x | |x | |x | | | | |x |
-The NFV Portal uses a proprietary API
\ No newline at end of file
+The NFV Portal uses a proprietary API.
\ No newline at end of file
diff --git a/doc/service_design/kubernetes/helm/HELM_Installation_aaS_Jenkins_Example.md b/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/HELM_Installation_aaS_Jenkins_Example.md
similarity index 100%
rename from doc/service_design/kubernetes/helm/HELM_Installation_aaS_Jenkins_Example.md
rename to doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/HELM_Installation_aaS_Jenkins_Example.md
diff --git a/doc/service_design/kubernetes/helm/img01.png b/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img01.png
similarity index 100%
rename from doc/service_design/kubernetes/helm/img01.png
rename to doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img01.png
diff --git a/doc/service_design/kubernetes/helm/img02.png b/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img02.png
similarity index 100%
rename from doc/service_design/kubernetes/helm/img02.png
rename to doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img02.png
diff --git a/doc/service_design/kubernetes/helm/img03.png b/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img03.png
similarity index 100%
rename from doc/service_design/kubernetes/helm/img03.png
rename to doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img03.png
diff --git a/doc/service_design/kubernetes/helm/img04.png b/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img04.png
similarity index 100%
rename from doc/service_design/kubernetes/helm/img04.png
rename to doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img04.png
diff --git a/doc/service_design/kubernetes/helm/img05.png b/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img05.png
similarity index 100%
rename from doc/service_design/kubernetes/helm/img05.png
rename to doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img05.png
diff --git a/doc/service_design/kubernetes/helm/img06.png b/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img06.png
similarity index 100%
rename from doc/service_design/kubernetes/helm/img06.png
rename to doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img06.png
diff --git a/doc/service_design/kubernetes/helm/img061.png b/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img061.png
similarity index 100%
rename from doc/service_design/kubernetes/helm/img061.png
rename to doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img061.png
diff --git a/doc/service_design/kubernetes/helm/img07.png b/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img07.png
similarity index 100%
rename from doc/service_design/kubernetes/helm/img07.png
rename to doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img07.png
diff --git a/doc/service_design/kubernetes/helm/img08.png b/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img08.png
similarity index 100%
rename from doc/service_design/kubernetes/helm/img08.png
rename to doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img08.png
diff --git a/doc/service_design/kubernetes/helm/img09.png b/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img09.png
similarity index 100%
rename from doc/service_design/kubernetes/helm/img09.png
rename to doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img09.png
diff --git a/doc/service_design/examples/intro.md b/doc/service_design/examples/intro.md
index e69de29b..1c763ca2 100644
--- a/doc/service_design/examples/intro.md
+++ b/doc/service_design/examples/intro.md
@@ -0,0 +1 @@
+This section contains examples on service design, which contain a step-by-step guide to reproduce them in your local environment.
\ No newline at end of file
diff --git a/doc/service_design/intro.md b/doc/service_design/intro.md
index b52ebe9a..d3ba61cd 100644
--- a/doc/service_design/intro.md
+++ b/doc/service_design/intro.md
@@ -11,7 +11,7 @@ OpenSlice can be used to design service specifications for various services, eve
## Probe further
-* [Design and expose services based on containerized resources via the Kubernetes Operator pattern](ExposingKubernetesResources.md)
+* [Design and expose services based on containerized resources via the Kubernetes Operator pattern](./kubernetes/ExposingKubernetesResources.md)
* [Design and expose services based on NFV artifacts](./nfv/design_nfv_services.md)
diff --git a/doc/service_design/nfv/design_nfv_services.md b/doc/service_design/nfv/design_nfv_services.md
index e69de29b..a376782c 100644
--- a/doc/service_design/nfv/design_nfv_services.md
+++ b/doc/service_design/nfv/design_nfv_services.md
@@ -0,0 +1 @@
+_This section is WIP._
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 3774374e..cccde1c6 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -128,7 +128,7 @@ nav:
- Open5GS (NFV approach): ./service_design/examples/open5gs_nfv.md
- Open5GS (Kubernetes approach): ./service_design/examples/open5gs_kubernetes.md
- Exposing CRDs_aaS_Example_Calculator: ./service_design/examples/ExposingCRDs_aaS_Example_Calculator/ExposingCRDs_aaS_Example_Calculator.md
- - HELM Installation aaS Jenkins Example: ./service_design/kubernetes/helm/HELM_Installation_aaS_Jenkins_Example.md
+ - HELM Installation aaS Jenkins Example: ./service_design\examples\helmInstallation_aaS_Example_Jenkins/HELM_Installation_aaS_Jenkins_Example.md
- Service Ordering:
- Ordering Services from catalogs: ./service_ordering/ordering_services.md
- Testing services:
--
GitLab