Skip to content
Snippets Groups Projects
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
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
public/release0/deployment/index.html
+ 129
− 104
View file @ 9fa29643
...@@ -546,11 +546,29 @@ ...@@ -546,11 +546,29 @@
</span> </span>
</a> </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> </li>
</ul> </ul>
</nav> </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>
<li class="md-nav__item"> <li class="md-nav__item">
...@@ -1349,11 +1367,29 @@ ...@@ -1349,11 +1367,29 @@
</span> </span>
</a> </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> </li>
</ul> </ul>
</nav> </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>
<li class="md-nav__item"> <li class="md-nav__item">
...@@ -1592,8 +1628,8 @@ ...@@ -1592,8 +1628,8 @@
<p>If you made changes to keycloak's mysql credentials:</p> <p>If you made changes to keycloak's mysql credentials:</p>
<p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code>.</p> <p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code>.</p>
<p><code>DB_DATABASE: keycloak <p><code>DB_DATABASE: keycloak
DB_USER: keycloak DB_USER: keycloak
DB_PASSWORD: password</code></p> DB_PASSWORD: password</code></p>
</li> </li>
<li> <li>
<p>If you want to change the keycloak admin password:</p> <p>If you want to change the keycloak admin password:</p>
...@@ -1645,37 +1681,30 @@ ...@@ -1645,37 +1681,30 @@
&quot;spring.portal.main.domain&quot;: &quot;http://localhost&quot;, &quot;spring.portal.main.domain&quot;: &quot;http://localhost&quot;,
&quot;logging.level.org.springframework&quot; : &quot;INFO&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> </code></pre>
<p>SPRING_APPLICATION_JSON: '{ <h3 id="6-osscapi-container-tmf-api-service-conditional">6. osscapi container (TMF API service) <em>(conditional)</em></h3>
"spring.datasource.username":"root", <p>Change the respective fields: </p>
"spring.datasource.password":"letmein", <ul>
"spring-addons.issuers[0].uri": "http://keycloak:8080/auth/realms/openslice", <li>If you made changes to mysql and keycloak credentials.</li>
"spring.security.oauth2.resourceserver.jwt.issuer-uri": "http://keycloak:8080/auth/realms/openslice", <li>If you want to change logging level (TRACE / DEBUG / INFO / WARN / ERROR).</li>
"springdoc.oAuthFlow.authorizationUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth", </ul>
"springdoc.oAuthFlow.tokenUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token",<br /> <blockquote>
"logging.level.org.springframework" : "INFO" <p><strong>If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}.</strong></p>
}'</p> </blockquote>
<pre><code> <p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code></p>
## Configure nginx <pre><code>SPRING_APPLICATION_JSON: '{
&quot;spring.datasource.username&quot;:&quot;root&quot;,
In folder `org.etsi.osl.main/compose/nginx` create a configuration specific `nginx.conf` file. &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;,
```bash &quot;springdoc.oAuthFlow.authorizationUrl&quot;: &quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth&quot;,
cd org.etsi.osl.main/compose/nginx/ &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> </code></pre>
<pre><code class="language-bash">sudo cp nginx.conf.default nginx.conf <pre><code class="language-bash">sudo cp nginx.conf.default nginx.conf
</code></pre> </code></pre>
...@@ -1688,14 +1717,14 @@ cd org.etsi.osl.main/compose/nginx/ ...@@ -1688,14 +1717,14 @@ cd org.etsi.osl.main/compose/nginx/
</code></pre> </code></pre>
<p>Edit the <code>config.js</code> file with the information of your domain</p> <p>Edit the <code>config.js</code> file with the information of your domain</p>
<pre><code>{ <pre><code>{
TITLE: &quot;OpenSlice by ETSI&quot;, TITLE: &quot;OpenSlice by ETSI&quot;,
WIKI: &quot;https://openslice.readthedocs.io/en/stable/&quot;, WIKI: &quot;https://openslice.readthedocs.io/en/stable/&quot;,
BUGZILLA: &quot;ROOTURL/bugzilla/&quot;, BUGZILLA: &quot;ROOTURL/bugzilla/&quot;,
STATUS: &quot;ROOTURL/status/&quot;, STATUS: &quot;ROOTURL/status/&quot;,
APIURL: &quot;http://localost:13000&quot;, APIURL: &quot;http://localost:13000&quot;,
WEBURL: &quot;ROOTURL/nfvportal&quot;, WEBURL: &quot;ROOTURL/nfvportal&quot;,
APIOAUTHURL: &quot;ROOTURL/auth/realms/openslice&quot;, APIOAUTHURL: &quot;ROOTURL/auth/realms/openslice&quot;,
APITMFURL: &quot;ROOTURL/tmf-api/serviceCatalogManagement/v4&quot; APITMFURL: &quot;ROOTURL/tmf-api/serviceCatalogManagement/v4&quot;
} }
</code></pre> </code></pre>
<h2 id="configure-tmf-web-ui">Configure TMF Web UI</h2> <h2 id="configure-tmf-web-ui">Configure TMF Web UI</h2>
...@@ -1714,8 +1743,8 @@ cd org.etsi.osl.tmf.web/src/assets/config ...@@ -1714,8 +1743,8 @@ cd org.etsi.osl.tmf.web/src/assets/config
</code></pre> </code></pre>
<p>E.g. Edit "TITLE" or "WIKI" property with your domain title</p> <p>E.g. Edit "TITLE" or "WIKI" property with your domain title</p>
<pre><code>{ <pre><code>{
TITLE: &quot;OpenSlice by ETSI&quot;, TITLE: &quot;OpenSlice by ETSI&quot;,
WIKI: &quot;https://osl.etsi.org/documentation/latest/deployment/&quot;, WIKI: &quot;https://osl.etsi.org/documentation/latest/deployment/&quot;,
} }
</code></pre> </code></pre>
<blockquote> <blockquote>
...@@ -1815,76 +1844,72 @@ cd org.etsi.osl.main/compose/ ...@@ -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. <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. 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> 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> <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>
<li>For the Angular configuration (TMF portal UI), navigate to org.etsi.osl.tmf.web/src/assets/config and edit config.prod.json</li> <pre><code class="language-bash"># Starting from the root project directory
</ul> cd org.etsi.osl.tmf.web/src/assets/config
<p><code>bash </code></pre>
# Starting from the root project directory <pre><code class="language-bash">nano config.prod.json
cd org.etsi.osl.tmf.web/src/assets/config</code></p> </code></pre>
<p><code>bash
nano config.prod.json</code></p>
<p>After editing it should look like the example bellow:</p> <p>After editing it should look like the example bellow:</p>
<p>```yaml <pre><code class="language-yaml">{
{ <br /> &quot;TITLE&quot;: &quot;OpenSlice by ETSI&quot;,
"TITLE": "OpenSlice by ETSI", &quot;PORTALVERSION&quot;:&quot;2023-Q3 1.2.0-SNAPSHOT&quot;,
"PORTALVERSION":"2023-Q3 1.2.0-SNAPSHOT", &quot;WIKI&quot;: &quot;https://openslice.readthedocs.io/en/stable/&quot;,
"WIKI": "https://openslice.readthedocs.io/en/stable/", &quot;BUGZILLA&quot;: &quot;{BASEURL}/bugzilla/&quot;,
"BUGZILLA": "{BASEURL}/bugzilla/", &quot;STATUS&quot;: &quot;http://status.localhost/&quot;,
"STATUS": "http://status.localhost/", &quot;WEBURL&quot;: &quot;{BASEURL}&quot;,
"WEBURL": "{BASEURL}", &quot;PORTAL_REPO_APIURL&quot;: &quot;{BASEURL}/osapi&quot;,
"PORTAL_REPO_APIURL": "{BASEURL}/osapi", &quot;ASSURANCE_SERVICE_MGMT_APIURL&quot;: &quot;{BASEURL}/oas-api&quot;,
"ASSURANCE_SERVICE_MGMT_APIURL": "{BASEURL}/oas-api", &quot;APITMFURL&quot;: &quot;{BASEURL}/tmf-api&quot;,
"APITMFURL": "{BASEURL}/tmf-api", &quot;OAUTH_CONFIG&quot; : {
"OAUTH_CONFIG" : { &quot;issuer&quot;: &quot;http://keycloak:8080/auth/realms/openslice&quot;,
"issuer": "http://keycloak:8080/auth/realms/openslice", &quot;loginUrl&quot;: &quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth&quot;,
"loginUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth", &quot;tokenEndpoint&quot;: &quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token&quot;,
"tokenEndpoint": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token", &quot;userinfoEndpoint&quot;: &quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/userinfo&quot;,
"userinfoEndpoint": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/userinfo", &quot;redirectUri&quot;: &quot;{BASEURL}/redirect&quot;,
"redirectUri": "{BASEURL}/redirect", &quot;logoutUrl&quot;: &quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/logout&quot;,
"logoutUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/logout", &quot;postLogoutRedirectUri&quot;: &quot;{BASEURL}&quot;,
"postLogoutRedirectUri": "{BASEURL}",</p>
<pre><code> "responseType": "code", &quot;responseType&quot;: &quot;code&quot;,
"oidc": false, &quot;oidc&quot;: false,
"clientId": "osapiWebClientId", &quot;clientId&quot;: &quot;osapiWebClientId&quot;,
"dummyClientSecret": "secret", &quot;dummyClientSecret&quot;: &quot;secret&quot;,
"requireHttps": false, &quot;requireHttps&quot;: false,
"useHttpBasicAuth": true, &quot;useHttpBasicAuth&quot;: true,
"clearHashAfterLogin": false, clearHashAfterLogin&quot;: false,
"showDebugInformation": true &quot;showDebugInformation&quot;: true
} }
}
</code></pre> </code></pre>
<p>}
```</p>
<blockquote> <blockquote>
<p>Note the difference in changing {BASEURL} -&gt; http://keycloak:8080</p> <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> <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> </blockquote>
<ul> <p>2.2 - For the AngularJS configuration (NVF portal UI), navigate to org.etsi.osl.portal.web/src/js and edit config.js</p>
<li>For the AngularJS configuration (NVF portal UI), navigate to org.etsi.osl.portal.web/src/js and edit config.js</li> <pre><code class="language-bash"># Starting from the root project directory
</ul> cd org.etsi.osl.portal.web/src/js
<p><code>bash </code></pre>
# Starting from the root project directory <pre><code class="language-bash">nano config.js
cd org.etsi.osl.portal.web/src/js</code></p> </code></pre>
<p><code>bash
nano config.js</code></p>
<p>after editing it should look like the example bellow:</p> <p>after editing it should look like the example bellow:</p>
<p>``` <pre><code>var appConfig = angular.module('portalwebapp.config',[]);
var appConfig = angular.module('portalwebapp.config',[]);</p>
<p>appConfig.factory('APIEndPointService', function() {
return { <br /> appConfig.factory('APIEndPointService', function() {
TITLE: "OpenSlice by ETSI", return {
WIKI: "https://openslice.readthedocs.io/en/stable/", TITLE: &quot;OpenSlice by ETSI&quot;,
BUGZILLA: "ROOTURL/bugzilla/", WIKI: &quot;https://openslice.readthedocs.io/en/stable/&quot;,
STATUS: "ROOTURL/status/", BUGZILLA: &quot;ROOTURL/bugzilla/&quot;,
APIURL: "http://localost:13000", STATUS: &quot;ROOTURL/status/&quot;,
WEBURL: "ROOTURL/nfvportal", APIURL: &quot;http://localost:13000&quot;,
APIOAUTHURL: "ROOTURL/auth/realms/openslice", WEBURL: &quot;ROOTURL/nfvportal&quot;,
APITMFURL: "ROOTURL/tmf-api/serviceCatalogManagement/v4" APIOAUTHURL: &quot;ROOTURL/auth/realms/openslice&quot;,
}; APITMFURL: &quot;ROOTURL/tmf-api/serviceCatalogManagement/v4&quot;
}); };
```</p> });
</code></pre>
<blockquote> <blockquote>
<p>Note the difference in "APIOAUTHURL" property</p> <p>Note the difference in "APIOAUTHURL" property</p>
</blockquote> </blockquote>
......
public/release0/search/search_index.json
+ 1
− 1
View file @ 9fa29643
Source diff could not be displayed: it is too large. Options to address this: view the blob.
public/release0/sitemap.xml.gz
+ 0
− 0
View file @ 9fa29643
No preview for this file type
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment