Commit dc299104 authored by Dimitrios Giannopoulos's avatar Dimitrios Giannopoulos
Browse files

Deployed 023e9f9f to 2024Q2 in public with MkDocs 1.6.0 and mike 2.1.2

parent e29dc8b4

public/2024Q2/deploymentCompose/index.html

+67 −11
Original line number Diff line number Diff line
@@ -670,18 +670,27 @@ 
</li>

        

          <li class="md-nav__item">

  <a href="#5-configure-osportalapi-container-nfv-services-conditional" class="md-nav__link">

  <a href="#5-configure-cridge-container-optional" class="md-nav__link">

    <span class="md-ellipsis">

      5. Configure osportalapi container (NFV services) (conditional)

      5. Configure CRIDGE container (optional)

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#6-osscapi-container-tmf-api-service-conditional" class="md-nav__link">

  <a href="#6-configure-osportalapi-container-nfv-services-conditional" class="md-nav__link">

    <span class="md-ellipsis">

      6. osscapi container (TMF API service) (conditional)

      6. Configure osportalapi container (NFV services) (conditional)

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#7-configure-osscapi-container-tmf-api-service-conditional" class="md-nav__link">

    <span class="md-ellipsis">

      7. Configure osscapi container (TMF API service) (conditional)

    </span>

  </a>
@@ -3190,18 +3199,27 @@ 
</li>

        

          <li class="md-nav__item">

  <a href="#5-configure-osportalapi-container-nfv-services-conditional" class="md-nav__link">

  <a href="#5-configure-cridge-container-optional" class="md-nav__link">

    <span class="md-ellipsis">

      5. Configure osportalapi container (NFV services) (conditional)

      5. Configure CRIDGE container (optional)

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#6-osscapi-container-tmf-api-service-conditional" class="md-nav__link">

  <a href="#6-configure-osportalapi-container-nfv-services-conditional" class="md-nav__link">

    <span class="md-ellipsis">

      6. osscapi container (TMF API service) (conditional)

      6. Configure osportalapi container (NFV services) (conditional)

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#7-configure-osscapi-container-tmf-api-service-conditional" class="md-nav__link">

    <span class="md-ellipsis">

      7. Configure osscapi container (TMF API service) (conditional)

    </span>

  </a>
@@ -3483,7 +3501,45 @@ DB_PASSWORD: password 
<li>VPN Credentials/Access: Used for requesting VPN Credentials/Access   </li>

</ul>

<p>Also in the 'Main Site Operations' product, a version named 'unspecified' must be created.</p>

<h3 id="5-configure-osportalapi-container-nfv-services-conditional">5. Configure osportalapi container (NFV services) <em>(conditional)</em></h3>

<h3 id="5-configure-cridge-container-optional">5. Configure CRIDGE container <em>(optional)</em></h3>

<p>If you want to create and manage Kubernetes Custom Resources (CRs), you will have to provide:</p>

<ul>

