Commit 216230a2 authored by Jorge Moratinos's avatar Jorge Moratinos
Browse files

Deployed 5669454d to develop in public with MkDocs 1.6.1 and mike 2.1.3

parent a6eb8f22

public/develop/releasenotes/index.html

+333 −11
Original line number Diff line number Diff line
@@ -78,7 +78,7 @@ 
    <div data-md-component="skip">

      

        

        <a href="#release-100" class="md-skip">

        <a href="#release-200" class="md-skip">

          Skip to content

        </a>
@@ -332,6 +332,120 @@ 
    </label>

    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

      

        <li class="md-nav__item">

  <a href="#release-200" class="md-nav__link">

    <span class="md-ellipsis">

      Release 2.0.0

    </span>

  </a>

  

    <nav class="md-nav" aria-label="Release 2.0.0">

      <ul class="md-nav__list">

        

          <li class="md-nav__item">

  <a href="#new-features" class="md-nav__link">

    <span class="md-ellipsis">

      New Features

    </span>

  </a>

  

    <nav class="md-nav" aria-label="New Features">

      <ul class="md-nav__list">

        

          <li class="md-nav__item">

  <a href="#3gpp-capif-release-18" class="md-nav__link">

    <span class="md-ellipsis">

      3GPP CAPIF release 18

    </span>

  </a>

  

</li>

        

      </ul>

    </nav>

  

</li>

        

          <li class="md-nav__item">

  <a href="#technical-debt-solved" class="md-nav__link">

    <span class="md-ellipsis">

      Technical Debt Solved

    </span>

  </a>

  

    <nav class="md-nav" aria-label="Technical Debt Solved">

      <ul class="md-nav__list">

        

          <li class="md-nav__item">

  <a href="#api-status-feature" class="md-nav__link">

    <span class="md-ellipsis">

      Api Status feature

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#issues" class="md-nav__link">

    <span class="md-ellipsis">

      Issues

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#local-scripts" class="md-nav__link">

    <span class="md-ellipsis">

      Local Scripts

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#remote-scripts" class="md-nav__link">

    <span class="md-ellipsis">

      Remote Scripts

    </span>

  </a>

  

</li>

        

      </ul>

    </nav>

  

</li>

        

          <li class="md-nav__item">

  <a href="#documentation" class="md-nav__link">

    <span class="md-ellipsis">

      Documentation

    </span>

  </a>

  

    <nav class="md-nav" aria-label="Documentation">

      <ul class="md-nav__list">

        

          <li class="md-nav__item">

  <a href="#new-test-included-on-documentation" class="md-nav__link">

    <span class="md-ellipsis">

      New test included on documentation

    </span>

  </a>

  

</li>

        

      </ul>

    </nav>

  

</li>

        

      </ul>

    </nav>

  

</li>

      

        <li class="md-nav__item">

  <a href="#release-100" class="md-nav__link">

    <span class="md-ellipsis">
@@ -343,7 +457,7 @@ 
      <ul class="md-nav__list">

        

          <li class="md-nav__item">

  <a href="#new-features" class="md-nav__link">

  <a href="#new-features_1" class="md-nav__link">

    <span class="md-ellipsis">

      New Features

    </span>
@@ -394,7 +508,7 @@ 
</li>

        

          <li class="md-nav__item">

  <a href="#documentation" class="md-nav__link">

  <a href="#documentation_1" class="md-nav__link">

    <span class="md-ellipsis">

      Documentation

    </span>
@@ -418,7 +532,7 @@ 
</li>

        

          <li class="md-nav__item">

  <a href="#technical-debt-solved" class="md-nav__link">

  <a href="#technical-debt-solved_1" class="md-nav__link">

    <span class="md-ellipsis">

      Technical Debt Solved

    </span>
