index.html

        
  
  <span class="md-ellipsis">
    Introduction
    
  </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">
    Testing
    
  </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>
            Testing
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../testing/testplan/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Test Plan
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../testing/robotframework/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Robot Framework
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../testing/postman/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Postman
    
  </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">
    Sandbox
    
  </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>
            Sandbox
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../sandbox/sandbox/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Introduction
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../sandbox/requestaccess/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    How to Request Access
    
  </span>
  

      </a>
    </li>
  

              
            
              
                
  
  
  
  
    <li class="md-nav__item">
      <a href="../../sandbox/relevantinfo/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Relevant Information
    
  </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/documenting/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    Documenting
    
  </span>
  

      </a>
    </li>
  

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

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="../../FAQ/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    FAQ
    
  </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="#downloading-the-project" class="md-nav__link">
    <span class="md-ellipsis">
      Downloading the project
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Downloading the project">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#1-create-a-folder-to-download-the-project" class="md-nav__link">
    <span class="md-ellipsis">
      1. Create a folder to download the project
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#2-download-the-deployment-script" class="md-nav__link">
    <span class="md-ellipsis">
      2. Download the deployment script
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#3-run-the-deployment-script" class="md-nav__link">
    <span class="md-ellipsis">
      3. Run the deployment script
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#run-all-capif-services-locally-with-docker-images" class="md-nav__link">
    <span class="md-ellipsis">
      Run All CAPIF Services locally with Docker images
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#run-all-capif-services-locally-with-docker-images-and-deploy-monitoring-stack" class="md-nav__link">
    <span class="md-ellipsis">
      Run All CAPIF Services locally with Docker images and deploy monitoring stack
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#run-each-service-using-docker" class="md-nav__link">
    <span class="md-ellipsis">
      Run each service using Docker
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#run-each-service-using-python" class="md-nav__link">
    <span class="md-ellipsis">
      Run each service using Python
    </span>
  </a>
  
    <nav class="md-nav" aria-label="Run each service using Python">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#start-your-testing-with-opencapif" class="md-nav__link">
    <span class="md-ellipsis">
      Start Your Testing with OpenCAPIF
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
                
                  



<h1 id="how-to-run">How to Run</h1>
<blockquote>
<p>Capif services are developed under <a href="https://labs.etsi.org/rep/ocf/capif/-/tree/main/services">services folder</a>.</p>
</blockquote>
<h3 id="downloading-the-project">Downloading the project</h3>
<p>You can easily download CAPIF to run in local environment following next steps:</p>
<h4 id="1-create-a-folder-to-download-the-project">1. Create a folder to download the project</h4>
<pre><code>mkdir OpenCAPIF

cd OpenCAPIF
</code></pre>
<h4 id="2-download-the-deployment-script">2. Download the deployment script</h4>
<p>Download the deployment / environment preparation script (press <a href="https://labs.etsi.org/rep/ocf/capif/-/raw/staging/deploy.sh?inline=false">here</a> to directly download script):</p>
<pre><code>wget https://labs.etsi.org/rep/ocf/capif/-/raw/staging/deploy.sh
</code></pre>
<p>Make it executable:</p>
<pre><code>chmod +x deploy.sh
</code></pre>
<h4 id="3-run-the-deployment-script">3. Run the deployment script</h4>
<p>This script selects the branch for capif repository project to pull from.</p>
<p>If you run the script without selecting a branch the the main branch is going to be selected.</p>
<p>We recommend:</p>
<ul>
<li><strong>main</strong> branch for the most stable experience and <strong>staging</strong> branch for an experience with the latest features (for staging branch installation, it is strongly advisable that you may as well follow the staging documentation)</li>
</ul>
<pre><code># ./deploy.sh [branch to fetch] [true or false (default) to install monitoring stack or not]

sudo ./deploy.sh staging
</code></pre>
<blockquote>
<p><strong>We recommend running the deploy.sh script with root permissions! In other case, some directories may not be accessible by the project building tools and hinder the smooth installation.</strong></p>
</blockquote>
<h3 id="run-all-capif-services-locally-with-docker-images">Run All CAPIF Services locally with Docker images</h3>
<p>To run using docker and docker compose, version 2.10 or higher, you must ensure you have those tools installed in your machine. Also to simplify the process, we have 3 scripts allowing docker images to deploy, check and cleanup.</p>
<p>All these scripts are available under <strong><em>services</em></strong> directory.</p>
<p>To run CAPIF APIs locally using docker and docker-compose you can use run.sh script:</p>
<pre><code>./run.sh -h

Usage: ./run.sh &lt;options&gt;
       -c : Setup different hostname for capif
       -m : Launch monitoring service
       -h : show this help
</code></pre>
<p>This script builds and runs all services using docker images, including mongodb and nginx locally and in the background, and imports ca.crt to nginx. By default monitoring is not activated and Nginx is deployed use <strong>capifcore</strong> as a hostname.</p>
<p>Some examples of use:</p>
<pre><code># Default values, No monitoring and capifcore as CAPIF_HOSTNAME
./run.sh

# opencapif.etsi.org as CAPIF_HOSTNAME
./run.sh -c opencapif.etsi.org

# opencapif.etsi.org as CAPIF_HOSTNAME and monitoring activated
./run.sh -c opencapif.etsi.org -m 