<li>a cluster-wide scope kubeconf file (typically located at <code>/home/{user}/.kube</code> directory of the Kubernetes Cluster's host)</li>

</ul>

<p>You will have to copy the kubeconf file to the <code>org.etsi.osl.main/compose/kubedir</code> directory, <em>prior to the deployment</em>.</p>

<p>By default, the deployment process copies the contents of <code>org.etsi.osl.main/compose/kubedir</code> directory into the <code>/root/.kube</code> directory of the CRIDGE container.</p>

<pre><code class="language-yaml">volumes:

- ./kubedir/:/root/.kube

</code></pre>

<blockquote>

<p><strong>The above configuration works for the default kubeconf file names. It explicitly expects a file named <code>config</code> within the <code>/root/.kube</code> directory of the created container.</strong></p>

</blockquote>

<p>Optionally, if you want to use custom kubeconf file names, you will have to sync volumes by files and not entire directories, e.g.</p>

<pre><code class="language-yaml">volumes:

- ./kubedir/custom-config-name:/root/.kube/config

</code></pre>

<p>OpenSlice also offers management support of <em>multiple Kubernetes Clusters</em> simultaneously. For this, you will have to:</p>

<ul>

<li>add all the respective kubeconf files into the <code>org.etsi.osl.main/compose/kubedir</code> directory. </li>

<li>create a copy of CRIDGE service in the deployment file and map the appropriate volumes. <em>Mind the need for a different service and container name</em>.</li>

</ul>

<p>Below you may find an indicative example that only references the affected fields of the docker-compose file:</p>

<pre><code class="language-yaml">cridge-cluster1:

  container_name: openslice-cluster1

  ...

  volumes:

  - ./kubedir/config-cluster1:/root/.kube/config



cridge-cluster2:

  container_name: openslice-cluster2

  ...

  volumes:

  - ./kubedir/config-cluster2:/root/.kube/config

</code></pre>

<blockquote>

<p>Note the same <code>/root/.kube/config</code> container's path for the proper functionality. See the above note for explanation.</p>

</blockquote>

<h3 id="6-configure-osportalapi-container-nfv-services-conditional">6. Configure osportalapi container (NFV services) <em>(conditional)</em></h3>

<p>Change the respective fields: </p>

<ul>

<li>If you made changes to mysql and keycloak credentials.</li>
@@ -3504,14 +3560,14 @@ DB_PASSWORD: password 
  &quot;logging.level.org.springframework&quot; : &quot;INFO&quot;

}'

</code></pre>

<h3 id="6-osscapi-container-tmf-api-service-conditional">6. osscapi container (TMF API service) <em>(conditional)</em></h3>

<h3 id="7-configure-osscapi-container-tmf-api-service-conditional">7. Configure osscapi container (TMF API service) <em>(conditional)</em></h3>

<p>Change the respective fields: </p>

<ul>

<li>If you made changes to mysql and keycloak credentials.</li>

<li>If you want to change logging level (TRACE / DEBUG / INFO / WARN / ERROR).</li>

</ul>

<blockquote>

<p><strong>If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}.</strong></p>

<p><strong><em>If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}.</em></strong></p>

</blockquote>

<p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code></p>

<pre><code>SPRING_APPLICATION_JSON: '{

public/2024Q2/deploymentK8s/index.html

+97 −70
Original line number Diff line number Diff line
@@ -674,52 +674,56 @@ 
</li>

        

          <li class="md-nav__item">

  <a href="#2-external-services-configuration" class="md-nav__link">

  <a href="#2-keycloak-configuration" class="md-nav__link">

    <span class="md-ellipsis">

      2. External Services Configuration

      2. Keycloak Configuration

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#3-keycloak-configuration" class="md-nav__link">

  <a href="#3-cridge-configuration" class="md-nav__link">

    <span class="md-ellipsis">

      3. Keycloak Configuration

      3. CRIDGE Configuration

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#4-application-and-logging-configuration" class="md-nav__link">

  <a href="#4-external-services-configuration" class="md-nav__link">

    <span class="md-ellipsis">

      4. Application and Logging Configuration

      4. External Services Configuration

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#5-ingress-and-root-url" class="md-nav__link">

  <a href="#5-application-and-logging-configuration" class="md-nav__link">

    <span class="md-ellipsis">

      5. Ingress and Root URL

      5. Application and Logging Configuration

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#6-persistent-volume-for-mysql" class="md-nav__link">

  <a href="#6-ingress-and-root-url" class="md-nav__link">

    <span class="md-ellipsis">

      6. Persistent Volume for MySQL

      6. Ingress and Root URL

    </span>

  </a>

  

</li>

        

      </ul>

    </nav>

          <li class="md-nav__item">

  <a href="#7-persistent-volume-for-mysql" class="md-nav__link">

    <span class="md-ellipsis">

      7. Persistent Volume for MySQL

    </span>

  </a>

  

</li>
@@ -744,21 +748,20 @@ 
    </span>

  </a>

  

    <nav class="md-nav" aria-label="Configure TMF Web UI">

      <ul class="md-nav__list">

</li>

        

      </ul>

    </nav>

  