@@ -803,6 +917,120 @@ 
    </label>

    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

      

        <li class="md-nav__item">

  <a href="#release-200" class="md-nav__link">

    <span class="md-ellipsis">

      Release 2.0.0

    </span>

  </a>

  

    <nav class="md-nav" aria-label="Release 2.0.0">

      <ul class="md-nav__list">

        

          <li class="md-nav__item">

  <a href="#new-features" class="md-nav__link">

    <span class="md-ellipsis">

      New Features

    </span>

  </a>

  

    <nav class="md-nav" aria-label="New Features">

      <ul class="md-nav__list">

        

          <li class="md-nav__item">

  <a href="#3gpp-capif-release-18" class="md-nav__link">

    <span class="md-ellipsis">

      3GPP CAPIF release 18

    </span>

  </a>

  

</li>

        

      </ul>

    </nav>

  

</li>

        

          <li class="md-nav__item">

  <a href="#technical-debt-solved" class="md-nav__link">

    <span class="md-ellipsis">

      Technical Debt Solved

    </span>

  </a>

  

    <nav class="md-nav" aria-label="Technical Debt Solved">

      <ul class="md-nav__list">

        

          <li class="md-nav__item">

  <a href="#api-status-feature" class="md-nav__link">

    <span class="md-ellipsis">

      Api Status feature

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#issues" class="md-nav__link">

    <span class="md-ellipsis">

      Issues

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#local-scripts" class="md-nav__link">

    <span class="md-ellipsis">

      Local Scripts

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#remote-scripts" class="md-nav__link">

    <span class="md-ellipsis">

      Remote Scripts

    </span>

  </a>

  

</li>

        

      </ul>

    </nav>

  

</li>

        

          <li class="md-nav__item">

  <a href="#documentation" class="md-nav__link">

    <span class="md-ellipsis">

      Documentation

    </span>

  </a>

  

    <nav class="md-nav" aria-label="Documentation">

      <ul class="md-nav__list">

        

          <li class="md-nav__item">

  <a href="#new-test-included-on-documentation" class="md-nav__link">

    <span class="md-ellipsis">

      New test included on documentation

    </span>

  </a>

  

</li>

        

      </ul>

    </nav>

  

</li>

        

      </ul>

    </nav>

  

</li>

      

        <li class="md-nav__item">

  <a href="#release-100" class="md-nav__link">

    <span class="md-ellipsis">
@@ -814,7 +1042,7 @@ 
      <ul class="md-nav__list">

        

          <li class="md-nav__item">

  <a href="#new-features" class="md-nav__link">

  <a href="#new-features_1" class="md-nav__link">

    <span class="md-ellipsis">

      New Features

    </span>
@@ -865,7 +1093,7 @@ 
</li>

        

          <li class="md-nav__item">

  <a href="#documentation" class="md-nav__link">

  <a href="#documentation_1" class="md-nav__link">

    <span class="md-ellipsis">

      Documentation

    </span>
@@ -889,7 +1117,7 @@ 
</li>

        

          <li class="md-nav__item">

  <a href="#technical-debt-solved" class="md-nav__link">

  <a href="#technical-debt-solved_1" class="md-nav__link">

    <span class="md-ellipsis">

      Technical Debt Solved

    </span>
@@ -979,8 +1207,102 @@ 


  <h1>Release Notes</h1>



<h2 id="release-100"><strong>Release 1.0.0</strong></h2>

<h2 id="release-200"><strong>Release 2.0.0</strong></h2>

<h3 id="new-features"><strong>New Features</strong></h3>

<h4 id="3gpp-capif-release-18">3GPP CAPIF release 18</h4>

<ul>

<li>New endpoints included in new release 18 with new logic.</li>

<li>New logic to support <strong><em>Vendor Extensibility</em></strong> on Publish Service.</li>

<li>New logic to support <strong><em>API Status</em></strong> feature on Publish and Events Services.</li>

<li>Supported Features now are mandatory for all POST and PUT Requests as is described on TS 29.222.<ul>

<li><strong>Possible Breaking change</strong>, all POST request now must include supported features attribute, default can me set to "0" to keep all features inactive.</li>

