index.html

  
  
    <li class="md-nav__item">
      <a href="../../testing_services/test_inventory.md" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Testing Inventory
  </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">
    Service as a Product
  </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>
            Service as a Product
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../product_model/product_spec.md" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Product Specification
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../product_model/product_catalogs.md" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Product Catalogs
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../product_model/product_inventory.md" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Product Inventory
  </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">
    Assurance services
  </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>
            Assurance services
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../assurance_services/intro.md" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Introduction
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../assurance_services/alarms_actions.md" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Alarms and Actions
  </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_9" >
        
          
          <label class="md-nav__link" for="__nav_9" id="__nav_9_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_9_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_9">
            <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 md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9_2" >
        
          
          <label class="md-nav__link" for="__nav_9_2" id="__nav_9_2_label" tabindex="0">
            
  
  <span class="md-ellipsis">
    Cloud native support
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_9_2_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_9_2">
            <span class="md-nav__icon md-icon"></span>
            Cloud native support
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../architecture/CRIDGE_cloud_native_intro.md" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Introduction
  </span>
  

      </a>
    </li>
  

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

      </a>
    </li>
  

              
            
          </ul>
        </nav>
      
    </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/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_9_6" >
        
          
          <label class="md-nav__link" for="__nav_9_6" id="__nav_9_6_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_9_6_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_9_6">
            <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--active md-nav__item--nested">
      
        
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" checked>
        
          
          <label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
            
  
  <span class="md-ellipsis">
    Contributing to OSL
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="true">
          <label class="md-nav__title" for="__nav_10">
            <span class="md-nav__icon md-icon"></span>
            Contributing to OSL
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
    
  
  
  
    <li class="md-nav__item md-nav__item--active">
      
      <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
      
      
        
      
      
        <label class="md-nav__link md-nav__link--active" for="__toc">
          
  
  <span class="md-ellipsis">
    Developing
  </span>
  

          <span class="md-nav__icon md-icon"></span>
        </label>
      
      <a href="./" class="md-nav__link md-nav__link--active">
        
  
  <span class="md-ellipsis">
    Developing
  </span>
  

      </a>
      
        

<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="#general-requirements" class="md-nav__link">
    <span class="md-ellipsis">
      General requirements
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#versionrelease-management" class="md-nav__link">
    <span class="md-ellipsis">
      Version/release management
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#getting-started" class="md-nav__link">
    <span class="md-ellipsis">
      Getting Started
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#contribute-to-a-subsystem" class="md-nav__link">
    <span class="md-ellipsis">
      Contribute to a subsystem
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#examples-of-developing-on-specific-subsystems" class="md-nav__link">
    <span class="md-ellipsis">
      Examples of developing on specific subsystems
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Examples of developing on specific subsystems">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#vnfnsd-catalog-management-and-nsd-deployment-api-service" class="md-nav__link">
    <span class="md-ellipsis">
      VNF/NSD Catalog Management and NSD Deployment API service
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#vnfnsd-catalog-management-and-nsd-deployment-web-ui-service" class="md-nav__link">
    <span class="md-ellipsis">
      VNF/NSD Catalog Management and NSD Deployment WEB UI service
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#reach-us" class="md-nav__link">
    <span class="md-ellipsis">
      Reach us
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Reach us">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#slack" class="md-nav__link">
    <span class="md-ellipsis">
      Slack
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#e-mail" class="md-nav__link">
    <span class="md-ellipsis">
      E-mail
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#wishlist" class="md-nav__link">
    <span class="md-ellipsis">
      Wishlist
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
      
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../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="#general-requirements" class="md-nav__link">
    <span class="md-ellipsis">
      General requirements
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#versionrelease-management" class="md-nav__link">
    <span class="md-ellipsis">
      Version/release management
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#getting-started" class="md-nav__link">
    <span class="md-ellipsis">
      Getting Started
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#contribute-to-a-subsystem" class="md-nav__link">
    <span class="md-ellipsis">
      Contribute to a subsystem
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#examples-of-developing-on-specific-subsystems" class="md-nav__link">
    <span class="md-ellipsis">
      Examples of developing on specific subsystems
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Examples of developing on specific subsystems">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#vnfnsd-catalog-management-and-nsd-deployment-api-service" class="md-nav__link">
    <span class="md-ellipsis">
      VNF/NSD Catalog Management and NSD Deployment API service
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#vnfnsd-catalog-management-and-nsd-deployment-web-ui-service" class="md-nav__link">
    <span class="md-ellipsis">
      VNF/NSD Catalog Management and NSD Deployment WEB UI service
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#reach-us" class="md-nav__link">
    <span class="md-ellipsis">
      Reach us
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Reach us">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#slack" class="md-nav__link">
    <span class="md-ellipsis">
      Slack
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#e-mail" class="md-nav__link">
    <span class="md-ellipsis">
      E-mail
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#wishlist" class="md-nav__link">
    <span class="md-ellipsis">
      Wishlist
    </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="developing">Developing</h1>