</li>

      

        <li class="md-nav__item">

  <a href="#3-deploy-the-helm-chart" class="md-nav__link">

  <a href="#deploy-the-helm-chart" class="md-nav__link">

    <span class="md-ellipsis">

      3. Deploy the Helm Chart

      Deploy the Helm Chart

    </span>

  </a>

  

</li>

        

      </ul>

    </nav>

  

</li>

      

        <li class="md-nav__item">
@@ -3191,52 +3194,56 @@ 
</li>

        

          <li class="md-nav__item">

  <a href="#2-external-services-configuration" class="md-nav__link">

  <a href="#2-keycloak-configuration" class="md-nav__link">

    <span class="md-ellipsis">

      2. External Services Configuration

      2. Keycloak Configuration

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#3-keycloak-configuration" class="md-nav__link">

  <a href="#3-cridge-configuration" class="md-nav__link">

    <span class="md-ellipsis">

      3. Keycloak Configuration

      3. CRIDGE Configuration

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#4-application-and-logging-configuration" class="md-nav__link">

  <a href="#4-external-services-configuration" class="md-nav__link">

    <span class="md-ellipsis">

      4. Application and Logging Configuration

      4. External Services Configuration

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#5-ingress-and-root-url" class="md-nav__link">

  <a href="#5-application-and-logging-configuration" class="md-nav__link">

    <span class="md-ellipsis">

      5. Ingress and Root URL

      5. Application and Logging Configuration

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#6-persistent-volume-for-mysql" class="md-nav__link">

  <a href="#6-ingress-and-root-url" class="md-nav__link">

    <span class="md-ellipsis">

      6. Persistent Volume for MySQL

      6. Ingress and Root URL

    </span>

  </a>

  

</li>

        

      </ul>

    </nav>

          <li class="md-nav__item">

  <a href="#7-persistent-volume-for-mysql" class="md-nav__link">

    <span class="md-ellipsis">

      7. Persistent Volume for MySQL

    </span>

  </a>

  

</li>
@@ -3261,21 +3268,20 @@ 
    </span>

  </a>

  

    <nav class="md-nav" aria-label="Configure TMF Web UI">

      <ul class="md-nav__list">

</li>

        

      </ul>

    </nav>

  

</li>

      

        <li class="md-nav__item">

  <a href="#3-deploy-the-helm-chart" class="md-nav__link">

  <a href="#deploy-the-helm-chart" class="md-nav__link">

    <span class="md-ellipsis">

      3. Deploy the Helm Chart

      Deploy the Helm Chart

    </span>

  </a>

  

</li>

        

      </ul>

    </nav>

  

</li>

      

        <li class="md-nav__item">
@@ -3475,8 +3481,39 @@ cd org.etsi.osl.main/kubernetes/helm/openslice/ 
      username: &quot;portaluser&quot;

      password: &quot;12345&quot;

</code></pre>

<h4 id="2-external-services-configuration">2. External Services Configuration</h4>

<p>For configuring external services like Bugzilla and CentralLog, specify their URLs and credentials in the <code>values.yaml</code> file:</p>

<h4 id="2-keycloak-configuration">2. Keycloak Configuration</h4>

<p>Keycloak settings, including the database and admin password, are part of the <code>oscreds.mysql.keycloak</code> section. If you need to adjust Keycloak-specific settings like realms or client configurations, you'll likely need to customize your Helm chart further or manage these settings directly within Keycloak after deployment. The Keycloak realm configuration that is imported by default can be found under <code>kubernetes/helm/openslice/files/keycloak-init/realm-export.json</code>.</p>

<pre><code class="language-yaml">oscreds:

  mysql:

    keycloak: 

      database: &quot;keycloak&quot;

      username: &quot;keycloak&quot;

      password: &quot;password&quot;

      adminpassword: &quot;Pa55w0rd&quot;

</code></pre>

<h4 id="3-cridge-configuration">3. CRIDGE Configuration</h4>

<p>If you want to create and manage Kubernetes Custom Resources (CRs), you will have to provide:</p>

