Commit 9fa29643 authored by Dimitrios Giannopoulos's avatar Dimitrios Giannopoulos
Browse files

Deployed 3c7be169 to release0 in public with MkDocs 1.5.3 and mike 2.0.0

parent b9f3d594

public/release0/deployment/index.html

+129 −104
Original line number Diff line number Diff line
@@ -546,11 +546,29 @@ 
    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#6-osscapi-container-tmf-api-service-conditional" class="md-nav__link">

    <span class="md-ellipsis">

      6. osscapi container (TMF API service) (conditional)

    </span>

  </a>

  

</li>

        

      </ul>

    </nav>

  

</li>

      

        <li class="md-nav__item">

  <a href="#configure-nginx" class="md-nav__link">

    <span class="md-ellipsis">

      Configure nginx

    </span>

  </a>

  

</li>

      

        <li class="md-nav__item">
@@ -1349,11 +1367,29 @@ 
    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#6-osscapi-container-tmf-api-service-conditional" class="md-nav__link">

    <span class="md-ellipsis">

      6. osscapi container (TMF API service) (conditional)

    </span>

  </a>

  

</li>

        

      </ul>

    </nav>

  

</li>

      

        <li class="md-nav__item">

  <a href="#configure-nginx" class="md-nav__link">

    <span class="md-ellipsis">

      Configure nginx

    </span>

  </a>

  

</li>

      

        <li class="md-nav__item">
@@ -1645,37 +1681,30 @@ 
  &quot;spring.portal.main.domain&quot;: &quot;http://localhost&quot;,

  &quot;logging.level.org.springframework&quot; : &quot;INFO&quot;

}'

  ```



### 6. osscapi container (TMF API service) *(conditional)*



Change the respective fields: 



- If you made changes to mysql and keycloak credentials.

- If you want to change logging level (TRACE / DEBUG / INFO / WARN / ERROR).



&gt; **If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}.**



In folder `org.etsi.osl.main/compose/` edit the file `docker-compose.yaml`



</code></pre>

<p>SPRING_APPLICATION_JSON: '{

  "spring.datasource.username":"root",

  "spring.datasource.password":"letmein",

  "spring-addons.issuers[0].uri": "http://keycloak:8080/auth/realms/openslice",

  "spring.security.oauth2.resourceserver.jwt.issuer-uri": "http://keycloak:8080/auth/realms/openslice",

  "springdoc.oAuthFlow.authorizationUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth",

  "springdoc.oAuthFlow.tokenUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token",<br />

  "logging.level.org.springframework" : "INFO"

}'</p>

<pre><code>

## Configure nginx



In folder `org.etsi.osl.main/compose/nginx` create a configuration specific `nginx.conf` file.





```bash

cd org.etsi.osl.main/compose/nginx/

<h3 id="6-osscapi-container-tmf-api-service-conditional">6. osscapi container (TMF API service) <em>(conditional)</em></h3>

<p>Change the respective fields: </p>

<ul>

<li>If you made changes to mysql and keycloak credentials.</li>

<li>If you want to change logging level (TRACE / DEBUG / INFO / WARN / ERROR).</li>

</ul>

<blockquote>

<p><strong>If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}.</strong></p>

</blockquote>

<p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code></p>

<pre><code>SPRING_APPLICATION_JSON: '{

  &quot;spring.datasource.username&quot;:&quot;root&quot;,

  &quot;spring.datasource.password&quot;:&quot;letmein&quot;,

  &quot;spring-addons.issuers[0].uri&quot;: &quot;http://keycloak:8080/auth/realms/openslice&quot;,

  &quot;spring.security.oauth2.resourceserver.jwt.issuer-uri&quot;: &quot;http://keycloak:8080/auth/realms/openslice&quot;,

  &quot;springdoc.oAuthFlow.authorizationUrl&quot;: &quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth&quot;,

  &quot;springdoc.oAuthFlow.tokenUrl&quot;: &quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token&quot;,  

  &quot;logging.level.org.springframework&quot; : &quot;INFO&quot;

}'

