Skip to content
Snippets Groups Projects
index.html 63.6 KiB
Newer Older
      <a href="../../testing_services/test_inventory.md" class="md-nav__link">
        <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">
        <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>
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
      <a href="../../product_model/product_spec.md" class="md-nav__link">
      <a href="../../product_model/product_catalogs.md" class="md-nav__link">
      <a href="../../product_model/product_inventory.md" class="md-nav__link">
        <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">
        <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>
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
      <a href="../../assurance_services/intro.md" class="md-nav__link">
      <a href="../../assurance_services/alarms_actions.md" class="md-nav__link">
        <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>
            
      <a href="../../architecture/architecture/" class="md-nav__link">
        <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">
        <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>
      <a href="../../architecture/CRIDGE_cloud_native_intro.md" class="md-nav__link">
      <a href="../../architecture/CRIDGE/CRIDGEforDevelopers/" class="md-nav__link">
              
                
  
  
  
  
    <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>
  

              
            
              
                
  
  
  
  
        <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>
  

              
            
              
                
  
  
  
  
    <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">
        <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>
          </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 class="md-nav__item">
  <a href="#slack" class="md-nav__link">
    <span class="md-ellipsis">
      Slack
    </span>
  </a>
  
      
        <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 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 class="md-nav__item">
  <a href="#versionrelease-management" class="md-nav__link">
    <span class="md-ellipsis">
      Version/release management
    </span>
  </a>
  
      
        <li class="md-nav__item">
  <a href="#wishlist" class="md-nav__link">
    <span class="md-ellipsis">
      Wishlist
    </span>
  </a>
  
  </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 class="md-nav__item">
  <a href="#slack" class="md-nav__link">
    <span class="md-ellipsis">
      Slack
    </span>
  </a>
  
      
        <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 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 class="md-nav__item">
  <a href="#versionrelease-management" class="md-nav__link">
    <span class="md-ellipsis">
      Version/release management
    </span>
  </a>
  
      
        <li class="md-nav__item">
  <a href="#wishlist" class="md-nav__link">
    <span class="md-ellipsis">
      Wishlist
    </span>
  </a>
  
              </div>
            
          
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
                
                  
<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 (you can disable them though in the code, e.g. at docker-compose.yaml file).</p>
<p>To get the latest development branch:</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 other branch name]
</code></pre>
<p>You may follow the <a href="https://osl.etsi.org/documentation/develop/deployment/">installation process</a>, as described at "develop" tagged documentation.</p>
<p>To work on a specific subsystem e.g. org.etsi.osl.tmf.api, you must:</p>
<p>1a - Deploy only the core necessary subsystems through:</p>
<pre><code class="language-bash">sudo docker compose --profile dev down;sudo docker compose --profile dev up -d --build
<p>Note <strong>--profile dev</strong> that will only deploy the core dependency subsystems, instead   of the whole OpenSlice.</p>
<p>1b - Or alternatively, commend out the respective container from the docker-compose.yaml file, so as to deploy the whole OpenSlice, except the subsystem you want to work on, following the provided installation steps.</p>
<p>2 - Clone the respective repository, e.g. https://labs.etsi.org/rep/osl/code/org.etsi.osl.tmf.api/-/tree/develop</p>
<p>3 - Code :)</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 above section)</li>
</ul>
<h2 id="slack">Slack</h2>
<p>Feel free to join OpenSlice <a href="https://openslice.slack.com">Slack</a> for any development oriented questions.</p>
<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>Clone the repository: https://labs.etsi.org/rep/osl/code/org.etsi.osl.portal.api/-/tree/develop</p>
<p>Check the docker-compose.yml file. Default port is 13080. Check specifically the datasource username/password, server port.</p>
<p>Make sure that the core subsystems are up and running.</p>
<p>Execute it with </p>
<pre><code class="language-bash">mvn spring-boot:run
</code></pre>
<p>For verification, Swagger API of the service is at <code>http://localhost:13000/osapi/swagger-ui/index.html</code>. </p>
<p>There, you may try there various REST actions and authenticate via the OAuth server without the use of the UI.</p>
<h3 id="vnfnsd-catalog-management-and-nsd-deployment-web-ui-service">VNF/NSD Catalog Management and NSD Deployment WEB UI service</h3>
<p>The Web UI is written in AngularJS.</p>
<p>Clone the repository: https://labs.etsi.org/rep/osl/code/org.etsi.osl.portal.web/-/tree/develop</p>
<p>By default the project org.etsi.osl.portal.api exposes the folder ../org.etsi.osl.portal.web/src/ in a folder testweb (Check class MvcConfig.java in org.etsi.osl.portal.api) for development. (In production nginx is used). Point your browser to <code>http://localhost:13000/osapi/testweb/index.html/</code></p>
<h2 id="versionrelease-management">Version/release management</h2>
<p>Check this nice article on how we develop and release versions.</p>
<p>https://nvie.com/posts/a-successful-git-branching-model/</p>
<p>We develop in the develop branch and follow a issue driven development model.</p>
<p>Check also our wishlist of new features. You can add your own.</p>
<p>See <a href="../wishlist/">Wishlist</a>.</p>
          
          
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
        
          <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="../../architecture/centrallog/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Central logging">
            <div class="md-footer__button md-icon">
              
              <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
            <div class="md-footer__title">
              <span class="md-footer__direction">
                Previous
              </span>
              <div class="md-ellipsis">
                Central logging
              </div>
          
          <a href="../../terminology/" class="md-footer__link md-footer__link--next" aria-label="Next: Terminology">
            <div class="md-footer__title">
              <span class="md-footer__direction">
                Next
              </span>
              <div class="md-ellipsis">
                Terminology
              </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 11z"/></svg>
      </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">
  
  
    Made with
    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
      Material for MkDocs
    </a>
  
      
        <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.6.0 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 2024 Fonticons, Inc.--><path d="M352 256c0 22.2-1.2 43.6-3.3 64H163.4c-2.2-20.4-3.3-41.8-3.3-64s1.2-43.6 3.3-64h185.3c2.2 20.4 3.3 41.8 3.3 64m28.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-64m112.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.7m-209 0H18.6c30-74.1 93.6-130.9 172-151.6-25.5 34.2-45.3 87.7-55.3 151.6M8.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-64m186.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.6zm358.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.7z"/></svg>