<li><strong>Possible Breaking change</strong> on Events API, if you need eventDetails information on notification you must activate <strong>Enhanced Event Report</strong> feature by setting properly the supported features flag.</li>

</ul>

</li>

</ul>

<h3 id="technical-debt-solved"><strong>Technical Debt Solved</strong></h3>

<h4 id="api-status-feature"><strong>Api Status feature</strong></h4>

<ul>

<li>Events API:<ul>

<li>Event internal notifications between services improved to accomplish specification.</li>

<li>On event subscription <strong>SupportedFeatures</strong> is readed and stored in db to accomplish specification.</li>

<li>Also <strong>SupportedFeatures</strong> is checked before send event notification, in order to accomplish specification, sending <strong>eventDetails</strong> and related information according to <strong><em>enhanced_event_report</em></strong> and <strong><em>apiStatusMonitoring</em></strong> supported features activated.</li>

</ul>

</li>

</ul>

<h4 id="issues"><strong>Issues</strong></h4>

<ul>

<li>Solved issue to get ready REDIS on deployment: REDIS scheduled on start to allow receive notification since service is deployed.</li>

<li>Solved problem removing service APIs published is provider register more than one APF.</li>

<li>Solved Superadmin problem deleting service API published through helper service if provider is not present.</li>

<li>Increased the overall stability, fixing some corner cases.</li>

<li>Location headers now are filled in same way at all services that needs it.</li>

<li>Security issues solved.</li>

<li>Base docker images present on ETSI registry.</li>

<li>Robot image uploaded to ETSI Registry.</li>

</ul>

<h4 id="local-scripts">Local Scripts</h4>

<ul>

<li>All scripts were reviewed and improved.</li>

<li>New scripts to manage users on local deployment added:</li>

<li>create_users.sh: helps developer to create new users in local deployment.</li>

<li>remove_users.sh: helps developer to remove users from db in local deployment.</li>

</ul>

<h4 id="remote-scripts">Remote Scripts</h4>

<p>New scripts developed to help on remote deployment, configuration and testing. All this script are stored under helm/scripts in capif repository.</p>

<p><strong><em>variables.sh</em></strong> contains all configuration that will be used on remote operation. This file must be filled carefully before run remote scripts.</p>

<ul>

<li>

<p>Deployment Scripts:</p>

<ul>

<li><strong><em>install_vault.sh</em></strong>: Deploy Vault component from k8s cluster, only needed if vault is not previously deployed. If it’s deployed you can setup vault token on variables.sh.</li>

<li><strong><em>install_monitoring.sh</em></strong>: Deploy monitoring on k8s cluster.</li>

<li><strong><em>install_capif.sh</em></strong>: Deploy OpenCAPIF on k8s cluster. It will be deployed on configured namespace with domain and hostnames configured under variables.sh.</li>

<li><strong><em>uninstall_vault.sh</em></strong>: Rollback Vault component from k8s cluster.</li>

<li><strong><em>uninstall_monitoring.sh</em></strong>: Rollback monitoring components from k8s cluster.</li>

<li><strong><em>uninstall_capif.sh</em></strong>: Rollback OpenCAPIF from k8s cluster.</li>

</ul>

</li>

<li>

<p>Manage remote users:</p>

<ul>

<li><strong><em>create_remote_users.sh</em></strong>: This script create users setup by parameters on deployed OpenCAPIF. Those users are created by administrator.</li>

<li><strong><em>remove_remote_users.sh</em></strong>: This script removes user from deployed OpenCAPIF.</li>

<li><strong><em>remove_remote_users_by_prefix.sh</em></strong>:: This script removes users by prefix.</li>

</ul>

</li>

<li>

<p>Configuration of bastion machine, this simplify DNS fixed resolution:</p>

<ul>

<li><strong><em>get_ingress.sh</em></strong>: This create a configuration for dns fixed resolution for ingress configured in namespace passed by parameters.</li>