</code></pre>

<h2 id="configure-nginx">Configure nginx</h2>

<p>In folder <code>org.etsi.osl.main/compose/nginx</code> create a configuration specific <code>nginx.conf</code> file.</p>

<pre><code class="language-bash">cd org.etsi.osl.main/compose/nginx/

</code></pre>

<pre><code class="language-bash">sudo cp nginx.conf.default nginx.conf

</code></pre>
@@ -1815,76 +1844,72 @@ cd org.etsi.osl.main/compose/ 
<p>Nginx uses the http://keycloak:8080 URL, which is accessible via the internal docker system's network.

The Front-end (TS/Angular) shall also use the http://keycloak:8080.

This way, you will not get the invalid token error, as the API is acquiring the token from http://keycloak:8080 (internally) and the Front-end is getting verified by an issuer at the same URL, as well.</p>

<ul>

<li>For the Angular configuration (TMF portal UI), navigate to  org.etsi.osl.tmf.web/src/assets/config and edit config.prod.json</li>

</ul>

<p><code>bash

   # Starting from the root project directory

   cd org.etsi.osl.tmf.web/src/assets/config</code></p>

<p><code>bash

   nano config.prod.json</code></p>

<p>2.1 - For the Angular configuration (TMF portal UI), navigate to  org.etsi.osl.tmf.web/src/assets/config and edit config.prod.json</p>

<pre><code class="language-bash"># Starting from the root project directory

cd org.etsi.osl.tmf.web/src/assets/config

</code></pre>

<pre><code class="language-bash">nano config.prod.json

</code></pre>

<p>After editing it should look like the example bellow:</p>

<p>```yaml

   {        <br />

      "TITLE": "OpenSlice by ETSI",

      "PORTALVERSION":"2023-Q3 1.2.0-SNAPSHOT",

      "WIKI": "https://openslice.readthedocs.io/en/stable/",

      "BUGZILLA": "{BASEURL}/bugzilla/",

      "STATUS": "http://status.localhost/",

      "WEBURL": "{BASEURL}",

      "PORTAL_REPO_APIURL": "{BASEURL}/osapi",

      "ASSURANCE_SERVICE_MGMT_APIURL": "{BASEURL}/oas-api",

      "APITMFURL": "{BASEURL}/tmf-api",

      "OAUTH_CONFIG" : {

         "issuer": "http://keycloak:8080/auth/realms/openslice",

         "loginUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth",

         "tokenEndpoint": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token",

         "userinfoEndpoint": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/userinfo",

         "redirectUri": "{BASEURL}/redirect",

         "logoutUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/logout", 

         "postLogoutRedirectUri": "{BASEURL}",</p>

<pre><code>     "responseType": "code",

     "oidc": false,

     "clientId": "osapiWebClientId",

     "dummyClientSecret": "secret",



     "requireHttps": false,

     "useHttpBasicAuth": true,

     "clearHashAfterLogin": false,



     "showDebugInformation": true

<pre><code class="language-yaml">{         

  &quot;TITLE&quot;: &quot;OpenSlice by ETSI&quot;,

  &quot;PORTALVERSION&quot;:&quot;2023-Q3 1.2.0-SNAPSHOT&quot;,

  &quot;WIKI&quot;: &quot;https://openslice.readthedocs.io/en/stable/&quot;,

  &quot;BUGZILLA&quot;: &quot;{BASEURL}/bugzilla/&quot;,

  &quot;STATUS&quot;: &quot;http://status.localhost/&quot;,

  &quot;WEBURL&quot;: &quot;{BASEURL}&quot;,

  &quot;PORTAL_REPO_APIURL&quot;: &quot;{BASEURL}/osapi&quot;,

  &quot;ASSURANCE_SERVICE_MGMT_APIURL&quot;: &quot;{BASEURL}/oas-api&quot;,

  &quot;APITMFURL&quot;: &quot;{BASEURL}/tmf-api&quot;,

  &quot;OAUTH_CONFIG&quot; : {

      &quot;issuer&quot;: &quot;http://keycloak:8080/auth/realms/openslice&quot;,

      &quot;loginUrl&quot;: &quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth&quot;,

      &quot;tokenEndpoint&quot;: &quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token&quot;,

      &quot;userinfoEndpoint&quot;: &quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/userinfo&quot;,

      &quot;redirectUri&quot;: &quot;{BASEURL}/redirect&quot;,

      &quot;logoutUrl&quot;: &quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/logout&quot;, 

      &quot;postLogoutRedirectUri&quot;: &quot;{BASEURL}&quot;,



      &quot;responseType&quot;: &quot;code&quot;,

      &quot;oidc&quot;: false,

      &quot;clientId&quot;: &quot;osapiWebClientId&quot;,

      &quot;dummyClientSecret&quot;: &quot;secret&quot;,



      &quot;requireHttps&quot;: false,

      &quot;useHttpBasicAuth&quot;: true,

        clearHashAfterLogin&quot;: false,



      &quot;showDebugInformation&quot;: true

  }

}

</code></pre>

<p>}

   ```</p>

