index.html

  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#usage" class="md-nav__link">
    <span class="md-ellipsis">
      Usage
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#service-lifecycle-rules" class="md-nav__link">
    <span class="md-ellipsis">
      Service Lifecycle Rules
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#multidomain-scenarios-and-federation" class="md-nav__link">
    <span class="md-ellipsis">
      Multidomain scenarios and federation
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#live-demo" class="md-nav__link">
    <span class="md-ellipsis">
      Live Demo
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#video-demo" class="md-nav__link">
    <span class="md-ellipsis">
      Video demo
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#installing" class="md-nav__link">
    <span class="md-ellipsis">
      Installing
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#hardware-requirements" class="md-nav__link">
    <span class="md-ellipsis">
      Hardware requirements
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#supported-apis" class="md-nav__link">
    <span class="md-ellipsis">
      Supported APIs
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#source-code" class="md-nav__link">
    <span class="md-ellipsis">
      Source code
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#contributing" class="md-nav__link">
    <span class="md-ellipsis">
      Contributing
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#social-media" class="md-nav__link">
    <span class="md-ellipsis">
      Social Media
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#history" class="md-nav__link">
    <span class="md-ellipsis">
      History
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#ecosystem" class="md-nav__link">
    <span class="md-ellipsis">
      Ecosystem
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#citation" class="md-nav__link">
    <span class="md-ellipsis">
      Citation
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
                
                  


  <h1>Introduction</h1>

