Commit 332a771f authored by Jorge Moratinos's avatar Jorge Moratinos
Browse files

Deployed f7ecca3d to 0.0 in public with MkDocs 1.5.3 and mike 2.0.0

parent 185f714e

public/0.0/404.html

+5 −3
Original line number Diff line number Diff line
@@ -46,6 +46,8 @@ 
      

    

    

      <link rel="stylesheet" href="/0.0/stylesheets/extra.css">

    

    <script>__md_scope=new URL("/0.0",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -61,7 +63,7 @@ 
    

    

    

    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="cyan" data-md-color-accent="blue">

    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom">

  

    

    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
@@ -87,7 +89,7 @@ 
  <nav class="md-header__inner md-grid" aria-label="Header">

    <a href="/0.0/." title="ETSI SDG OCF Documentation" class="md-header__button md-logo" aria-label="ETSI SDG OCF Documentation" data-md-component="logo">

      

  <img src="/0.0/images/logos/OpenCAPIF.png" alt="logo">

  <img src="/0.0/images/logos/Open CAPIF Logo Screen_B_W Slogan NEG.png" alt="logo">



    </a>

    <label class="md-header__button md-icon" for="__drawer">
@@ -193,7 +195,7 @@ 
  <label class="md-nav__title" for="__drawer">

    <a href="/0.0/." title="ETSI SDG OCF Documentation" class="md-nav__button md-logo" aria-label="ETSI SDG OCF Documentation" data-md-component="logo">

      

  <img src="/0.0/images/logos/OpenCAPIF.png" alt="logo">

  <img src="/0.0/images/logos/Open CAPIF Logo Screen_B_W Slogan NEG.png" alt="logo">



    </a>

    ETSI SDG OCF Documentation

public/0.0/FAQ/index.html

+5 −3
Original line number Diff line number Diff line
@@ -50,6 +50,8 @@ 
      

    

    

      <link rel="stylesheet" href="../stylesheets/extra.css">

    

    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -65,7 +67,7 @@ 
    

    

    

    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="cyan" data-md-color-accent="blue">

    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom">

  

    

    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
@@ -96,7 +98,7 @@ 
  <nav class="md-header__inner md-grid" aria-label="Header">

    <a href=".." title="ETSI SDG OCF Documentation" class="md-header__button md-logo" aria-label="ETSI SDG OCF Documentation" data-md-component="logo">

      

  <img src="../images/logos/OpenCAPIF.png" alt="logo">

  <img src="../images/logos/Open CAPIF Logo Screen_B_W Slogan NEG.png" alt="logo">



    </a>

    <label class="md-header__button md-icon" for="__drawer">
@@ -202,7 +204,7 @@ 
  <label class="md-nav__title" for="__drawer">

    <a href=".." title="ETSI SDG OCF Documentation" class="md-nav__button md-logo" aria-label="ETSI SDG OCF Documentation" data-md-component="logo">

      

  <img src="../images/logos/OpenCAPIF.png" alt="logo">

  <img src="../images/logos/Open CAPIF Logo Screen_B_W Slogan NEG.png" alt="logo">



    </a>

    ETSI SDG OCF Documentation

public/0.0/gettingstarted/howtorun/index.html

+14 −12
Original line number Diff line number Diff line
@@ -52,6 +52,8 @@ 
      

    

    

      <link rel="stylesheet" href="../../stylesheets/extra.css">

    

    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -67,7 +69,7 @@ 
    

    

    

    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="cyan" data-md-color-accent="blue">

    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom">

  

    

    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
@@ -98,7 +100,7 @@ 
  <nav class="md-header__inner md-grid" aria-label="Header">

    <a href="../.." title="ETSI SDG OCF Documentation" class="md-header__button md-logo" aria-label="ETSI SDG OCF Documentation" data-md-component="logo">

      

  <img src="../../images/logos/OpenCAPIF.png" alt="logo">

  <img src="../../images/logos/Open CAPIF Logo Screen_B_W Slogan NEG.png" alt="logo">



    </a>

    <label class="md-header__button md-icon" for="__drawer">
@@ -204,7 +206,7 @@ 
  <label class="md-nav__title" for="__drawer">

    <a href="../.." title="ETSI SDG OCF Documentation" class="md-nav__button md-logo" aria-label="ETSI SDG OCF Documentation" data-md-component="logo">

      

  <img src="../../images/logos/OpenCAPIF.png" alt="logo">

  <img src="../../images/logos/Open CAPIF Logo Screen_B_W Slogan NEG.png" alt="logo">



    </a>

    ETSI SDG OCF Documentation
@@ -634,8 +636,8 @@ 
</ul>

<p>Capif services are developed under <a href="https://labs.etsi.org/rep/ocf/capif/-/tree/main/services">services folder</a>.</p>

<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 that tools installed at your machine. Also to simplify the process, we have 3 script to control docker images to deploy, check and cleanup.</p>

<p>All script are present under <strong><em>services</em></strong> directory.</p>

<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
@@ -644,7 +646,7 @@ Usage: ./run.sh &lt;options&gt; 
       -m : Clean monitoring service

       -h : show this help

</code></pre>

<p>This script build and run all services using docker images, including mongodb and nginx locally and in background, and import ca.crt to nginx. By default monitoring is not activated and Nginx deployed use <strong>capifcore</strong> as a hostname. </p>

<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
@@ -656,14 +658,14 @@ Usage: ./run.sh &lt;options&gt; 
./run.sh -c opencapif.etsi.org -m true 



</code></pre>

<p>If you want to check if all CAPIF services are running properly in local machine after execute run.sh, we can use:</p>

<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 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;
@@ -677,7 +679,7 @@ Usage: clean_capif_docker_services.sh &lt;options&gt; 
<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 before run script.

You must specify an option when running the script.

Usage: ./show_logs.sh &lt;options&gt;

       -c : Show capif services

       -v : Show vault service
@@ -687,7 +689,7 @@ Usage: ./show_logs.sh &lt;options&gt; 
       -f : Follow log output

       -h : Show this help

</code></pre>

<p>You can also use option -f in order to live follow log output</p>

<p>You can also use option -f in order to follow log output in real time</p>

<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>
@@ -696,9 +698,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>

<p>By default, the monitoring option is set to false. Once up, all data sources and dashboards are automatically provisioned</p>

<p>By default, the monitoring option is set to false. Once up, all data sources and dashboards are automatically provisioned.</p>

<h3 id="run-each-service-using-docker">Run each service using Docker</h3>

<p>Also you can run service by service using docker:</p>

<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

public/0.0/gettingstarted/repository/index.html

+5 −3
Original line number Diff line number Diff line
@@ -48,6 +48,8 @@ 
      

    

    

      <link rel="stylesheet" href="../../stylesheets/extra.css">

    

    <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -63,7 +65,7 @@ 
    

    

    

    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="cyan" data-md-color-accent="blue">

    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom">

  

    

    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
@@ -89,7 +91,7 @@ 
  <nav class="md-header__inner md-grid" aria-label="Header">

    <a href="../.." title="ETSI SDG OCF Documentation" class="md-header__button md-logo" aria-label="ETSI SDG OCF Documentation" data-md-component="logo">

      

  <img src="../../images/logos/OpenCAPIF.png" alt="logo">

  <img src="../../images/logos/Open CAPIF Logo Screen_B_W Slogan NEG.png" alt="logo">



    </a>

    <label class="md-header__button md-icon" for="__drawer">
@@ -195,7 +197,7 @@ 
  <label class="md-nav__title" for="__drawer">

    <a href="../.." title="ETSI SDG OCF Documentation" class="md-nav__button md-logo" aria-label="ETSI SDG OCF Documentation" data-md-component="logo">

      

  <img src="../../images/logos/OpenCAPIF.png" alt="logo">

  <img src="../../images/logos/Open CAPIF Logo Screen_B_W Slogan NEG.png" alt="logo">



    </a>

    ETSI SDG OCF Documentation

public/0.0/images/logos/Open CAPIF Logo Screen_B_W Slogan NEG.png

0 → 100644
+22.3 KiB
Loading image diff...