<blockquote>

<p>Note the difference in changing {BASEURL} -&gt; http://keycloak:8080</p>

<p>If you want the changes to take place immediately without rebuilding the project, then repeat the process for org.etsi.osl.tmf.web/dist/org.etsi.osl.tmf.web/assets/config/config.prod.json</p>

</blockquote>

<ul>

<li>For the AngularJS configuration (NVF portal UI), navigate to org.etsi.osl.portal.web/src/js and edit config.js</li>

</ul>

<p><code>bash

   # Starting from the root project directory

   cd org.etsi.osl.portal.web/src/js</code></p>

<p><code>bash

   nano config.js</code></p>

<p>2.2 - For the AngularJS configuration (NVF portal UI), navigate to org.etsi.osl.portal.web/src/js and edit config.js</p>

<pre><code class="language-bash"># Starting from the root project directory

cd org.etsi.osl.portal.web/src/js

</code></pre>

<pre><code class="language-bash">nano config.js

</code></pre>

<p>after editing it should look like the example bellow:</p>

<p>```

   var appConfig = angular.module('portalwebapp.config',[]);</p>

<p>appConfig.factory('APIEndPointService', function() {

      return {      <br />

         TITLE: "OpenSlice by ETSI",

         WIKI: "https://openslice.readthedocs.io/en/stable/",

         BUGZILLA: "ROOTURL/bugzilla/",

         STATUS: "ROOTURL/status/",

         APIURL: "http://localost:13000",

         WEBURL: "ROOTURL/nfvportal",

         APIOAUTHURL: "ROOTURL/auth/realms/openslice",

         APITMFURL: "ROOTURL/tmf-api/serviceCatalogManagement/v4"

<pre><code>var appConfig = angular.module('portalwebapp.config',[]);





appConfig.factory('APIEndPointService', function() {

   return {       

      TITLE: &quot;OpenSlice by ETSI&quot;,

      WIKI: &quot;https://openslice.readthedocs.io/en/stable/&quot;,

      BUGZILLA: &quot;ROOTURL/bugzilla/&quot;,

      STATUS: &quot;ROOTURL/status/&quot;,

      APIURL: &quot;http://localost:13000&quot;,

      WEBURL: &quot;ROOTURL/nfvportal&quot;,

      APIOAUTHURL: &quot;ROOTURL/auth/realms/openslice&quot;,

      APITMFURL: &quot;ROOTURL/tmf-api/serviceCatalogManagement/v4&quot;

   };

});

   ```</p>

</code></pre>

<blockquote>

<p>Note the difference in "APIOAUTHURL" property</p>

</blockquote>

public/release0/search/search_index.json

+1 −1

File changed.

Preview size limit exceeded, changes collapsed.

public/release0/sitemap.xml.gz

(397 B)

File changed.

No diff preview for this file type.

View original file
View changed file