<ul>

<li>a cluster-wide scope kubeconf file (typically located at <code>/home/{user}/.kube</code> directory of the Kubernetes Cluster's host)</li>

</ul>

<p>You will have to copy the kubeconf file to the <code>org.etsi.osl.main/kubernetes/helm/openslice/files/org.etsi.osl.cridge</code> directory, <em>prior to the deployment</em>.</p>

<p>By default, the deployment process copies the <code>org.etsi.osl.main/kubernetes/helm/openslice/files/org.etsi.osl.cridge/config</code> file into the <code>/root/.kube</code> directory of the CRIDGE container.</p>

<blockquote>

<p><strong>The above configuration works for the default kubeconf file names. It explicitly expects a file named <code>config</code> within the <code>org.etsi.osl.main/kubernetes/helm/openslice/files/org.etsi.osl.cridge</code> directory. If you are working with custom kubeconf file names, you will have to rename them.</strong></p>

</blockquote>

<p>OpenSlice also offers management support of <em>multiple Kubernetes Clusters</em> simultaneously. For this, you will have to:</p>

<ul>

<li>add all the respective kubeconf files into the <code>org.etsi.osl.main/compose/kubedir</code> directory. </li>

<li>create a copy of the <code>cridge.yaml</code> and <code>cridge-config.yaml</code> in <code>\org.etsi.osl.main\kubernetes\helm\openslice\templates</code> directory for every Cluster. <em>Mind the need for different naming</em>.</li>

<li>update every <code>cridge-config.yaml</code> file to get the appropriate kubeconf file for every Cluster.</li>

</ul>

<p>Below you may find an indicative example that only references the affected fields of each cridge-config.yaml file:</p>

<pre><code class="language-yaml">data:

  config: |-

    {{- .Files.Get &quot;files/org.etsi.osl.cridge/config-clusterX&quot; | nindent 4 }}

</code></pre>

<h4 id="4-external-services-configuration">4. External Services Configuration</h4>

<p>For configuring optional external services like Bugzilla and CentralLog, specify their URLs and credentials in the <code>values.yaml</code> file:</p>

<pre><code class="language-yaml">bugzillaurl: &quot;example.com:443/bugzilla&quot;

bugzillakey: &quot;VH2Vw0iI5aYgALFFzVDWqhACwt6Hu3bXla9kSC1Z&quot;

main_operations_product: &quot;Main Site Operations&quot; // this is the default product to issue tickets
@@ -3491,33 +3528,23 @@ centrallogurl: &quot;http://elk_ip:elk_port/index_name/_doc&quot; 
<li>VPN Credentials/Access: Used for requesting VPN Credentials/Access   </li>

</ul>

<p>Also in the 'Main Site Operations' product, a version named 'unspecified' must be created.</p>

<h4 id="3-keycloak-configuration">3. Keycloak Configuration</h4>

<p>Keycloak settings, including the database and admin password, are part of the <code>oscreds.mysql.keycloak</code> section. If you need to adjust Keycloak-specific settings like realms or client configurations, you'll likely need to customize your Helm chart further or manage these settings directly within Keycloak after deployment. The Keycloak realm configuration that is imported by default can be found under <code>kubernetes/helm/openslice/files/keycloak-init/realm-export.json</code>.</p>

<pre><code class="language-yaml">oscreds:

  mysql:

    keycloak: 

      database: &quot;keycloak&quot;

      username: &quot;keycloak&quot;

      password: &quot;password&quot;

      adminpassword: &quot;Pa55w0rd&quot;

</code></pre>

<h4 id="4-application-and-logging-configuration">4. Application and Logging Configuration</h4>

<h4 id="5-application-and-logging-configuration">5. Application and Logging Configuration</h4>

<p>Application-specific configurations, such as OAuth client secrets, can be set in the <code>spring</code> section:</p>

<pre><code class="language-yaml">spring:

  oauthClientSecret: &quot;secret&quot;

</code></pre>

<h4 id="5-ingress-and-root-url">5. Ingress and Root URL</h4>

<h4 id="6-ingress-and-root-url">6. Ingress and Root URL</h4>

<p>To configure the ingress controller and root URL for OpenSlice, update the rooturl field with your ingress load balancer IP or domain. This setting is crucial for external access to your application:</p>

<pre><code class="language-yaml">rooturl: &quot;http://openslice.com&quot; # Example domain

# or

rooturl: &quot;http://3.15.198.35:8080&quot; # Example IP with port

</code></pre>

<h4 id="6-persistent-volume-for-mysql">6. Persistent Volume for MySQL</h4>

<h4 id="7-persistent-volume-for-mysql">7. Persistent Volume for MySQL</h4>

<p>For persistent storage, especially for MySQL, define the storage size under the <code>mysql</code> section. This ensures that your database retains data across pod restarts and deployments.</p>

<pre><code class="language-yaml">mysql:

  storage: &quot;10Gi&quot;

</code></pre>

<h2 id="configure-web-ui">Configure Web UI</h2>

<h3 id="configure-web-ui">Configure Web UI</h3>

<p>In folder <code>kubernetes/helm/openslice/files/org.etsi.osl.portal.web/src/js</code> you must make a copy of <code>config.js.default</code> file and rename it to <code>config.js</code>. </p>

<p>This is <strong>mandatory</strong> for the configuration file to be discoverable.</p>

<p>Edit the <code>config.js</code> configuration file with your static configuration, if needed.</p>
@@ -3532,7 +3559,7 @@ rooturl: &quot;http://3.15.198.35:8080&quot; # Example IP with port 
  APITMFURL: &quot;{{ .Values.rooturl }}/tmf-api/serviceCatalogManagement/v4&quot;

}