<p>OpenSlice backend services are mainly implemented with Java 17 or above and Spring Boot.</p>
<p>OpenSlice uses various subsystems and depending on the module would you like to work, other subsystems must be present <em>(you can disable them though in the code, e.g. at docker-compose.yaml file)</em>.</p>
<h2 id="general-requirements">General requirements</h2>
<ul>
<li>Docker should be installed in your development environment</li>
<li>Run the core subsystems (see <a href="#contribute-to-a-subsystem">related</a> section)</li>
</ul>
<h2 id="versionrelease-management">Version/release management</h2>
<p>Check <a href="https://nvie.com/posts/a-successful-git-branching-model/">this</a> nice article on how we develop and release versions.</p>
<p>We develop in the <code>develop</code> branch and follow a issue driven development model.</p>
<h2 id="getting-started">Getting Started</h2>
<p>To get the latest development branch, execute:</p>
<pre><code class="language-bash">wget https://labs.etsi.org/rep/osl/code/org.etsi.osl.main/-/raw/develop/compose/deploy.sh 
sudo ./deploy.sh develop  #[or replace develop with another branch name]
</code></pre>
<p>You may follow the <a href="https://osl.etsi.org/documentation/develop/deployment/">installation process</a>, as described at <code>develop</code> tagged documentation.</p>
<h2 id="contribute-to-a-subsystem">Contribute to a subsystem</h2>
<p>To work on a specific subsystem e.g. <code>org.etsi.osl.tmf.api</code>, you must:</p>
<ol>
<li>
<p>Deploy only the core necessary subsystems through:</p>
<p><code>bash
sudo docker compose --profile dev down;sudo docker compose --profile dev up -d --build</code></p>
<blockquote>
<p>Note <strong>--profile dev</strong> that will only deploy the core dependency subsystems, instead   of the whole OpenSlice.</p>
</blockquote>
<p><em>OR</em></p>
<p>Alternatively, comment out the respective container from the <code>docker-compose.yaml</code> file, so as to deploy the whole OpenSlice, except the subsystem you want to work on, following the provided installation steps.</p>
</li>
<li>
<p>Clone the respective repository, for example: <a href="https://labs.etsi.org/rep/osl/code/org.etsi.osl.tmf.api/-/tree/develop">https://labs.etsi.org/rep/osl/code/org.etsi.osl.tmf.api/-/tree/develop</a> (the clone URLs are available at this link)</p>
</li>
<li>
<p>Code! 😊</p>
</li>
</ol>
<h2 id="examples-of-developing-on-specific-subsystems">Examples of developing on specific subsystems</h2>
<h3 id="vnfnsd-catalog-management-and-nsd-deployment-api-service">VNF/NSD Catalog Management and NSD Deployment API service</h3>
<p>You need to:</p>