index.html

  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_8_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_4_8">
            <span class="md-nav__icon md-icon"></span>
            Examples
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../service_design/examples/intro/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Introduction
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../service_design/examples/calculator_crd_aas/calculator_crd_aas/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Calculator CRD aaS
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../service_design/examples/jenkins_helm_install_aas/jenkins_helm_install_aas/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Jenkins Helm Installation aaS
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../service_design/examples/monitoring_aas/monitoring_aas/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Monitoring aaS
    
  </span>
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
        
          
          <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    Service Ordering
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_5">
            <span class="md-nav__icon md-icon"></span>
            Service Ordering
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../service_ordering/ordering_services/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Ordering Services from catalogs
    
  </span>
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
        
          
          <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    Addons
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_6">
            <span class="md-nav__icon md-icon"></span>
            Addons
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../addons/intro/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Introduction
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    
    
    
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
        
          
          <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    CAMARA
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_6_2">
            <span class="md-nav__icon md-icon"></span>
            CAMARA
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../addons/camara/intro/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Offering CAMARAaaS
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../addons/camara/qod/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Quality on Demand
    
  </span>
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../addons/sylva/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    LF Sylva
    
  </span>
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
        
          
          <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    Design & Architecture
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_7">
            <span class="md-nav__icon md-icon"></span>
            Design & Architecture
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../architecture/architecture/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Architecture
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../architecture/messagebus/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Message bus
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../architecture/osom/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    OSOM
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../architecture/cridge/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    CRIDGE
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../architecture/metrico/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    METRICO
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../architecture/oauth/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Authentication
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    
    
    
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_7" >
        
          
          <label class="md-nav__link" for="__nav_7_7" id="__nav_7_7_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    APIs
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_7_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_7_7">
            <span class="md-nav__icon md-icon"></span>
            APIs
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../architecture/tmfapi/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    TMF API
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../architecture/nfvapi/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    NFV API
    
  </span>
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../architecture/issuemgt/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Issue management
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../architecture/centrallog/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Central logging
    
  </span>
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    
    
    
    
    
    <li class="md-nav__item md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
        
          
          <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
            
  
  
  <span class="md-ellipsis">
    Contribute
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_8">
            <span class="md-nav__icon md-icon"></span>
            Contribute
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../contribute/developing/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Developing
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../contribute/documenting/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Documenting
    
  </span>
  

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="../../terminology/" class="md-nav__link">
        
  
  
  <span class="md-ellipsis">
    Terminology
    
  </span>
  

      </a>
    </li>
  

    
  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
              
              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
  
    
  
  
    <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="#resource-facing-service-specification" class="md-nav__link">
    <span class="md-ellipsis">
      Resource Facing Service Specification
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#customer-facing-service-specification" class="md-nav__link">
    <span class="md-ellipsis">
      Customer Facing Service Specification
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#definition" class="md-nav__link">
    <span class="md-ellipsis">
      Definition
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#ui-management" class="md-nav__link">
    <span class="md-ellipsis">
      UI management
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#api-exposed" class="md-nav__link">
    <span class="md-ellipsis">
      API exposed
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#example-use-case" class="md-nav__link">
    <span class="md-ellipsis">
      Example Use Case
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#probe-further" class="md-nav__link">
    <span class="md-ellipsis">
      Probe further
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
                
                  



<h1 id="openslice-service-specification">OpenSlice Service Specification</h1>
<p><strong>Intended Audience: OpenSlice Service Designers</strong></p>
<p>OpenSlice offers complete management of Service Specifications.</p>
<p>Service Specification is an entity that describes a service offering. There are two types of Service Specifications:</p>
<ul>
<li>Resource Facing Service Specification (RFSS)</li>
<li>Customer Facing Service Specification (CFSS)</li>
</ul>
<h2 id="resource-facing-service-specification">Resource Facing Service Specification</h2>
<p>Is a Service that It exposes a resource Specification as a Service. (For example expose a Network Service Descriptor as a Service)</p>
<h2 id="customer-facing-service-specification">Customer Facing Service Specification</h2>
<p>Customer Facing Service Specifications - or also CFSSpec (organized in Service Categories) are exposed to users for Service Orders. Usually it exposes other CFSSpec(as a Service Bundle) or other RFSSpecs</p>
<h2 id="definition">Definition</h2>
<p>Usually a Service Specification has the following aspects:</p>
<ul>
<li>Name, Description, Version</li>
<li>Marked as a Service Bundle: Combines multiple services into a single offering to provide added value to customers.</li>
<li>if is is a Bundle then you must add Related Service Specifications</li>
<li>If it is a Resource Facing Service Specification has multiple related Resource Facing Service Specifications</li>
<li>Characteristics: a list of service characteristics and their type (TEXT, INTEGER, etc)</li>
<li>Also they can be exposed as "Configurable" so to allow to end-users during the Service Order to select or type values</li>
<li>A logo, displayed if needed in the Service Marketplace</li>
<li>Any attachments that further help the user</li>
<li>Life Cycle Rules that determine the behavior of the Service and instrument the Service Orchestrator. More on Life Cycle Rules <a href="../lcm_rules_intro/">here</a></li>
</ul>
<p>Service Designers can create a Service Specification from scratch or use some templates:</p>
<ul>
<li>Create a Service based from a Network Service Descriptor (NSD)</li>
<li>Create a Service based on a Kubernetes Operator</li>
<li>Create a Service based on the GSMA GST - Generic Slice Template</li>
</ul>
<h2 id="ui-management">UI management</h2>
<p>In the UI this looks like the following.</p>
<p>Through the menu and dedicated forms the administrator can manage the Service Specifications. Various examples in this document will guide you to the usage and the design of the services.</p>
<h2 id="api-exposed">API exposed</h2>
<p>When installing OpenSlice the API endpoints can be browsed at: 
<div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>[YOURDOMAIN]/tmf-api/swagger-ui/index.html?urls.primaryName=tmf-api-633-ServiceCatalogManagement-v4.0.0
</span></code></pre></div></p>
<p>endpoint examples:</p>
<p>/serviceCatalogManagement/v4/serviceSpecification List or find ServiceSpecification objects</p>
<h2 id="example-use-case">Example Use Case</h2>
<p>Scenario: A service provider wants to offer a new managed XXXX service to enterprise customers.</p>
<ul>
<li>Service Definition:  Create a service specification template for the XXXX service, including specifications for bandwidth, network features, and performance metrics.</li>
</ul>
<h2 id="probe-further">Probe further</h2>
<ul>
<li>Read the model of Service Catalogs in TMF <a href="https://www.tmforum.org/resources/specification/tmf633-service-catalog-api-user-guide-v4-0-0/">TMF633 Service Catalog API User Guide v4.0.0</a></li>
<li>Check a demo of the API <a href="http://portal.openslice.eu/tmf-api/swagger-ui/index.html?urls.primaryName=tmf-api-633-ServiceCatalogManagement-v4.0.0">here</a></li>
<li>Check a demo of the Service Specifications in Catalog and Categories <a href="http://portal.openslice.eu">here</a> (You need to login - see main guide page)</li>
<li>Check the GSMA GST</li>
</ul>












                
              </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 8z"/></svg>
  Back to top
</button>
        
      </main>
      
        <footer class="md-footer">
  
    
      
      <nav class="md-footer__inner md-grid" aria-label="Footer" >
        
          
          <a href="../service_catalog/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Service Catalogs">
            <div class="md-footer__button md-icon">