<p><img src="images/openslice_logo.png" alt="drawing" width="200"/></p>
<p>version: 2023Q4 - Release 0</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 Slice as a Service (NSaaS) following specifications from major SDOs including ETSI, TM Forum and GSMA. See more details <a href="https://osl.etsi.org/about/">here</a>.</p>
<h2 id="usage">Usage</h2>
<p>OpenSlice allows Vertical Customers to browse the available offered service specifications and also allows NFV developers to onboard and manage VNF and Network Service artifacts. It also supports TMFORUM OpenAPIs regarding Service Catalog Management, Ordering, Resource, etc.
The following figure displays the usage of OpenSlice.</p>
<p><a href="images/index_intro_architecture.png"><img alt="OpenSlice  usage" src="images/index_intro_architecture.png" /></a></p>
<p>There are two portals offering UI friendly access to users:</p>
<ul>
<li>The Services portal allows users to access services and service providers to design services. </li>
<li>The NFV portal allows users to self-manage NFV artifacts and onboard them to a target MANO/NFV Orchestrator.</li>
</ul>
<p>3rd party applications can use OpenSlice through TMForum Open APIs.</p>
<p>Service Specifications reside into Service Catalogs, grouped in Categories. OpenSlice offers a Service Orchestrator called <a href="architecture/osom/">OSOM</a>. OSOM instantiates Service Specifications by requesting Network Services from target MANOs/NFVOs. NFV artifacts reside into a VNF/NSD catalog and are onboarded to a target MANO/NFV Orchestrator. Service Specifications reference NSD from the VNF/NSD catalog. </p>
<p>Customers make Service Orders and OpenSlice instantiates the requested Service Specifications of the Service Order. Running Services instantiated by OpenSlice, reside in OpenSlice Service Inventory. The following picture displays how Service Specifications are related to Running Services and how Running Services relate with instantiated running Network Services. (See also <a href="service_inventory/">Service Inventory</a>)</p>
<p><a href="images/service_specification_instantiation.png"><img alt="OpenSlice  Service Specification instantiation" src="images/service_specification_instantiation.png" /></a></p>
<h2 id="service-lifecycle-rules">Service Lifecycle Rules</h2>
<p>OpenSlice constains support for defining rules of services, affecting their behavior. See <a href="lcm/">LCM Rules</a>.</p>
<h2 id="multidomain-scenarios-and-federation">Multidomain scenarios and federation</h2>
<p>OpenSlice can be used to exchange service specifications/catalogs and make service orders between Organizations as the following figure displays.</p>
<p><a href="images/multi-domain-organizations.png"><img alt="OpenSlice  Service Specification instantiation" src="images/multi-domain-organizations.png" /></a></p>
<p>An Identity federation is also possible since our authentication service is based on Keycloak (see <a href="architecture/oauth/">OAuth</a>).</p>
<p>See more on <a href="architecture/consumingServicesFromExternalPartners/">Consuming Services From External Partner Organizations</a>.</p>
<h2 id="live-demo">Live Demo</h2>
<ul>
<li>OpenSlice demo: <a href="http://portal.openslice.io/">http://portal.openslice.io/</a></li>
<li>OpenSlice Service Catalogs and ordering: <a href="http://portal.openslice.io/services/">http://portal.openslice.io/services/</a></li>
<li>OpenSlice NFV Services onboarding: <a href="http://portal.openslice.io/nfvportal">http://portal.openslice.io/nfvportal</a><blockquote>
<p>username=admin, password=openslice <br> or <br>username=admin, password=changeme</p>
</blockquote>
</li>
</ul>
<h2 id="video-demo">Video demo</h2>
<ul>
<li><a href="https://youtu.be/KU8JPDFFl9A">https://youtu.be/KU8JPDFFl9A</a></li>
</ul>
<hr />
<h2 id="installing">Installing</h2>
<p>See <a href="deployment/">Deployment/Installation</a>.</p>
<hr />
<h2 id="hardware-requirements">Hardware requirements</h2>
<p>The complete environment consists of microservices deployed as docker containers. Portainer is also installed to monitor them at port 9000.</p>
<p>If you would like to operate all APIs, OSOM, the Mysql Server, nginx, etc then you need at least:</p>
<table>
<thead>
<tr>
<th><strong>Minimum Hardware Requirements</strong></th>
<th><strong>Recomended Hardware Requirements</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>4 CPU cores</td>
<td>8 CPU cores</td>
</tr>
<tr>
<td>8 GB RAM</td>
<td>16 GB RAM</td>
</tr>
<tr>
<td>20 GB storage</td>
<td>40 GB storage</td>
</tr>
</tbody>
</table>
<p>(NOTE: Bugzilla or ELK are not included and we assume they run elsewhere)</p>
<p>However, you may try the front facing services of OpenSlice with a minimum installation on a VM on a laptop with:</p>
<ul>
<li>2 cores</li>
<li>4GB of RAM  </li>
</ul>
<h2 id="supported-apis">Supported APIs</h2>
<p>Quick overview of the supported APIs through our Swagger links:</p>
<ul>
<li><a href="http://portal.openslice.io/tmf-api/swagger-ui/index.html">TMF APIs</a></li>
<li><a href="http://portal.openslice.io/osapi/swagger-ui/index.html">API for VNF/NSD management</a></li>
</ul>
<h2 id="source-code">Source code</h2>
<p>OpenSlice source code is available at <a href="https://labs.etsi.org/rep/osl/code">OSL GitLab repository</a>.</p>
<h2 id="contributing">Contributing</h2>
<p>You may contribute following the guidelines at <a href="contributing/developing/">Contributing page</a>.</p>
<h2 id="social-media">Social Media</h2>
<ul>
<li><a href="https://twitter.com/OpensliceOSS">Twitter</a></li>
<li><a href="https://openslice.slack.com">Slack</a></li>
</ul>
<h2 id="history">History</h2>
<ul>
<li>The NFV portal part of OpenSlice was initially developed in H2020 European Research project <a href="https://5ginfire.eu">5GinFIRE</a> by University of Patras, Greece</li>
<li>OpenSlice core services, APIs was further developed and maintained in H2020 European project <a href="https://5g-vinni.eu/">5G-VINNI</a> by University of Patras, Greece</li>
<li>OpenSlice has been a part off OSM's OSS/BSS ecosystem</li>
</ul>
<p><a href="https://osm.etsi.org/wikipub/index.php/OSS_BSS"><img alt="Part of OSM Ecosystem" src="images/osm_ecosystem_ossbss.png" /></a></p>
<h2 id="ecosystem">Ecosystem</h2>
<p>Discover the current OpenSlice ecosystem <a href="https://osl.etsi.org/ecosystem/">here</a>.</p>
<h2 id="citation">Citation</h2>
<p>Please cite our <a href="https://arxiv.org/abs/2102.03290">![paper]</a> if you use Openslice</p>
<pre><code>
@misc{tranoris2021openslice,
      title={Openslice: An opensource OSS for Delivering Network Slice as a Service}, 
      author={Christos Tranoris},
      year={2021},
      eprint={2102.03290},
      archivePrefix={arXiv},
      primaryClass={cs.NI}
}

</code></pre>












                
              </article>
            </div>
          
          
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
        </div>
        
          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg>
  Back to top
</button>
        
      </main>
      
        <footer class="md-footer">
  
    
      
      <nav class="md-footer__inner md-grid" aria-label="Footer" >
        
        
          
          <a href="deployment/" class="md-footer__link md-footer__link--next" aria-label="Next: Deployment/Installation">
            <div class="md-footer__title">
              <span class="md-footer__direction">
                Next
              </span>
              <div class="md-ellipsis">
                Deployment/Installation
              </div>
            </div>
            <div class="md-footer__button md-icon">
              
              <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg>
            </div>
          </a>
        
      </nav>
    
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-copyright">
  
    <div class="md-copyright__highlight">
      Copyright &copy; 2019-2024 Openslice Project
    </div>
  
  
    Made with
    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
      Material for MkDocs
    </a>
  
