index.html

      Improved Testing with Robot in order to cover
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#improved-security-on-db" class="md-nav__link">
    <span class="md-ellipsis">
      Improved security on DB
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#scripts-upgraded" class="md-nav__link">
    <span class="md-ellipsis">
      Scripts upgraded
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#codebase-improvements" class="md-nav__link">
    <span class="md-ellipsis">
      Codebase Improvements
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#migration-to-gunicorn" class="md-nav__link">
    <span class="md-ellipsis">
      Migration to GUNICORN
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#release-00" class="md-nav__link">
    <span class="md-ellipsis">
      Release 0.0
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
                
                  


  <h1>Releasenotes</h1>

<h2 id="release-100"><strong>Release 1.0.0</strong></h2>
<h3 id="new-features"><strong>New Features</strong></h3>
<h4 id="registration-flow-improved">Registration Flow improved</h4>
<ul>
<li>Eliminated access from CAPIF to the Register user database when onboarding is performed.</li>
<li>Isolation between CCF and Register services, interaction now is only by HTTPS requested between Register, CCF and Vault.</li>
<li>Eliminated the "role" in user creation.<ul>
<li>Now a user can be an invoker or a provider at the same time</li>
</ul>
</li>
<li>Administrator User:<ul>
<li>New entity in charge of registering and managing users of the register service.</li>
</ul>
</li>
<li>UUID to identify users.<ul>
<li>When you create a user, a uuid is associated with it</li>
<li>The uuid will be contained in the token requested by the user and will be used to relate invokers and providers with users.</li>
</ul>
</li>
<li>Endpoints changed and created:<ul>
<li>Administrator endpoints:<ul>
<li>/createUser: /register endpoint changed to createUser. Used to register new users.</li>
<li>/deleteUser: /remove endpoint changed to this. Used to delete users and all the entities they had created.</li>
<li>/login: Allows administrator to log in to obtain the necessary tokens for their requests.</li>
<li>/refresh: Retrieve new access token token.</li>
<li>/getUsers: Returns the list with all registered users.</li>
</ul>
</li>
<li>Customer User:<ul>
<li>/getauth now also returns the urls needed to use CAPIF, used by customer.</li>
</ul>
</li>
</ul>
</li>
<li>
<p>Security improvements:</p>
<ul>
<li>/login uses basic auth with administrator credentials.</li>
<li>/getauth uses basic auth with customer user credentials.</li>
<li>Other requests use the administrator access token obtained from login.</li>
</ul>
</li>
<li>
<p>Current fields on user creation by administrator:</p>
</li>
</ul>
<pre><code>required_fields = {
    &quot;username&quot;: str,
    &quot;password&quot;: str,
    &quot;enterprise&quot;: str,
    &quot;country&quot;: str,
    &quot;email&quot;: str,
    &quot;purpose&quot;: str
}