<li><strong><em>set_ingress.sh</em></strong>: This scripts adds to /etc/hosts the fixed DNS resolution for ingress setup for  namespace passed by parameters.</li>

</ul>

</li>

<li>

<p>Execute robot tests over remote deployment.</p>

<ul>

<li><strong><em>run_remote_capif_tests.sh</em></strong>: This scripts launch Robot Test docker image on current machine to reach deployed OpenCAPIF. Is useful to launch with “--include smoke” in order to ensure all is deployed properly.</li>

</ul>

</li>

<li>

<p>Just for testing, next scripts upload dummy information to deployed OpenCAPIF:</p>

<ul>

<li><strong><em>populate_create_remote_dummy_users.sh</em></strong>: : Create Dummy providers and invokers, publish service APIs and creates security context for invokers.</li>

<li><strong><em>populate_remove_remote_dummy_users.sh</em></strong>: Remove dummy information created.</li>

</ul>

</li>

</ul>

<h3 id="documentation"><strong>Documentation</strong></h3>

<h4 id="new-test-included-on-documentation">New test included on documentation</h4>

<ul>

<li>New Vendor Extensibility test suite with 9 tests. <a href="../testing/testplan/vendor_extensibility/">Api Events Service</a></li>

<li>New <a href="../testing/testplan/api_status/">API Status feature</a> test suite.</li>

<li>Improved <a href="../testing/testplan/api_events_service/">Events test suite</a> with 8 new tests.</li>

<li>Test plan updated with default supported features for all request set to "0" (all inactive by default) <a href="../testing/testplan/common_operations/">See common operations</a>.</li>

</ul>

<hr />

<h2 id="release-100"><strong>Release 1.0.0</strong></h2>

<h3 id="new-features_1"><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>
@@ -1087,7 +1409,7 @@ optional_fields = { 
<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>Detailed information in the <a href="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>
@@ -1132,7 +1454,7 @@ optional_fields = { 
</ul>

</li>

</ul>

<h3 id="documentation"><strong>Documentation</strong></h3>

<h3 id="documentation_1"><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>
@@ -1142,7 +1464,7 @@ optional_fields = { 
</ul>

</li>

</ul>

<h3 id="technical-debt-solved"><strong>Technical Debt Solved</strong></h3>

<h3 id="technical-debt-solved_1"><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>

public/develop/search/search_index.json

+1 −1

File changed.

Preview size limit exceeded, changes collapsed.

public/develop/sitemap.xml

+25 −21
Original line number Diff line number Diff line
@@ -2,86 +2,90 @@ 
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">

    <url>

         <loc>https://ocf.etsi.org/develop/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/FAQ/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/architecture/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/releasenotes/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/contribute/documenting/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/gettingstarted/howtorun/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/gettingstarted/repository/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/postman/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/robotframework/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/testplan/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/testplan/api_access_control_policy/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/testplan/api_auditing_service/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/testplan/api_discover_service/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/testplan/api_events_service/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/testplan/api_invoker_management/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/testplan/api_logging_service/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/testplan/api_provider_management/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/testplan/api_publish_service/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/testplan/api_security_service/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/testplan/api_status/</loc>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/testplan/common_operations/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

    <url>

         <loc>https://ocf.etsi.org/develop/testing/testplan/vendor_extensibility/</loc>

         <lastmod>2025-01-06</lastmod>

         <lastmod>2025-01-16</lastmod>

    </url>

</urlset>
 
 No newline at end of file

public/develop/sitemap.xml.gz

+6 B (419 B)

File changed.

No diff preview for this file type.

View original file
View changed file

public/develop/testing/testplan/api_access_control_policy/service_api_description_post_example.json

+1 −1
Original line number Diff line number Diff line
@@ -95,7 +95,7 @@ 
    }

  ],

  "description": "string",

  "supportedFeatures": "fffff",

  "supportedFeatures": "0",

  "shareableInfo": {

    "isShareable": true,

    "capifProvDoms": [