diff --git a/doc/architecture/CRIDGE/CRIDGEforDevelopers.md b/doc/architecture/CRIDGE/cridge_introduction.md similarity index 100% rename from doc/architecture/CRIDGE/CRIDGEforDevelopers.md rename to doc/architecture/CRIDGE/cridge_introduction.md diff --git a/doc/architecture/architecture.md b/doc/architecture/architecture.md index 7f7e723c2c81ebe74413d5c22bb53174f884140e..760485600b46529cca9d793b3ea0d6c80f8cadb0 100644 --- a/doc/architecture/architecture.md +++ b/doc/architecture/architecture.md @@ -57,4 +57,4 @@ The following figure shows how openslice could be used in such scenarios: [](../getting_started/configuration/images/multi-domain-architecture.png) -See more [Consuming Services From External Partner Organizations](../getting_started/configuration/consumingServicesFromExternalPartners.md). \ No newline at end of file +See more [Consuming Services From External Partner Organizations](../getting_started/configuration/consuming_services_from_external_partners.md). \ No newline at end of file diff --git a/doc/OpenSlice_deployment_examples.md b/doc/deployment_examples.md similarity index 100% rename from doc/OpenSlice_deployment_examples.md rename to doc/deployment_examples.md diff --git a/doc/config_intro.md b/doc/getting_started/configuration/config_intro.md similarity index 100% rename from doc/config_intro.md rename to doc/getting_started/configuration/config_intro.md diff --git a/doc/getting_started/configuration/consumingServicesFromExternalPartners.md b/doc/getting_started/configuration/consuming_services_from_external_partners.md similarity index 100% rename from doc/getting_started/configuration/consumingServicesFromExternalPartners.md rename to doc/getting_started/configuration/consuming_services_from_external_partners.md diff --git a/doc/nfvoconfig.md b/doc/getting_started/configuration/nfvo_config.md similarity index 98% rename from doc/nfvoconfig.md rename to doc/getting_started/configuration/nfvo_config.md index 0cd2c77887fb274c77f845082213436dd302f309..639df650ac8153a38371cb57cb2f3c74ab6bbb4c 100644 --- a/doc/nfvoconfig.md +++ b/doc/getting_started/configuration/nfvo_config.md @@ -1,4 +1,4 @@ -# NFV Orchestrator configuration +# NFV Orchestrator Configuration > Currently we support Open Source MANO version EIGHT/NINE/TEN/ELEVEN/THIRTEEN. Later versions of OSM may also be supported by the existing configuration, as from OSM 9+ the project converged to the SOL005 interface, regarding the NBI, and SOL006 (YANG model), regarding the NFV/NS packaging. Also an implementation of a generic SOL005 interface is supported, but not extensively tested. diff --git a/doc/deploymentCompose.md b/doc/getting_started/deployment/docker_compose.md similarity index 99% rename from doc/deploymentCompose.md rename to doc/getting_started/deployment/docker_compose.md index a2ed9a614ade138ebfd19a426fe073dde04b9aaf..f0c008e020f38ec84a7b1fba674908f0b83f17ca 100644 --- a/doc/deploymentCompose.md +++ b/doc/getting_started/deployment/docker_compose.md @@ -547,4 +547,4 @@ appConfig.factory('APIEndPointService', function() { After successfully deploying and configuring OpenSlice, you may configure its environment (e.g. the NFVO) that will facilitate the deployment of NFV artifacts. -See [NFV Orchestrator Configuration](./nfvoconfig.md). +See [NFV Orchestrator Configuration](../configuration/nfvo_config.md). diff --git a/doc/deployment.md b/doc/getting_started/deployment/introduction.md similarity index 66% rename from doc/deployment.md rename to doc/getting_started/deployment/introduction.md index 79f8697dbdeb85e5856aecec7f620a4b36760267..ff2889baa3eb91b7eecb2c326152f29ffcc54443 100644 --- a/doc/deployment.md +++ b/doc/getting_started/deployment/introduction.md @@ -6,6 +6,6 @@ This section is meant to guide the user through the installation of OpenSlice. Following, you may thorough guides depending on the installation type of your choice: -- [Installing via Docker Compose guide](./deploymentCompose.md) -- [Installing via Kubernetes guide](./deploymentK8s.md) +- [Installing via Docker Compose guide](./docker_compose.md) +- [Installing via Kubernetes guide](./kubernetes.md) diff --git a/doc/deploymentK8s.md b/doc/getting_started/deployment/kubernetes.md similarity index 99% rename from doc/deploymentK8s.md rename to doc/getting_started/deployment/kubernetes.md index fb00ad90bb1f43977f2b1a833da846cd8894d26b..62be5e1284948e02fb5c5fc4ea339213208f89d3 100644 --- a/doc/deploymentK8s.md +++ b/doc/getting_started/deployment/kubernetes.md @@ -526,4 +526,4 @@ This step is mandatory so as to access the OpenSlice Web UI. To add an OpenSlice After successfully deploying and configuring OpenSlice, you may configure its environment (e.g. the NFVO) that will facilitate the deployment of NFV artifacts. -See [NFV Orchestrator Configuration](./nfvoconfig.md). \ No newline at end of file +See [NFV Orchestrator Configuration](../configuration/nfvo_config.md). \ No newline at end of file diff --git a/doc/portals_intro.md b/doc/getting_started/portals.md similarity index 97% rename from doc/portals_intro.md rename to doc/getting_started/portals.md index 426a1fb9cb7492f3b2af65d4044e742a79964352..f118b49ac4a846ffbf7195a936c8d93c1bd7caf5 100644 --- a/doc/portals_intro.md +++ b/doc/getting_started/portals.md @@ -22,7 +22,7 @@ Indicatively, the portal can be used to: - 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](./naas/nfv/nfvservices.md). +More information can be found at [NFV Services](../naas/nfv/nfvservices.md). **Resources Portal** is a designated portal for the: - Resource Administrator - To view the available Resources that are being synchronized from the underlying infrastructure. diff --git a/doc/index.md b/doc/index.md index a196cf0b2bd957a7344cf823ebe297507b1fd7ae..46d6023f0273454e92375e5536f3f9fd6c80723c 100644 --- a/doc/index.md +++ b/doc/index.md @@ -85,7 +85,7 @@ Login credentials: ## Probe further * How OpenSlice works? See the [Architecture](./architecture/architecture.md) section -* Installing OpenSlice? See the [Deployment](deployment.md) section +* Installing OpenSlice? See the [Deployment](./getting_started/deployment/introduction.md) section * Learn more on [how OpenSlice supports Network as a Service(NaaS)](./naas/introduction.md) * Who is maintaining OpenSlice? See [OSL ETSI SDG](https://osl.etsi.org/) diff --git a/doc/service_design/catalogs.md b/doc/service_design/catalogs.md index e98d9468e4eb5df9a0e1b5a96456523c66fac2d7..b34701caef6638c277f43d3257a2e4f8c509cdd9 100644 --- a/doc/service_design/catalogs.md +++ b/doc/service_design/catalogs.md @@ -87,10 +87,10 @@ Delete it from the assigned Service Category. This action does not delete the ac ## Consume and expose Service Specifications from other Service Catalogues -See more on [Consuming Services From External Partner Organizations]( ../getting_started/configuration/consumingServicesFromExternalPartners.md). +See more on [Consuming Services From External Partner Organizations]( ../getting_started/configuration/consuming_services_from_external_partners.md). ## Probe further -[Design Kubernetes-based Service Specifications](./kubernetes/ExposingKubernetesResources.md/) +[Design Kubernetes-based Service Specifications](./kubernetes/exposing_kubernetes_resources.md/) [Design NFV/OSM-based Service Specifications](./nfv/design_nfv_services.md) diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/ExposingCRDs_aaS_Example_Calculator.md b/doc/service_design/examples/calculator_crd_aas/calculator_crd_aas.md similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/ExposingCRDs_aaS_Example_Calculator.md rename to doc/service_design/examples/calculator_crd_aas/calculator_crd_aas.md diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/cfs_img12.png b/doc/service_design/examples/calculator_crd_aas/cfs_img12.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/cfs_img12.png rename to doc/service_design/examples/calculator_crd_aas/cfs_img12.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img07.png b/doc/service_design/examples/calculator_crd_aas/img07.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img07.png rename to doc/service_design/examples/calculator_crd_aas/img07.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img08.png b/doc/service_design/examples/calculator_crd_aas/img08.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img08.png rename to doc/service_design/examples/calculator_crd_aas/img08.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img09.png b/doc/service_design/examples/calculator_crd_aas/img09.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img09.png rename to doc/service_design/examples/calculator_crd_aas/img09.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img10.png b/doc/service_design/examples/calculator_crd_aas/img10.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img10.png rename to doc/service_design/examples/calculator_crd_aas/img10.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img11.png b/doc/service_design/examples/calculator_crd_aas/img11.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img11.png rename to doc/service_design/examples/calculator_crd_aas/img11.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img12.png b/doc/service_design/examples/calculator_crd_aas/img12.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img12.png rename to doc/service_design/examples/calculator_crd_aas/img12.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img13.png b/doc/service_design/examples/calculator_crd_aas/img13.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img13.png rename to doc/service_design/examples/calculator_crd_aas/img13.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img13_1.png b/doc/service_design/examples/calculator_crd_aas/img13_1.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img13_1.png rename to doc/service_design/examples/calculator_crd_aas/img13_1.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img14.png b/doc/service_design/examples/calculator_crd_aas/img14.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img14.png rename to doc/service_design/examples/calculator_crd_aas/img14.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img15.png b/doc/service_design/examples/calculator_crd_aas/img15.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img15.png rename to doc/service_design/examples/calculator_crd_aas/img15.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img16.png b/doc/service_design/examples/calculator_crd_aas/img16.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img16.png rename to doc/service_design/examples/calculator_crd_aas/img16.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img17.png b/doc/service_design/examples/calculator_crd_aas/img17.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img17.png rename to doc/service_design/examples/calculator_crd_aas/img17.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img18.png b/doc/service_design/examples/calculator_crd_aas/img18.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img18.png rename to doc/service_design/examples/calculator_crd_aas/img18.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img19.png b/doc/service_design/examples/calculator_crd_aas/img19.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img19.png rename to doc/service_design/examples/calculator_crd_aas/img19.png diff --git a/doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img20.png b/doc/service_design/examples/calculator_crd_aas/img20.png similarity index 100% rename from doc/service_design/examples/ExposingCRDs_aaS_Example_Calculator/img20.png rename to doc/service_design/examples/calculator_crd_aas/img20.png diff --git a/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img01.png b/doc/service_design/examples/jenkins_helm_install_aas/img01.png similarity index 100% rename from doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img01.png rename to doc/service_design/examples/jenkins_helm_install_aas/img01.png diff --git a/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img02.png b/doc/service_design/examples/jenkins_helm_install_aas/img02.png similarity index 100% rename from doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img02.png rename to doc/service_design/examples/jenkins_helm_install_aas/img02.png diff --git a/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img03.png b/doc/service_design/examples/jenkins_helm_install_aas/img03.png similarity index 100% rename from doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img03.png rename to doc/service_design/examples/jenkins_helm_install_aas/img03.png diff --git a/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img04.png b/doc/service_design/examples/jenkins_helm_install_aas/img04.png similarity index 100% rename from doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img04.png rename to doc/service_design/examples/jenkins_helm_install_aas/img04.png diff --git a/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img05.png b/doc/service_design/examples/jenkins_helm_install_aas/img05.png similarity index 100% rename from doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img05.png rename to doc/service_design/examples/jenkins_helm_install_aas/img05.png diff --git a/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img06.png b/doc/service_design/examples/jenkins_helm_install_aas/img06.png similarity index 100% rename from doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img06.png rename to doc/service_design/examples/jenkins_helm_install_aas/img06.png diff --git a/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img061.png b/doc/service_design/examples/jenkins_helm_install_aas/img061.png similarity index 100% rename from doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img061.png rename to doc/service_design/examples/jenkins_helm_install_aas/img061.png diff --git a/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img07.png b/doc/service_design/examples/jenkins_helm_install_aas/img07.png similarity index 100% rename from doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img07.png rename to doc/service_design/examples/jenkins_helm_install_aas/img07.png diff --git a/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img08.png b/doc/service_design/examples/jenkins_helm_install_aas/img08.png similarity index 100% rename from doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img08.png rename to doc/service_design/examples/jenkins_helm_install_aas/img08.png diff --git a/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img09.png b/doc/service_design/examples/jenkins_helm_install_aas/img09.png similarity index 100% rename from doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/img09.png rename to doc/service_design/examples/jenkins_helm_install_aas/img09.png diff --git a/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/HELM_Installation_aaS_Jenkins_Example.md b/doc/service_design/examples/jenkins_helm_install_aas/jenkins_helm_install_aas.md similarity index 98% rename from doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/HELM_Installation_aaS_Jenkins_Example.md rename to doc/service_design/examples/jenkins_helm_install_aas/jenkins_helm_install_aas.md index 4daeb8e6b1a66acf1531b69be9d778c563c24038..dae3315444d107f8acf7056c59731234a7c44610 100644 --- a/doc/service_design/examples/helmInstallation_aaS_Example_Jenkins/HELM_Installation_aaS_Jenkins_Example.md +++ b/doc/service_design/examples/jenkins_helm_install_aas/jenkins_helm_install_aas.md @@ -2,7 +2,7 @@ ## Design the Jenkins (Resource-Facing) Service -Before reading this example please make sure that you went through the [Design Helm as a Service](../../kubernetes/helm/design_helmaas.md) +Before reading this example please make sure that you went through the [Design Helm as a Service](../../kubernetes/design_helm_aas.md) In this example, we will use the ```Kind: Application``` of ArgoCD and create a ResourceFacingServiceSpecification (RFSS) for Jenkins. Eventually, we will offer Jenkins as a Service. diff --git a/doc/service_design/intro.md b/doc/service_design/intro.md index 395d0258bc512a7a992fea3539dbed40906bc3e8..140c814639d6ed88eff06dfb17034240f06794b0 100644 --- a/doc/service_design/intro.md +++ b/doc/service_design/intro.md @@ -12,7 +12,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](./kubernetes/ExposingKubernetesResources.md) +* [Design and expose services based on containerized resources via the Kubernetes Operator pattern](./kubernetes/exposing_kubernetes_resources.md) * [Design and expose services based on NFV artifacts](./nfv/design_nfv_services.md) diff --git a/doc/service_design/kubernetes/helm/design_helmaas.md b/doc/service_design/kubernetes/design_helm_aas.md similarity index 85% rename from doc/service_design/kubernetes/helm/design_helmaas.md rename to doc/service_design/kubernetes/design_helm_aas.md index 23271e92ad760e30c6d7219893125d8fd6e14128..3a8924e29a7c76d9a3bb4224c6cbbb3a5f5f807a 100644 --- a/doc/service_design/kubernetes/helm/design_helmaas.md +++ b/doc/service_design/kubernetes/design_helm_aas.md @@ -1,6 +1,6 @@ -# Expose HELM charts as Service Specifications +# Expose Helm charts as Service Specifications -**Intended Audience: OpenSlice ervice Designers** +**Intended Audience: OpenSlice Service Designers** This section introduces ways to manage Helm charts installations via OpenSlice Service Specifications and Service Orders. @@ -8,7 +8,7 @@ This section introduces ways to manage Helm charts installations via OpenSlice S 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. -Helm is a tool that automates the creation, packaging, configuration, and deployment of Kubernetes applications by combining your configuration files into a single reusable package +Helm is a tool that automates the creation, packaging, configuration, and deployment of Kubernetes applications by combining your configuration files into a single reusable package. At the heart of Helm is the packaging format called charts. Each chart comprises one or more Kubernetes manifests -- and a given chart can have child charts and dependent charts, as well. Using Helm charts: @@ -33,7 +33,7 @@ Also, OpenSlice can expose them in service catalogs and deploy them in complex s ## The installation of HELM charts is based on OpenSlice CRD support -Please read more [here](../ExposingKubernetesResources.md). +Please read more [here](./exposing_kubernetes_resources.md). For installing HELM charts we will use ArgoCD a well known Kubernetes-native continuous deployment (CD) tool. @@ -57,8 +57,8 @@ Browse to Resource Specifications. You will see an entry like the following: see image: - + ## Probe further -See the [Example: Offer Jenkins as a Service via OpenSlice](../../examples/helmInstallation_aaS_Example_Jenkins/HELM_Installation_aaS_Jenkins_Example.md) +See the [Example: Offer Jenkins as a Service via OpenSlice](../examples/jenkins_helm_install_aas/jenkins_helm_install_aas.md) diff --git a/doc/service_design/kubernetes/ExposingKubernetesResources.md b/doc/service_design/kubernetes/exposing_kubernetes_resources.md similarity index 64% rename from doc/service_design/kubernetes/ExposingKubernetesResources.md rename to doc/service_design/kubernetes/exposing_kubernetes_resources.md index 846032f29d8fecd112fb257d90bebf35be545a2b..5eba68457f7ffaaa69954de0f81a381bdcfb8c7d 100644 --- a/doc/service_design/kubernetes/ExposingKubernetesResources.md +++ b/doc/service_design/kubernetes/exposing_kubernetes_resources.md @@ -12,45 +12,6 @@ Use OpenSlice to expose NFV resources in service catalogs and deploy them in com * 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, OpenSlice can be used in many complex scenarios now involving resources from multiple domains. - - -1. OpenSlice is capable to: - - Create and manage Custom Resources (CRs) using installed CRDs on a target Kubernetes cluster. - - Facilitate complex orchestration scenarios by wrapping Kubernetes APIs as TMF APIs and models. - - Handles connectivity to a Kubernetes cluster and manages the lifecycle of CRDs - - Wraps the Kubernetes API, Receives and provides resources towards other OpenSlice services via the service bus - -2. Enabling Loose Coupling and Orchestration - - Language Flexibility: Developers can write CRDs in any language and expose them via the Kubernetes APIs. OSL will reuse these CRDs, enhancing flexibility and integration capabilities. - - Familiar Deployment: Developers can create and deploy applications using familiar tools such as Helm charts, simplifying the process and reducing the learning curve. - -3. Ecosystem Reusability - - OpenSlice capitalizes on the extensive Kubernetes ecosystem, particularly focusing on operators (CRDs). - - Key repositories and hubs such as artifacthub.io and Operatorhub.io can be utilized for finding and deploying operators. - -4. Service Catalog Exposure and Deployment - - 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 - -In gerenal, OpenSlice is responsible 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. - -The following image illustrates the approach. - - - - -1. A CRD in a cluster will be mapped in TMF model as a Resource specification and therefore can be exposed as a service specification in a catalog -2. Service Orders can be created for this service specification. -3. OSOM creates a Resource in OSL Resource inventory and requests new Custom Resource (CR) in the target cluster - - The resource is created in a specific namespace (for example the UUID of the Service Order) - - A CR in a cluster will be mapped in TMF model as a Resource in the resource Inventory - - 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 @@ -171,9 +132,9 @@ OpenSlice adds automatically as we see the following characteristics: ## Probe further - See examples of exposing Kubernetes Operators as a Service via OpenSlice: - - [Offering "Calculator as a Service"](../examples/ExposingCRDs_aaS_Example_Calculator/ExposingCRDs_aaS_Example_Calculator.md) - - [Offering "Helm installation as a Service" (Jenkins example)](../examples/helmInstallation_aaS_Example_Jenkins/HELM_Installation_aaS_Jenkins_Example.md) -- [Learn more about CRIDGE, the service in OpenSlice that manages CRDs/CRs](../../architecture/CRIDGE/CRIDGEforDevelopers.md) + - [Offering "Calculator as a Service"](../examples/calculator_crd_aas/calculator_crd_aas.md) + - [Offering "Helm installation as a Service" (Jenkins example)](../examples/jenkins_helm_install_aas/jenkins_helm_install_aas.md) +- [Learn more about CRIDGE, the service in OpenSlice that manages CRDs/CRs](../../architecture/cridge/cridge_introduction.md) diff --git a/mkdocs.yml b/mkdocs.yml index c1e8ad5cd12b19b39cfc0336f24ef690129c43a3..04889f5050546edbee0f9dfdef4074ee249b22b4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -81,22 +81,21 @@ extra: nav: - Overview: - Introduction: index.md - - OpenSlice deployment examples: OpenSlice_deployment_examples.md + - Deployment examples: deployment_examples.md - History: history.md - - ETSI OSL: etsi_osl.md + - OpenSlice under ETSI: etsi_osl.md - Getting Started: - Deployment: - - Introduction: deployment.md - - Docker Compose: deploymentCompose.md - - Kubernetes: deploymentK8s.md - - Portals: - - Introduction: portals_intro.md + - Introduction: ./getting_started/deployment/introduction.md + - Docker Compose: ./getting_started/deployment/docker_compose.md + - Kubernetes: ./getting_started/deployment/kubernetes.md + - Portals: ./getting_started/portals.md - Configuration/Management: - - Introduction: config_intro.md + - Introduction: ./getting_started/configuration/config_intro.md - Role/Keycloak management: role_keycloak_management.md - - NFV Orchestrator Configuration: nfvoconfig.md + - NFV Orchestrator Configuration: ./getting_started/configuration/nfvo_config.md - Advanced topics: - - Consuming Services From External OSS: ./getting_started/configuration/consumingServicesFromExternalPartners.md + - Consuming Services From External OSS: ./getting_started/configuration/consuming_services_from_external_partners.md - NaaS: - Introduction: ./naas/introduction.md - Services: @@ -125,20 +124,20 @@ nav: - Catalogs: ./service_design/catalogs.md - Support for Kubernetes: - Introduction: ./service_design/kubernetes/intro.md - - Exposing Kubernetes Resources: ./service_design/kubernetes/ExposingKubernetesResources.md - - Design Helm as a Service: ./service_design/kubernetes/helm/design_helmaas.md + - Exposing Kubernetes Resources: ./service_design/kubernetes/exposing_kubernetes_resources.md + - Design Helm as a Service: ./service_design/kubernetes/design_helm_aas.md - Support for NFV: - Design NFV Services: ./service_design/nfv/design_nfv_services.md - LCM Rules: - Introduction: ./service_design/lcmrules/intro.md - Specification: ./service_design/lcmrules/specification.md - Typical Examples: ./service_design/lcmrules/examples.md - - Service Specification Examples: + - Examples: - Introduction: ./service_design/examples/intro.md # - 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/examples/helmInstallation_aaS_Example_Jenkins/HELM_Installation_aaS_Jenkins_Example.md + - Calculator CRD aaS: ./service_design/examples/calculator_crd_aas/calculator_crd_aas.md + - Jenkins Helm Installation aaS : ./service_design/examples/jenkins_helm_install_aas/jenkins_helm_install_aas.md - Service Ordering: - Ordering Services from catalogs: ./service_ordering/ordering_services.md # - Testing services: @@ -154,9 +153,7 @@ nav: # - Alarms and Actions: ./assurance_services/alarms_actions.md - Design & Architecture: - Architecture: ./architecture/architecture.md - - Cloud native support: - # - Introduction: ./architecture/CRIDGE_cloud_native_intro.md - - CRIDGE for Developers: ./architecture/CRIDGE/CRIDGEforDevelopers.md + - CRIDGE: ./architecture/cridge/cridge_introduction.md - Message bus: ./architecture/messagebus.md - OSOM: ./architecture/osom.md - Authentication: ./architecture/oauth.md