</code></pre>

<h2 id="configure-tmf-web-ui">Configure TMF Web UI</h2>

<h3 id="configure-tmf-web-ui">Configure TMF Web UI</h3>

<p>In the folder <code>kubernetes/helm/openslice/files/org.etsi.osl.tmf.web/src/assets/config</code> there are 3 files available for configuration:</p>

<ul>

<li>config.prod.default.json (Basic information + API configuration)</li>
@@ -3591,7 +3618,7 @@ cd kubernetes/helm/openslice/files/org.etsi.osl.tmf.web/src/assets/config 
</code></pre>

<pre><code class="language-bash">sudo cp config.theming.default.json config.theming.json

</code></pre>

<h3 id="3-deploy-the-helm-chart">3. Deploy the Helm Chart</h3>

<h2 id="deploy-the-helm-chart">Deploy the Helm Chart</h2>

<p>After configuring the services, and editing the <code>values.yaml</code> file accordingly, the helm install command can be performed.</p>

<pre><code class="language-bash">cd kubernetes/helm/openslice/

helm install myopenslice . --namespace openslice --create-namespace

public/2024Q2/index.html

+4 −4
Original line number Diff line number Diff line
@@ -2846,7 +2846,7 @@ 




<p><img src="images/openslice_logo.png" alt="drawing" width="200"/></p>

<p>version: 2024Q2</p>

<p><strong>Version</strong>: 2024Q2 (<a href="https://labs.etsi.org/rep/osl/code/org.etsi.osl.main/-/releases/2024Q2">Release Notes</a>)</p>

<p>The ETSI Software Development Group for OpenSlice (SDG OSL) is developing an open-source service-based Operations Support System (OSS) to deliver Network as a Service (NaaS) following specifications from major SDOs including ETSI, TM Forum and GSMA.</p>

<h2 id="usage">Usage</h2>

<p>OpenSlice can be used in managing 5G network services from the user device to the core network and cloud as well as for Orchestrating cloud resources across private and public clouds for enterprise applications.  OpenSlice is capable of supporting most of the features of an end-to-end (E2E) service orchestration framework while many of them will be more mature in future releases. The following figure displays the general usage of OpenSlice. </p>
@@ -2858,9 +2858,9 @@ OpenSlice, in a nutchell, offers user interfaces where users can interact with t 
<ul>

