Commit bd112c59 authored by Julien Satti's avatar Julien Satti ✨
Browse files

Deployed 03321988 to develop in public with MkDocs 1.6.1 and mike 2.1.3

parent c0959c64

public/develop/404.html

+3 −3
Original line number Diff line number Diff line
@@ -509,7 +509,7 @@ 
            

  

  <span class="md-ellipsis">

    Contributing

    Contribute

  </span>
@@ -519,7 +519,7 @@ 
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">

          <label class="md-nav__title" for="__nav_4">

            <span class="md-nav__icon md-icon"></span>

            Contributing

            Contribute

          </label>

          <ul class="md-nav__list" data-md-scrollfix>
@@ -534,7 +534,7 @@ 
        

  

  <span class="md-ellipsis">

    Documentation

    Documenting

  </span>

public/develop/FAQ/index.html

+5 −5
Original line number Diff line number Diff line
@@ -518,7 +518,7 @@ 
            

  

  <span class="md-ellipsis">

    Contributing

    Contribute

  </span>
@@ -528,7 +528,7 @@ 
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">

          <label class="md-nav__title" for="__nav_4">

            <span class="md-nav__icon md-icon"></span>

            Contributing

            Contribute

          </label>

          <ul class="md-nav__list" data-md-scrollfix>
@@ -543,7 +543,7 @@ 
        

  

  <span class="md-ellipsis">

    Documentation

    Documenting

  </span>
@@ -1081,7 +1081,7 @@ 
      <nav class="md-footer__inner md-grid" aria-label="Footer" >

        

          

          <a href="../contribute/documenting/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Documentation">

          <a href="../contribute/documenting/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Documenting">

            <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>
@@ -1091,7 +1091,7 @@ 
                Previous

              </span>

              <div class="md-ellipsis">

                Documentation

                Documenting

              </div>

            </div>

          </a>

public/develop/architecture/index.html

+3 −3
Original line number Diff line number Diff line
@@ -598,7 +598,7 @@ 
            

  

  <span class="md-ellipsis">

    Contributing

    Contribute

  </span>
@@ -608,7 +608,7 @@ 
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">

          <label class="md-nav__title" for="__nav_4">

            <span class="md-nav__icon md-icon"></span>

            Contributing

            Contribute

          </label>

          <ul class="md-nav__list" data-md-scrollfix>
@@ -623,7 +623,7 @@ 
        

  

  <span class="md-ellipsis">

    Documentation

    Documenting

  </span>

public/develop/contribute/documenting/index.html

+6 −6
Original line number Diff line number Diff line
@@ -26,7 +26,7 @@ 
    

    

      

        <title>Documentation - ETSI SDG OCF Documentation</title>

        <title>Documenting - ETSI SDG OCF Documentation</title>
@@ -117,7 +117,7 @@ 
        <div class="md-header__topic" data-md-component="header-topic">

          <span class="md-ellipsis">

            

              Documentation

              Documenting

            

          </span>

        </div>
@@ -522,7 +522,7 @@ 
            

  

  <span class="md-ellipsis">

    Contributing

    Contribute

  </span>
@@ -532,7 +532,7 @@ 
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">

          <label class="md-nav__title" for="__nav_4">

            <span class="md-nav__icon md-icon"></span>

            Contributing

            Contribute

          </label>

          <ul class="md-nav__list" data-md-scrollfix>
@@ -556,7 +556,7 @@ 
          

  

  <span class="md-ellipsis">

    Documentation

    Documenting

  </span>
@@ -567,7 +567,7 @@ 
        

  

  <span class="md-ellipsis">

    Documentation

    Documenting

  </span>

public/develop/gettingstarted/howtorun/index.html

+25 −14
Original line number Diff line number Diff line
@@ -655,7 +655,7 @@ 
            

  

  <span class="md-ellipsis">

    Contributing

    Contribute

  </span>
@@ -665,7 +665,7 @@ 
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">

          <label class="md-nav__title" for="__nav_4">

            <span class="md-nav__icon md-icon"></span>

            Contributing

            Contribute

          </label>

          <ul class="md-nav__list" data-md-scrollfix>
@@ -680,7 +680,7 @@ 
        

  

  <span class="md-ellipsis">

    Documentation

    Documenting

  </span>
@@ -852,18 +852,25 @@ 




<h1 id="how-to-run">How to Run</h1>

<ul>

<li><a href="#downloading-the-project">Downloading the project</a></li>

<li><a href="#1-create-a-folder-to-download-the-project">1. Create a folder to download the project</a></li>

<li><a href="#2-download-the-deployment-script">2. Download the deployment script</a></li>

<li><a href="#3-run-the-deployment-script">3. Run the deployment script</a></li>

<li><a href="#run-all-capif-services-locally-with-docker-images">Run All CAPIF Services locally with Docker images</a></li>

<li><a href="#run-all-capif-services-locally-with-docker-images-and-deploy-monitoring-stack">Run All CAPIF Services locally with Docker images and deploy monitoring stack</a></li>

<li><a href="#run-each-service-using-docker">Run each service using Docker</a></li>

<li><a href="#run-each-service-using-python">Run each service using Python</a></li>

<li><a href="#start-your-testing-with-opencapif">Start Your Testing with OpenCAPIF</a></li>

<ol>

<li><a href="#downloading-the-project">Downloading the project</a> <ol>

<li><a href="#1-create-a-folder-to-download-the-project">Create a folder to download the project</a></li>

<li><a href="#2-download-the-deployment-script">Download the deployment script</a></li>

<li><a href="#3-run-the-deployment-script">Run the deployment script</a></li>

</ol>

</li>

<li>Run the services<ul>

<li><a href="#run-all-capif-services-locally-with-docker-images">Run <strong>all</strong> CAPIF Services locally with Docker images</a></li>

<li><a href="#run-all-capif-services-locally-with-docker-images-and-deploy-monitoring-stack">Run <strong>all</strong> CAPIF Services locally with Docker images <em>and deploy monitoring stack</em></a></li>

<li><a href="#run-each-service-using-docker">Run <strong>each</strong> service using Docker</a></li>

<li><a href="#run-each-service-using-python">Run <strong>each</strong> service using Python</a></li>

</ul>

</li>

<li><a href="#start-your-testing-with-opencapif">Start your testing with OpenCAPIF</a></li>

</ol>

<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>
@@ -922,7 +929,7 @@ Usage: ./run.sh &lt;options&gt; 
<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>

<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;
@@ -946,7 +953,9 @@ Usage: ./show_logs.sh &lt;options&gt; 
       -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>
@@ -955,7 +964,9 @@ Usage: ./show_logs.sh &lt;options&gt; 
<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;