</code></pre>
<blockquote>
<p><strong>IMPORTANT NOTE:</strong> In some versions change of hostname in local deployment (setting some value different than <strong><em>capifcore</em></strong>) creates wrong certificates on vault component. This prevents successful requests using the certificates. if this is your case, here is a little workaround to solve this issue meanwhile SDG is solving it:</p>
<ul>
<li>Modify the hostname in the file <strong><em>capif/services/vault/vault_prepare_certs.sh</em></strong> on lines 43, 68, and 95.</li>
<li>Update the url parameter of the CCF from capifcore to the desired hostname in the file <strong><em>capif/services/register/config.yaml</em></strong>.</li>
</ul>
</blockquote>
<p>If you want to check if all CAPIF services are running properly in a local machine after executing run.sh, you can use:</p>
<pre><code>./check_services_are_running.sh
</code></pre>
<p>This shell script will return 0 if all services are running properly.</p>
<p>When we need to stop all CAPIF services, we can use next bash script:</p>
<pre><code>./clean_capif_docker_services.sh -a
</code></pre>
<p>NOTE: You can use different flags if you only want to stop some of them, please check the help using:</p>
<pre><code>./clean_capif_docker_services.sh -h

Usage: clean_capif_docker_services.sh &lt;options&gt;
       -c : clean capif services
       -v : clean vault service
       -r : clean register service
       -m : clean monitoring service
       -a : clean all services
       -h : show this help
</code></pre>
<p>This shell script will remove and clean all CAPIF services started previously with run.sh</p>
<p>On the other hand you can check logs using show_logs.sh script, please check options:</p>
<pre><code>./show_logs.sh
You must specify an option when running the script.
Usage: ./show_logs.sh &lt;options&gt;
       -c : Show capif services
       -v : Show vault service
       -r : Show register service
       -m : Show monitoring service
       -a : Show all services
       -f : Follow log output
       -h : Show this help
</code></pre>
<blockquote>
<p>You can also use option -f in order to follow log output in real time</p>
</blockquote>
<h3 id="run-all-capif-services-locally-with-docker-images-and-deploy-monitoring-stack">Run All CAPIF Services locally with Docker images and deploy monitoring stack</h3>
<p>It is now possible to deploy a monitoring stack for CAPIF with Grafana, Prometheus, FluentBit, Loki, Cadvisor, Tempo and Opentelemetry.</p>
<p>To deploy CAPIF together with the monitoring stack, it is only necessary to execute the following.</p>
<pre><code>./run.sh -m true
</code></pre>
<p>After they have been built, the different panels can be consulted in Grafana at the url</p>
<pre><code>http://localhost:3000
</code></pre>
<blockquote>
<p>By default, the monitoring option is set to false. Once up, all data sources and dashboards are automatically provisioned.</p>
</blockquote>
<h3 id="run-each-service-using-docker">Run each service using Docker</h3>
<p>Also you can run OpenCAPIF service by service using docker:</p>
<pre><code>cd &lt;Service&gt;
docker build -t capif_security .
docker run -p 8080:8080 capif_security
</code></pre>
<h3 id="run-each-service-using-python">Run each service using Python</h3>
<p>Run using python</p>
<pre><code>cd &lt;Service&gt;
pip3 install -r requirements.txt
python3 -m &lt;service&gt;
</code></pre>
<h4 id="start-your-testing-with-opencapif">Start Your Testing with OpenCAPIF</h4>
<p>Related with OpenCAPIF Testing, the following sections help you to understand testing implemented and how to run it by yourself:</p>
<ul>
<li><a href="../../testing/testplan/" title="Test Plan">Test Plan Directory</a>: Here you can find the complete test plan definition that are accomplish by all versions released of OpenCAPIF.</li>
<li><a href="../../testing/robotframework/" title="Robot Framework">Testing with Robot Framework</a>: At this section you can find all information about how to run the test suite implemented using Robot Framework.</li>
<li><a href="../../testing/postman/" title="Postman">Testing with Postman</a>: Easy way to understand the complete basic OpenCAPIF flow, acting as invoker and provider.</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="../../helper/swagger/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Swagger">
            <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>
            <div class="md-footer__title">
              <span class="md-footer__direction">
                Previous
              </span>
              <div class="md-ellipsis">
                Swagger
              </div>
            </div>
          </a>
        
        
          
          <a href="../../vendor-ext/vendor-ext/" class="md-footer__link md-footer__link--next" aria-label="Next: Vendor Extensibility">
            <div class="md-footer__title">
              <span class="md-footer__direction">
                Next
              </span>
              <div class="md-ellipsis">
                Vendor Extensibility
              </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>
            </div>
          </a>
        
      </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">
      Copyright &copy; 2019-2024 OpenCAPIF 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://ocf.etsi.org/" target="_blank" rel="noopener" title="ocf.etsi.org" class="md-social__link">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.7.2 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/ocf" 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.7.2 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/opencapif/" 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.7.2 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/OpenCAPIF" 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.7.2 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.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight"], "search": "../../assets/javascripts/workers/search.f8cc74c7.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.c8b220af.min.js"></script>
      
        <script src="../../assets/swagger/swagger-ui-bundle.js"></script>
      
        <script src="../../assets/swagger/swagger-ui-standalone-preset.js"></script>
      
    
  </body>
</html>