<li>Service Catalogs including predefined Network Services based on service templates for common network services like 5G core functions, 5G slices, VPNs, SD-WAN, firewalls, load balancers, etc. as well as custom Network services with Options for users to define their own network configurations.</li>

<li>User Interface (UI) and APIs exposure, offering both a Self-Service Portal that allows users to request, configure, and manage network services as well as APIs for enabling programmatic access to network services for integration with other systems and automation scripts.</li>

<li>Service Design and Creation tharough service templates based on predefined models for creating services.</li>

<li>Service Design and Creation through service templates based on predefined models for creating services.</li>

<li>Automation and Workflow Management via Orchestration Engines, supporting  Process Automation for automating repetitive tasks and processes,  workflow management and orchestration for automating the provisioning, configuration, and management of network services while coordinating multiple workflows to ensure services are delivered efficiently, ensuring that services comply with predefined policies and standards.</li>

<li>Standardized API exposure for seamless integration with different systems and services and APIs transformation support for converting data formats and protocols to ensure compatibility and information exhange between systems during workflows orchestration</li>

<li>Standardized API exposure for seamless integration with different systems and services and APIs transformation support for converting data formats and protocols to ensure compatibility and information exchange between systems during workflows orchestration</li>

<li>Service and Resource management and Orchestration while including the capability of multi-domain coordination in managing services/resources across different domains like cloud, 5G core, radios, transport network, and edge including dynamic allocation with adjusting resources based on demand and service requirements. To accomplish the above advanced technologies need to be exploited like, Containerized workloads,  Network Function Virtualization (NFV) which uses virtualized network functions to provide services like routing, switching, and security and Software-Defined Networking (SDN) which Controls the network programmatically to dynamically manage traffic and resources.</li>

<li>Monitoring and Analytics including  Service Monitoring while continuously tracking the performance and health of services with capabilities to analyse data to optimize service delivery and predict issues. Real-Time Monitoring is also needed for tracking the performance and health of network services enabling analytics that provide insights for optimization and troubleshooting.</li>

<li>Security and Access Control for ensuring only authorized users and systems can access network services. while implementing rules and policies to comply with regulatory requirements.</li>
@@ -2870,7 +2870,7 @@ OpenSlice, in a nutchell, offers user interfaces where users can interact with t 
<ul>

<li>Service Request: Users or systems request a network service through the self-service portal or API. The request can specify details such as bandwidth, security features, geographic coverage, and duration.</li>

<li>Service Orchestration: The orchestration engine evaluates the request, determines the necessary resources, and initiates the automated workflows.It interacts with the underlying components (e.g. 5G Core, Radios, Containerized controllers, NFV, SDN controllers ) to provision and configure the required network functions and connectivity.</li>

<li>Provisioning and Configuration: Services, network resources and network functions (VNFs) are instantiated and configured according to the service request during Service Orchestration through the orchestration engine. Other controllers manage their own domains, for example SDN controllers, manage the flow of data through the network to ensure optimal performance and adherence to policies, RAN controllers manage the RAN resoruces, Containerized controllers manage their workload, etc</li>

<li>Provisioning and Configuration: Services, network resources and network functions (VNFs) are instantiated and configured according to the service request during Service Orchestration through the orchestration engine. Other controllers manage their own domains, for example SDN controllers, manage the flow of data through the network to ensure optimal performance and adherence to policies, RAN controllers manage the RAN resources, Containerized controllers manage their workload, etc</li>

<li>Service Delivery: The E2E network service is activated and made available to the user. Continuous monitoring ensures the service operates as expected, with automatic adjustments made as necessary.</li>

<li>Lifecycle Management: The orchestration framework handles updates, scaling, and any necessary modifications throughout the service lifecycle.</li>

<li>At the end of the service period, resources are decommissioned and reclaimed.</li>

public/2024Q2/search/search_index.json

+1 −1

File changed.

Preview size limit exceeded, changes collapsed.

public/2024Q2/sitemap.xml

+58 −58

File changed.

Preview size limit exceeded, changes collapsed.