</div>
      
        <div class="md-social">
  
    
    
    
    
      
      
    
    <a href="https://osl.etsi.org/" target="_blank" rel="noopener" title="osl.etsi.org" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M352 256c0 22.2-1.2 43.6-3.3 64H163.3c-2.2-20.4-3.3-41.8-3.3-64s1.2-43.6 3.3-64h185.4c2.2 20.4 3.3 41.8 3.3 64zm28.8-64h123.1c5.3 20.5 8.1 41.9 8.1 64s-2.8 43.5-8.1 64H380.8c2.1-20.6 3.2-42 3.2-64s-1.1-43.4-3.2-64zm112.6-32H376.7c-10-63.9-29.8-117.4-55.3-151.6 78.3 20.7 142 77.5 171.9 151.6zm-149.1 0H167.7c6.1-36.4 15.5-68.6 27-94.7 10.5-23.6 22.2-40.7 33.5-51.5C239.4 3.2 248.7 0 256 0s16.6 3.2 27.8 13.8c11.3 10.8 23 27.9 33.5 51.5 11.6 26 20.9 58.2 27 94.7zm-209 0H18.6c30-74.1 93.6-130.9 172-151.6-25.5 34.2-45.3 87.7-55.3 151.6zM8.1 192h123.1c-2.1 20.6-3.2 42-3.2 64s1.1 43.4 3.2 64H8.1C2.8 299.5 0 278.1 0 256s2.8-43.5 8.1-64zm186.6 254.6c-11.6-26-20.9-58.2-27-94.6h176.6c-6.1 36.4-15.5 68.6-27 94.6-10.5 23.6-22.2 40.7-33.5 51.5-11.2 10.7-20.5 13.9-27.8 13.9s-16.6-3.2-27.8-13.8c-11.3-10.8-23-27.9-33.5-51.5zM135.3 352c10 63.9 29.8 117.4 55.3 151.6-78.4-20.7-142-77.5-172-151.6h116.7zm358.1 0c-30 74.1-93.6 130.9-171.9 151.6 25.5-34.2 45.2-87.7 55.3-151.6h116.6z"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://labs.etsi.org/rep/osl" target="_blank" rel="noopener" title="labs.etsi.org" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="m503.5 204.6-.7-1.8-69.7-181.78c-1.4-3.57-3.9-6.59-7.2-8.64-2.4-1.55-5.1-2.515-8-2.81-2.9-.295-5.7.083-8.4 1.11-2.7 1.02-5.1 2.66-7.1 4.78-1.9 2.12-3.3 4.67-4.1 7.44l-47 144H160.8l-47.1-144c-.8-2.77-2.2-5.31-4.1-7.43-2-2.12-4.4-3.75-7.1-4.77a18.1 18.1 0 0 0-8.38-1.113 18.4 18.4 0 0 0-8.04 2.793 18.09 18.09 0 0 0-7.16 8.64L9.267 202.8l-.724 1.8a129.57 129.57 0 0 0-3.52 82c7.747 26.9 24.047 50.7 46.447 67.6l.27.2.59.4 105.97 79.5 52.6 39.7 32 24.2c3.7 1.9 8.3 4.3 13 4.3 4.7 0 9.3-2.4 13-4.3l32-24.2 52.6-39.7 106.7-79.9.3-.3c22.4-16.9 38.7-40.6 45.6-67.5 8.6-27 7.4-55.8-2.6-82z"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://www.linkedin.com/company/openslice/" target="_blank" rel="noopener" title="www.linkedin.com" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://twitter.com/OpensliceOSS" target="_blank" rel="noopener" title="twitter.com" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M389.2 48h70.6L305.6 224.2 487 464H345L233.7 318.6 106.5 464H35.8l164.9-188.5L26.8 48h145.6l100.5 132.9L389.2 48zm-24.8 373.8h39.1L151.1 88h-42l255.3 333.8z"/></svg>
    </a>
  
</div>
      
    </div>
  </div>
</footer>
      
    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>
    
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
    
    
    <script id="__config" type="application/json">{"base": ".", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight"], "search": "assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
    
    
      <script src="assets/javascripts/bundle.8fd75fb4.min.js"></script>
      
    
  </body>
</html>