optional_fields = {
    &quot;phone_number&quot;: str,
    &quot;company_web&quot;: str,
    &quot;description&quot;: str
}
</code></pre>
<ul>
<li>Test plan has been updated with the new register flow. Please check <a href="https://ocf.etsi.org/documentation/latest/testing/testplan/common_operations/" title="OCF Registration Flow">OCF Registration Flow</a></li>
<li>Video with explanation and demonstration of new register flow <a href="https://www.youtube.com/watch?v=sn-tN6eRvv8" title="New Registration Demo">New Registration Demo</a></li>
</ul>
<h4 id="new-opencapif-architecture">New OpenCAPIF architecture</h4>
<ul>
<li>New arquitecture with separated namespaces for Vault, CCF and Register components. Communication between them now are only allowed by using REST APIs.</li>
<li>
<p>New helper service inside CCF, it will simplify integration with third parties like external management portals.</p>
</li>
<li>
<p>Helper endpoints:</p>
<ul>
<li>/getInvokers : Get the list of invokers from CAPIF</li>
<li>/getProviders: Get the list of providers from CAPIF</li>
<li>/getServices : Get the list of services published in CAPIF</li>
<li>/getSecurityContext : Get the list of security contexts from CAPIF</li>
<li>/getEvents : Get the list of events subscriptions from CAPIF</li>
<li>/deleteEntities: Removes all entities registered by a user from the register</li>
</ul>
</li>
<li>
<p>Security in the helper</p>
<ul>
<li>To make requests to the helper you will need a superadmin certificate and password.</li>
</ul>
</li>
</ul>
<h4 id="events-api-upgrade">Events API Upgrade</h4>
<ul>
<li>The event management at CCF is improved, EventNotification include Event Details with required information.</li>
<li>Events updated:<ul>
<li>SERVICE_API_AVAILABLE and SERVICE_API_UNAVAILABLE with apiIds</li>
<li>SERVICE_API_UPDATE with serviceAPIDescriptions</li>
<li>API_INVOKER_ONBOARDED, API_INVOKER_UPDATED, API_INVOKER_OFFBOARDED with apiInvokerIds.</li>
</ul>
</li>
<li>Events Included:<ul>
<li>SERVICE_API_INVOCATION_SUCCESS and SERVICE_API_INVOCATION_FAILURE with invocationLogs</li>
</ul>
</li>
<li>Test plan include 7 new tests in order to check new events implemented and scenarios of each notification implemented, with a complete check of Event Notification.</li>
<li>Test plan documentation includes the new event tests <a href="https://ocf.etsi.org/documentation/latest/testing/testplan/api_events_service/" title="OCF Event test plan documentation">OCF Event test plan documentation</a>.</li>
</ul>
<h4 id="inital-implementation-of-cicd">Inital implementation of CI/CD</h4>
<ul>
<li>The inital implementation of CI/CD on gitlab was performed.</li>
<li>Detailed information in the <a href="[https://](https://labs.etsi.org/rep/ocf/community/-/wikis/OCF-CICD)" title="CI/CD Wiki">CICD Wiki</a>.</li>
<li>Implement initial CI/CD:<ul>
<li>Description of the CI process.<ul>
<li>In CI phase, created design, jobs and security checks when a branch is pushed.</li>
<li>The CI has jobs as:<ul>
<li>Linting code, unit test (if needed),</li>
<li>Build and push artifacts (images) in Git OCI register</li>
<li>Security checks,</li>
<li>SCA, CVS, SAST</li>
<li>The vulnerabilities are exposed in Merge Request panel to be solved.</li>
</ul>
</li>
</ul>
</li>
<li>Description of the CD process:<ul>
<li>Defined the environments to OCF.<ul>
<li>Production env.</li>
<li>Pre-production env.</li>
<li>Validation env.</li>
<li>Dev-1, dev-2… envs (ephemeral)</li>
</ul>
</li>
<li>Defined the naming convention to OCF releases<ul>
<li>Tag in prod: v0.0.1-release</li>
<li>Tag non-prod: v0.0.1-rc</li>
<li>Other tags: v0.0.1-test, v0.0.1-smt</li>
</ul>
</li>
<li>Defined the jobs of CD<ul>
<li>CD ensures the deployment in multiple envs. Therefore, the CD pipeline has deploy-ocf, delete-ocf (if needed) jobs</li>
</ul>
</li>
</ul>
</li>
<li>ETSI HIVE Labs:<ul>
<li>Designed, created and the Kuberntes OCF cluster is running to support OCFs deployments.</li>
<li>Iterating with ETSI HIVE’s support to solve computing issues.<ul>
<li>CPU compatibilities with OCF services (MongoDB): Fixed</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h3 id="documentation"><strong>Documentation</strong></h3>
<h4 id="improvements-on-documentation">Improvements on documentation</h4>
<ul>
<li>Documentation stored in <a href="https://labs.etsi.org/rep/ocf/documentation" title="OCF Documentation Repository">OCF Documentation Repository</a></li>
<li>Continuous Integration included at repository for web documentation:<ul>
<li>Develop version of documentation is automatically generated on each merge to develop branch.</li>
<li>Tagged version from main create documentation with related tag as version.</li>
</ul>
</li>
</ul>
<h3 id="technical-debt-solved"><strong>Technical Debt Solved</strong></h3>
<h4 id="improved-testing-with-robot-in-order-to-cover">Improved Testing with Robot in order to cover</h4>
<ul>
<li>Support of new Register flows.</li>
<li>Allow different URLs for register, ccf and vault services.</li>
<li>New Variables included to manage new architecture under test.</li>
<li>Mock server developed to add the functionality of write tests involving notification from Service Under Test.</li>
<li>Docker image improved generation and libraries upgraded to Robot Framework 7.</li>
</ul>
<h4 id="improved-security-on-db">Improved security on DB</h4>
<ul>
<li>Credentials requested to access mongo databases.</li>
<li>Credentials requested also by mongo-express.</li>
</ul>
<h4 id="scripts-upgraded">Scripts upgraded</h4>
<ul>
<li>Docker compose version 2 used on them.</li>
<li>New cleaning script developed.</li>
<li>Scripts upgraded:<ul>
<li><strong>check_services_are_running.sh</strong>: Checks if all essential services (Vault, CCF and Register) are running.</li>
<li><strong>clean_capif_docker_services.sh</strong>: Shutdowns and removes all services essential services.</li>
<li><strong>clean_capif_temporary_files.sh</strong>: Removes temporaly files from local repository. </li>
<li><strong>run.sh</strong>: Launch Essential services locally using docker compose, also monitoring can be launched.</li>
<li><strong>run_capif_tests.sh</strong>: Launch Robot Framwork Tests.</li>
<li><strong>show_logs.sh</strong>: Show locally logs of Services running.</li>
<li><strong>run_mock_server.sh</strong>: Launch mock server locally on all interfaces. This axiliary server is only used by tagged mockserver tests on Robot Framework.</li>
<li><strong>clean_mock_server.sh</strong>: Remove mock server local deployment.</li>
<li><strong>deploy.sh</strong>: This script simplify the way to download capif repository.</li>
</ul>
</li>
</ul>
<h4 id="codebase-improvements">Codebase Improvements</h4>
<ul>
<li>Documentation is now on splitted repository <a href="https://labs.etsi.org/rep/ocf/documentation" title="OCF Documentation Repository">OCF Documentation Repository</a></li>
<li>Test plan was moved to <a href="https://labs.etsi.org/rep/ocf/documentation" title="OCF Documentation Repository">OCF Documentation Repository</a></li>
<li>Obsolote data is removed.</li>
<li>Repository Reorganization: Enhanced structure and maintainability with a better directory layout and clearer module separation.</li>
<li>Code Quality Enhancements: Refactored code and fixed known issues</li>
</ul>
<h4 id="migration-to-gunicorn">Migration to GUNICORN</h4>
<ul>
<li>Include production server on each microservice: Release 0 use Flask developer server, now we use GUNICORN.</li>
</ul>
<hr />
<h2 id="release-00"><strong>Release 0.0</strong></h2>
<p>The APIs included in Release 0.0 are:</p>
<ul>
<li>JWT Authentication APIs</li>
<li>CAPIF Invoker Management API</li>
<li>CAPIF Publish API</li>
<li>CAPIF Discover API</li>
<li>CAPIF Security API</li>
<li>CAPIF Events API</li>
<li>CAPIF Provider Management API</li>
</ul>
<p>This Release also includes a Robot Test Suite for all those services and a Postman Test Suite for simple testing.</p>












                
              </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">
  
    
  
  <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 TeraflowSDN 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://tfs.etsi.org/" target="_blank" rel="noopener" title="tfs.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>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://labs.etsi.org/rep/tfs" 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.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="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.81s-5.7.083-8.4 1.11c-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.1 18.1 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.3s9.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-82"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://www.linkedin.com/company/teraflowsdn/" 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.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="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.3M135.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.5m282.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.9z"/></svg>
    </a>
  
    
    
    
    
      
      
    
    <a href="https://twitter.com/TeraflowSDN" 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.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="M389.2 48h70.6L305.6 224.2 487 464H345L233.7 318.6 106.5 464H35.8l164.9-188.5L26.8 48h145.6l100.5 132.9zm-24.8 373.8h39.1L151.1 88h-42z"/></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.07f07601.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.56dfad97.min.js"></script>
      
    
  </body>
</html>