Skip to content
Normal view Permalink
index.html 120 KiB
Newer Older
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 
</nav>
                  </div>
                </div>
              </div>
            
          
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3014 
<h1 id="openslice-deployment-guide-with-docker-compose">OpenSlice Deployment Guide with Docker Compose</h1>
Kostis Trantzas's avatar
Deployed c4708cd to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3015 
<p><strong>Intended Audience: OpenSlice Administrators</strong></p>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 
<h2 id="requirements">Requirements</h2>
<h3 id="hardware-requirements">Hardware requirements:</h3>
<table>
<thead>
<tr>
<th><strong>Minimum Hardware Requirements</strong></th>
<th><strong>Recomended Hardware Requirements</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>4 CPU cores</td>
<td>8 CPU cores</td>
</tr>
<tr>
<td>8 GB RAM</td>
<td>16 GB RAM</td>
</tr>
<tr>
<td>30 GB storage</td>
<td>50 GB storage</td>
</tr>
</tbody>
</table>
<h3 id="software-requirements">Software Requirements:</h3>
<ul>
<li><strong>Docker:</strong> A running environment for Docker Compose services</li>
</ul>
<h2 id="preparing-the-environment">Preparing the environment</h2>
<h3 id="1-backup-your-previous-database-if-necessary">1. Backup your previous database if necessary:</h3>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3046 3047 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>sudo<span class="w"> </span>docker<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>amysql<span class="w"> </span>/usr/bin/mysqldump<span class="w"> </span>-u<span class="w"> </span>root<span class="w"> </span>--password<span class="o">=</span>letmein<span class="w"> </span>ostmfdb<span class="w"> </span>&gt;<span class="w"> </span>backup_ostmfdb.sql
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3048 3049 3050 3051 3052 
<h3 id="2-install-docker">2. Install docker</h3>
<blockquote>
<p>Since July 2023 Docker Compose V1 stopped receiving updates. OpenSlice fully reverted to Compose V2, which is integrated in the Docker installation.</p>
</blockquote>
<h3 id="3-configure-containers-to-properly-resolve-the-dns-of-your-domain-optional">3. Configure containers to properly resolve the DNS of your domain (optional)</h3>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3053 3054 
<div class="language-text highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>sudo nano /etc/docker/daemon.json
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3055 
<p>and add:</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3056 3057 3058 3059 
<div class="language-json highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="p">{</span><span class="w"> </span>
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w">  </span><span class="nt">&quot;dns&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;8.8.8.8&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;8.8.4.4&quot;</span><span class="p">]</span>
</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="p">}</span>
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3060 
<p>After editing daemon.json restart docker daemon for the changes to take place</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3061 3062 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>sudo<span class="w"> </span>systemctl<span class="w"> </span>restart<span class="w"> </span>docker
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3063 3064 
<h2 id="downloading-the-project">Downloading the project</h2>
<h3 id="1-create-a-new-folder-to-download-the-project">1. Create a new folder to download the project</h3>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3065 3066 3067 3068 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>mkdir<span class="w"> </span>openslice
</span></code></pre></div>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="nb">cd</span><span class="w"> </span>openslice
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3069 3070 
<h3 id="2-download-the-deployment-script">2. Download the deployment script</h3>
<p>Download the deployment / environment preparation script</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3071 3072 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>wget<span class="w"> </span>https://labs.etsi.org/rep/osl/code/org.etsi.osl.main/-/raw/develop/compose/deploy.sh
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3073 
<p>Make it executable</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3074 3075 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>sudo<span class="w"> </span>chmod<span class="w"> </span>+x<span class="w"> </span>deploy.sh
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3076 3077 3078 3079 3080 3081 3082 3083 3084 
<h3 id="3-run-the-deployment-script">3. Run the deployment script</h3>
<p>OpenSlice is a multi repo project. This script selects the same branch for all repositories of the project to pull from.</p>
<p>After that it builds the respective jar files locally and installs all the npm packages needed for the UI.</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>main branch for the most stable experience and</li>
<li>develop branch for an experience with the latest features (for develop branch installation, it is strongly advisable that you may as well follow the <a href="https://osl.etsi.org/documentation/develop/deployment/">develop documentation</a>)</li>
</ul>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3085 3086 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>sudo<span class="w"> </span>./deploy.sh<span class="w"> </span>develop<span class="w"> </span><span class="c1">#[or replace main with other branch name]</span>
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3087 3088 3089 3090 3091 
<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>
<h2 id="configure-docker-compose-services">Configure Docker Compose services</h2>
<h3 id="1-create-configuration-specific-docker-compose-file-from-the-template">1. Create configuration specific Docker Compose file from the template</h3>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3092 3093 3094 3095 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="nb">cd</span><span class="w"> </span>org.etsi.osl.main/compose/
</span></code></pre></div>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>sudo<span class="w"> </span>cp<span class="w"> </span>docker-compose.yaml.configure<span class="w"> </span>docker-compose.yaml
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 
<h3 id="2-configure-mysql-portal-container-optional">2. Configure mysql-portal container <em>(optional)</em></h3>
<ol>
<li>In folder <code>org.etsi.osl.main/compose/mysql-init</code> edit the file <code>01-databases.sql</code>.</li>
<li>In the <code>org.etsi.osl.main/compose/docker-compose.yaml</code> edit the credentials of the users that services use to connect to the databases, if you wish.<ul>
<li>portaluser (default is 12345) and</li>
<li>keycloak (default is password)</li>
</ul>
</li>
</ol>
<h3 id="3-configure-keycloak-container-optional">3. Configure keycloak container <em>(optional)</em></h3>
<ol>
<li>
<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>
</li>
</ol>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3112 3113 3114 3115 
<div class="language-text highlight"><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>DB_DATABASE: keycloak
</span><span id="__span-11-2"><a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a>DB_USER: keycloak
</span><span id="__span-11-3"><a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a>DB_PASSWORD: password
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3116 3117 3118 3119 3120 3121 
<ol>
<li>
<p>If you want to change the keycloak admin password:</p>
<p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code></p>
</li>
</ol>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3122 3123 
<div class="language-text highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>KEYCLOAK_PASSWORD: Pa55w0rd
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3124 3125 3126 
<h3 id="4-configure-bugzilla-container-optional">4. Configure bugzilla container <em>(optional)</em></h3>
<p>If you want to utilise the Bugzilla connector:</p>
<p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code></p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3127 3128 3129 3130 3131 3132 3133 3134 3135 
<div class="language-json highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="err">SPRING_APPLICATION_JSON</span><span class="p">:</span><span class="w"> </span><span class="err">&#39;</span><span class="p">{</span>
</span><span id="__span-13-2"><a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="w">  </span><span class="nt">&quot;spring.activemq.brokerUrl&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;tcp://anartemis:61616?jms.watchTopicAdvisories=false&quot;</span><span class="p">,</span>
</span><span id="__span-13-3"><a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a><span class="w">  </span><span class="nt">&quot;spring.activemq.user&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;artemis&quot;</span><span class="p">,</span>
</span><span id="__span-13-4"><a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a><span class="w">  </span><span class="nt">&quot;spring.activemq.password&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;artemis&quot;</span><span class="p">,</span>
</span><span id="__span-13-5"><a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a><span class="w">  </span><span class="nt">&quot;bugzillaurl&quot;</span><span class="p">:</span><span class="s2">&quot;&quot;</span><span class="p">,</span>
</span><span id="__span-13-6"><a id="__codelineno-13-6" name="__codelineno-13-6" href="#__codelineno-13-6"></a><span class="w">  </span><span class="nt">&quot;bugzillakey&quot;</span><span class="p">:</span><span class="s2">&quot;&quot;</span><span class="p">,</span>
</span><span id="__span-13-7"><a id="__codelineno-13-7" name="__codelineno-13-7" href="#__codelineno-13-7"></a><span class="w">  </span><span class="nt">&quot;main_operations_product&quot;</span><span class="p">:</span><span class="s2">&quot;&quot;</span>
</span><span id="__span-13-8"><a id="__codelineno-13-8" name="__codelineno-13-8" href="#__codelineno-13-8"></a><span class="p">}</span><span class="err">&#39;</span>
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3136 
<p>And add the provided Bugzilla installation information:</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3137 3138 3139 3140 
<div class="language-text highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>&quot;bugzillaurl&quot;:&quot;bugzillaurl.xx:443/bugzilla/&quot;,
</span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a>&quot;bugzillakey&quot;:&quot;exampleKeyeqNNwxBlgxZgMEIne0Oeq0Bz&quot;,
</span><span id="__span-14-3"><a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a>&quot;main_operations_product&quot;:&quot;Main Site Operations&quot; // this is the default product to issue tickets
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3141 3142 3143 3144 3145 3146 
<p>Bugzilla should have the following components under the specified product:  </p>
<ul>
<li>NSD Deployment Request: Component used to schedule deployment req  </li>
<li>Onboarding: Issues related to VNF/NSD Onboarding  </li>
<li>Operations Support: Default component for operations support  </li>
<li>Validation: Use to track validation processes of VNFs and NSDs  </li>
Dimitrios Giannopoulos's avatar
Deployed a160322 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Dimitrios Giannopoulos committed
3147 
<li>VPN Credentials/Access: Used for requesting VPN Credentials/Access</li>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3148 3149 
</ul>
<p>Also in the 'Main Site Operations' product, a version named 'unspecified' must be created.</p>
Dimitrios Giannopoulos's avatar
Deployed b4e6126 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3150 3151 3152 3153 3154 3155 3156 
<h3 id="5-configure-cridge-container-optional">5. Configure CRIDGE container <em>(optional)</em></h3>
<p>If you want to create and manage Kubernetes Custom Resources (CRs), you will have to provide:</p>
<ul>
<li>a cluster-wide scope kubeconf file (typically located at <code>/home/{user}/.kube</code> directory of the Kubernetes Cluster's host)</li>
</ul>
<p>You will have to copy the kubeconf file to the <code>org.etsi.osl.main/compose/kubedir</code> directory, <em>prior to the deployment</em>.</p>
<p>By default, the deployment process copies the contents of <code>org.etsi.osl.main/compose/kubedir</code> directory into the <code>/root/.kube</code> directory of the CRIDGE container.</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3157 3158 3159 
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-15-1"><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="nt">volumes</span><span class="p">:</span>
</span><span id="__span-15-2"><a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./kubedir/:/root/.kube</span>
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed b4e6126 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3160 3161 3162 3163 
<blockquote>
<p><strong>The above configuration works for the default kubeconf file names. It explicitly expects a file named <code>config</code> within the <code>/root/.kube</code> directory of the created container.</strong></p>
</blockquote>
<p>Optionally, if you want to use custom kubeconf file names, you will have to sync volumes by files and not entire directories, e.g.</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3164 3165 3166 
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-16-1"><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="nt">volumes</span><span class="p">:</span>
</span><span id="__span-16-2"><a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./kubedir/custom-config-name:/root/.kube/config</span>
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed b4e6126 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3167 3168 
<p>OpenSlice also offers management support of <em>multiple Kubernetes Clusters</em> simultaneously. For this, you will have to:</p>
<ul>
Dimitrios Giannopoulos's avatar
Deployed a160322 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Dimitrios Giannopoulos committed
3169 
<li>add all the respective kubeconf files into the <code>org.etsi.osl.main/compose/kubedir</code> directory.</li>
Dimitrios Giannopoulos's avatar
Deployed b4e6126 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3170 3171 3172 
<li>create a copy of CRIDGE service in the deployment file and map the appropriate volumes. <em>Mind the need for a different service and container name</em>.</li>
</ul>
<p>Below you may find an indicative example that only references the affected fields of the docker-compose file:</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-17-1"><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="nt">cridge-cluster1</span><span class="p">:</span>
</span><span id="__span-17-2"><a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a><span class="w">  </span><span class="nt">container_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">openslice-cluster1</span>
</span><span id="__span-17-3"><a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a><span class="w">  </span><span class="l l-Scalar l-Scalar-Plain">...</span>
</span><span id="__span-17-4"><a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a><span class="w">  </span><span class="nt">volumes</span><span class="p">:</span>
</span><span id="__span-17-5"><a id="__codelineno-17-5" name="__codelineno-17-5" href="#__codelineno-17-5"></a><span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./kubedir/config-cluster1:/root/.kube/config</span>
</span><span id="__span-17-6"><a id="__codelineno-17-6" name="__codelineno-17-6" href="#__codelineno-17-6"></a>
</span><span id="__span-17-7"><a id="__codelineno-17-7" name="__codelineno-17-7" href="#__codelineno-17-7"></a><span class="nt">cridge-cluster2</span><span class="p">:</span>
</span><span id="__span-17-8"><a id="__codelineno-17-8" name="__codelineno-17-8" href="#__codelineno-17-8"></a><span class="w">  </span><span class="nt">container_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">openslice-cluster2</span>
</span><span id="__span-17-9"><a id="__codelineno-17-9" name="__codelineno-17-9" href="#__codelineno-17-9"></a><span class="w">  </span><span class="l l-Scalar l-Scalar-Plain">...</span>
</span><span id="__span-17-10"><a id="__codelineno-17-10" name="__codelineno-17-10" href="#__codelineno-17-10"></a><span class="w">  </span><span class="nt">volumes</span><span class="p">:</span>
</span><span id="__span-17-11"><a id="__codelineno-17-11" name="__codelineno-17-11" href="#__codelineno-17-11"></a><span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./kubedir/config-cluster2:/root/.kube/config</span>
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed b4e6126 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3185 3186 3187 3188 
<blockquote>
<p>Note the same <code>/root/.kube/config</code> container's path for the proper functionality. See the above note for explanation.</p>
</blockquote>
<h3 id="6-configure-osportalapi-container-nfv-services-conditional">6. Configure osportalapi container (NFV services) <em>(conditional)</em></h3>
Dimitrios Giannopoulos's avatar
Deployed a160322 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Dimitrios Giannopoulos committed
3189 
<p>Change the respective fields:</p>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3190 3191 3192 3193 3194 3195 3196 3197 
<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><em>If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}, as well as "spring.portal.main.domain" property.</em></strong></p>
</blockquote>
<p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code></p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 
<div class="language-json highlight"><pre><span></span><code><span id="__span-18-1"><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="err">SPRING_APPLICATION_JSON</span><span class="p">:</span><span class="w"> </span><span class="err">&#39;</span><span class="p">{</span>
</span><span id="__span-18-2"><a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a><span class="w">  </span><span class="nt">&quot;spring.datasource.username&quot;</span><span class="p">:</span><span class="s2">&quot;root&quot;</span><span class="p">,</span>
</span><span id="__span-18-3"><a id="__codelineno-18-3" name="__codelineno-18-3" href="#__codelineno-18-3"></a><span class="w">  </span><span class="nt">&quot;spring.datasource.password&quot;</span><span class="p">:</span><span class="s2">&quot;letmein&quot;</span><span class="p">,</span>
</span><span id="__span-18-4"><a id="__codelineno-18-4" name="__codelineno-18-4" href="#__codelineno-18-4"></a><span class="w">  </span><span class="nt">&quot;spring-addons.issuers[0].uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice&quot;</span><span class="p">,</span>
</span><span id="__span-18-5"><a id="__codelineno-18-5" name="__codelineno-18-5" href="#__codelineno-18-5"></a><span class="w">  </span><span class="nt">&quot;spring.security.oauth2.resourceserver.jwt.issuer-uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice&quot;</span><span class="p">,</span>
</span><span id="__span-18-6"><a id="__codelineno-18-6" name="__codelineno-18-6" href="#__codelineno-18-6"></a><span class="w">  </span><span class="nt">&quot;springdoc.oAuthFlow.authorizationUrl&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth&quot;</span><span class="p">,</span>
</span><span id="__span-18-7"><a id="__codelineno-18-7" name="__codelineno-18-7" href="#__codelineno-18-7"></a><span class="w">  </span><span class="nt">&quot;springdoc.oAuthFlow.tokenUrl&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token&quot;</span><span class="p">,</span><span class="w">  </span>
</span><span id="__span-18-8"><a id="__codelineno-18-8" name="__codelineno-18-8" href="#__codelineno-18-8"></a><span class="w">  </span><span class="nt">&quot;spring.portal.main.domain&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://localhost&quot;</span><span class="p">,</span>
</span><span id="__span-18-9"><a id="__codelineno-18-9" name="__codelineno-18-9" href="#__codelineno-18-9"></a><span class="w">  </span><span class="nt">&quot;logging.level.org.springframework&quot;</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;INFO&quot;</span>
</span><span id="__span-18-10"><a id="__codelineno-18-10" name="__codelineno-18-10" href="#__codelineno-18-10"></a><span class="p">}</span><span class="err">&#39;</span>
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed b4e6126 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3209 
<h3 id="7-configure-osscapi-container-tmf-api-service-conditional">7. Configure osscapi container (TMF API service) <em>(conditional)</em></h3>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3210 3211 3212 3213 3214 3215 
<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>
Dimitrios Giannopoulos's avatar
Deployed b4e6126 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3216 
<p><strong><em>If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}.</em></strong></p>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3217 3218 
</blockquote>
<p>In folder <code>org.etsi.osl.main/compose/</code> edit the file <code>docker-compose.yaml</code></p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 
<div class="language-json highlight"><pre><span></span><code><span id="__span-19-1"><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="err">SPRING_APPLICATION_JSON</span><span class="p">:</span><span class="w"> </span><span class="err">&#39;</span><span class="p">{</span>
</span><span id="__span-19-2"><a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a><span class="w">  </span><span class="nt">&quot;spring.datasource.username&quot;</span><span class="p">:</span><span class="s2">&quot;root&quot;</span><span class="p">,</span>
</span><span id="__span-19-3"><a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a><span class="w">  </span><span class="nt">&quot;spring.datasource.password&quot;</span><span class="p">:</span><span class="s2">&quot;letmein&quot;</span><span class="p">,</span>
</span><span id="__span-19-4"><a id="__codelineno-19-4" name="__codelineno-19-4" href="#__codelineno-19-4"></a><span class="w">  </span><span class="nt">&quot;spring-addons.issuers[0].uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice&quot;</span><span class="p">,</span>
</span><span id="__span-19-5"><a id="__codelineno-19-5" name="__codelineno-19-5" href="#__codelineno-19-5"></a><span class="w">  </span><span class="nt">&quot;spring.security.oauth2.resourceserver.jwt.issuer-uri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice&quot;</span><span class="p">,</span>
</span><span id="__span-19-6"><a id="__codelineno-19-6" name="__codelineno-19-6" href="#__codelineno-19-6"></a><span class="w">  </span><span class="nt">&quot;springdoc.oAuthFlow.authorizationUrl&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth&quot;</span><span class="p">,</span>
</span><span id="__span-19-7"><a id="__codelineno-19-7" name="__codelineno-19-7" href="#__codelineno-19-7"></a><span class="w">  </span><span class="nt">&quot;springdoc.oAuthFlow.tokenUrl&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token&quot;</span><span class="p">,</span><span class="w">  </span>
</span><span id="__span-19-8"><a id="__codelineno-19-8" name="__codelineno-19-8" href="#__codelineno-19-8"></a><span class="w">  </span><span class="nt">&quot;logging.level.org.springframework&quot;</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;INFO&quot;</span>
</span><span id="__span-19-9"><a id="__codelineno-19-9" name="__codelineno-19-9" href="#__codelineno-19-9"></a><span class="p">}</span><span class="err">&#39;</span>
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3229 3230 
<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>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3231 3232 3233 3234 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-20-1"><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="nb">cd</span><span class="w"> </span>org.etsi.osl.main/compose/nginx/
</span></code></pre></div>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-21-1"><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a>sudo<span class="w"> </span>cp<span class="w"> </span>nginx.conf.default<span class="w"> </span>nginx.conf
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3235 3236 3237 
<p>If needed, in the nginx.conf file, edit the server_name for an non-local deployment.</p>
<h2 id="configure-web-ui">Configure Web UI</h2>
<p>In folder <code>org.etsi.osl.portal.web/src/js/</code> create a configuration specific <code>config.js</code> file.</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3238 3239 3240 3241 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-22-1"><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a><span class="nb">cd</span><span class="w"> </span>org.etsi.osl.portal.web/src/js
</span></code></pre></div>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-23-1"><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a>sudo<span class="w"> </span>cp<span class="w"> </span>config.js.default<span class="w"> </span>config.js
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed a160322 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Dimitrios Giannopoulos committed
3242 
<p>Edit the <code>config.js</code> file with the information of your domain. <code>ROOTURL</code> will automatically extract the the Origin (Protocol://Domain:Port) of the deployment, but you must change <code>APIURL</code> property, if you are not aiming for a localhost installation, e.g. "https://portal.openslice.eu".</p>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3243 
<p>Example file:</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3244 3245 3246 3247 3248 3249 3250 3251 3252 
<div class="language-json highlight"><pre><span></span><code><span id="__span-24-1"><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a><span class="p">{</span><span class="w">     </span>
</span><span id="__span-24-2"><a id="__codelineno-24-2" name="__codelineno-24-2" href="#__codelineno-24-2"></a><span class="w">  </span><span class="nt">&quot;BUGZILLA&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ROOTURL/bugzilla/&quot;</span><span class="p">,</span>
</span><span id="__span-24-3"><a id="__codelineno-24-3" name="__codelineno-24-3" href="#__codelineno-24-3"></a><span class="w">  </span><span class="nt">&quot;STATUS&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ROOTURL/status/&quot;</span><span class="p">,</span>
</span><span id="__span-24-4"><a id="__codelineno-24-4" name="__codelineno-24-4" href="#__codelineno-24-4"></a><span class="w">  </span><span class="nt">&quot;APIURL&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://localhost&quot;</span><span class="p">,</span>
</span><span id="__span-24-5"><a id="__codelineno-24-5" name="__codelineno-24-5" href="#__codelineno-24-5"></a><span class="w">  </span><span class="nt">&quot;WEBURL&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ROOTURL/nfvportal&quot;</span><span class="p">,</span>
</span><span id="__span-24-6"><a id="__codelineno-24-6" name="__codelineno-24-6" href="#__codelineno-24-6"></a><span class="w">  </span><span class="nt">&quot;APIOAUTHURL&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ROOTURL/auth/realms/openslice&quot;</span><span class="p">,</span>
</span><span id="__span-24-7"><a id="__codelineno-24-7" name="__codelineno-24-7" href="#__codelineno-24-7"></a><span class="w">  </span><span class="nt">&quot;APITMFURL&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ROOTURL/tmf-api/serviceCatalogManagement/v4&quot;</span>
</span><span id="__span-24-8"><a id="__codelineno-24-8" name="__codelineno-24-8" href="#__codelineno-24-8"></a><span class="p">}</span>
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3253 3254 3255 3256 3257 3258 3259 3260 3261 
<h2 id="configure-tmf-web-ui">Configure TMF Web UI</h2>
<p>In the folder <code>org.etsi.osl.tmf.web/src/assets/config</code> there are 3 files available for configuration:</p>
<ul>
<li>config.prod.json (Basic information + API configuration)</li>
<li>theming.scss (CSS color palette theming)</li>
<li>config.theming.json (HTML configuration - Logo, Favicon, Footer)</li>
</ul>
<p>The first 2 files above (i.e. config.prod.json, theming.scss) are essential for the successful deployment of OpenSlice, thus created automatically during the initial deployment at <code>org.etsi.osl.tmf.web/src/assets/config</code> directory as a copy of the default ones from the remote repository.</p>
<p>Ensure that you check the <code>config.prod.json</code> and <code>theming.scss</code> files and readjust to your deployment if needed.</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3262 3263 3264 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-25-1"><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a><span class="c1"># Starting from the root project directory</span>
</span><span id="__span-25-2"><a id="__codelineno-25-2" name="__codelineno-25-2" href="#__codelineno-25-2"></a><span class="nb">cd</span><span class="w"> </span>org.etsi.osl.tmf.web/src/assets/config
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3265 3266 
<p>E.g. You may edit "TITLE", "WIKI", etc properties with your domain title. Also configure TMF's API and Keycloak's location for the web application, if needed.</p>
<p>Example file:</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 
<div class="language-json highlight"><pre><span></span><code><span id="__span-26-1"><a id="__codelineno-26-1" name="__codelineno-26-1" href="#__codelineno-26-1"></a><span class="p">{</span><span class="w">         </span>
</span><span id="__span-26-2"><a id="__codelineno-26-2" name="__codelineno-26-2" href="#__codelineno-26-2"></a><span class="w">    </span><span class="nt">&quot;TITLE&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;OpenSlice by ETSI&quot;</span><span class="p">,</span>
</span><span id="__span-26-3"><a id="__codelineno-26-3" name="__codelineno-26-3" href="#__codelineno-26-3"></a><span class="w">    </span><span class="nt">&quot;PORTALVERSION&quot;</span><span class="p">:</span><span class="s2">&quot;2024Q2&quot;</span><span class="p">,</span>
</span><span id="__span-26-4"><a id="__codelineno-26-4" name="__codelineno-26-4" href="#__codelineno-26-4"></a><span class="w">    </span><span class="nt">&quot;WIKI&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;https://osl.etsi.org/documentation&quot;</span><span class="p">,</span>
</span><span id="__span-26-5"><a id="__codelineno-26-5" name="__codelineno-26-5" href="#__codelineno-26-5"></a><span class="w">    </span><span class="nt">&quot;BUGZILLA&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}/bugzilla/&quot;</span><span class="p">,</span>
</span><span id="__span-26-6"><a id="__codelineno-26-6" name="__codelineno-26-6" href="#__codelineno-26-6"></a><span class="w">    </span><span class="nt">&quot;STATUS&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}/status/&quot;</span><span class="p">,</span>
</span><span id="__span-26-7"><a id="__codelineno-26-7" name="__codelineno-26-7" href="#__codelineno-26-7"></a><span class="w">    </span><span class="nt">&quot;WEBURL&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}&quot;</span><span class="p">,</span>
</span><span id="__span-26-8"><a id="__codelineno-26-8" name="__codelineno-26-8" href="#__codelineno-26-8"></a><span class="w">    </span><span class="nt">&quot;PORTAL_REPO_APIURL&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}/osapi&quot;</span><span class="p">,</span>
</span><span id="__span-26-9"><a id="__codelineno-26-9" name="__codelineno-26-9" href="#__codelineno-26-9"></a><span class="w">    </span><span class="nt">&quot;ASSURANCE_SERVICE_MGMT_APIURL&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}/oas-api&quot;</span><span class="p">,</span>
</span><span id="__span-26-10"><a id="__codelineno-26-10" name="__codelineno-26-10" href="#__codelineno-26-10"></a><span class="w">    </span><span class="nt">&quot;APITMFURL&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}/tmf-api&quot;</span><span class="p">,</span>
</span><span id="__span-26-11"><a id="__codelineno-26-11" name="__codelineno-26-11" href="#__codelineno-26-11"></a><span class="w">    </span><span class="nt">&quot;OAUTH_CONFIG&quot;</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
</span><span id="__span-26-12"><a id="__codelineno-26-12" name="__codelineno-26-12" href="#__codelineno-26-12"></a><span class="w">        </span><span class="nt">&quot;issuer&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}/auth/realms/openslice&quot;</span><span class="p">,</span>
</span><span id="__span-26-13"><a id="__codelineno-26-13" name="__codelineno-26-13" href="#__codelineno-26-13"></a><span class="w">        </span><span class="nt">&quot;loginUrl&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}/auth/realms/openslice/protocol/openid-connect/auth&quot;</span><span class="p">,</span>
</span><span id="__span-26-14"><a id="__codelineno-26-14" name="__codelineno-26-14" href="#__codelineno-26-14"></a><span class="w">        </span><span class="nt">&quot;tokenEndpoint&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}/auth/realms/openslice/protocol/openid-connect/token&quot;</span><span class="p">,</span>
</span><span id="__span-26-15"><a id="__codelineno-26-15" name="__codelineno-26-15" href="#__codelineno-26-15"></a><span class="w">        </span><span class="nt">&quot;userinfoEndpoint&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}/auth/realms/openslice/protocol/openid-connect/userinfo&quot;</span><span class="p">,</span>
</span><span id="__span-26-16"><a id="__codelineno-26-16" name="__codelineno-26-16" href="#__codelineno-26-16"></a><span class="w">        </span><span class="nt">&quot;redirectUri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}/redirect&quot;</span><span class="p">,</span>
</span><span id="__span-26-17"><a id="__codelineno-26-17" name="__codelineno-26-17" href="#__codelineno-26-17"></a><span class="w">        </span><span class="nt">&quot;logoutUrl&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}/auth/realms/openslice/protocol/openid-connect/logout&quot;</span><span class="p">,</span><span class="w"> </span>
</span><span id="__span-26-18"><a id="__codelineno-26-18" name="__codelineno-26-18" href="#__codelineno-26-18"></a><span class="w">        </span><span class="nt">&quot;postLogoutRedirectUri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}&quot;</span><span class="p">,</span>
</span><span id="__span-26-19"><a id="__codelineno-26-19" name="__codelineno-26-19" href="#__codelineno-26-19"></a>
</span><span id="__span-26-20"><a id="__codelineno-26-20" name="__codelineno-26-20" href="#__codelineno-26-20"></a><span class="w">        </span><span class="nt">&quot;responseType&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;code&quot;</span><span class="p">,</span>
</span><span id="__span-26-21"><a id="__codelineno-26-21" name="__codelineno-26-21" href="#__codelineno-26-21"></a><span class="w">        </span><span class="nt">&quot;oidc&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
</span><span id="__span-26-22"><a id="__codelineno-26-22" name="__codelineno-26-22" href="#__codelineno-26-22"></a><span class="w">        </span><span class="nt">&quot;clientId&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;osapiWebClientId&quot;</span><span class="p">,</span>
</span><span id="__span-26-23"><a id="__codelineno-26-23" name="__codelineno-26-23" href="#__codelineno-26-23"></a><span class="w">        </span><span class="nt">&quot;dummyClientSecret&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;secret&quot;</span><span class="p">,</span>
</span><span id="__span-26-24"><a id="__codelineno-26-24" name="__codelineno-26-24" href="#__codelineno-26-24"></a>
</span><span id="__span-26-25"><a id="__codelineno-26-25" name="__codelineno-26-25" href="#__codelineno-26-25"></a><span class="w">        </span><span class="nt">&quot;requireHttps&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
</span><span id="__span-26-26"><a id="__codelineno-26-26" name="__codelineno-26-26" href="#__codelineno-26-26"></a><span class="w">        </span><span class="nt">&quot;useHttpBasicAuth&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
</span><span id="__span-26-27"><a id="__codelineno-26-27" name="__codelineno-26-27" href="#__codelineno-26-27"></a><span class="w">        </span><span class="nt">&quot;clearHashAfterLogin&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
</span><span id="__span-26-28"><a id="__codelineno-26-28" name="__codelineno-26-28" href="#__codelineno-26-28"></a>
</span><span id="__span-26-29"><a id="__codelineno-26-29" name="__codelineno-26-29" href="#__codelineno-26-29"></a><span class="w">        </span><span class="nt">&quot;showDebugInformation&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
</span><span id="__span-26-30"><a id="__codelineno-26-30" name="__codelineno-26-30" href="#__codelineno-26-30"></a><span class="w">    </span><span class="p">}</span>
</span><span id="__span-26-31"><a id="__codelineno-26-31" name="__codelineno-26-31" href="#__codelineno-26-31"></a><span class="p">}</span>
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3299 
<blockquote>
Dimitrios Giannopoulos's avatar
Deployed a160322 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Dimitrios Giannopoulos committed
3300 
<p>The {BASEURL} placeholder in the file automatically detects the Origin (Protocol://Domain:Port) of the deployment and applies it to every respective property. E.g. If you are attempting a local deployment of OpenSlice, then {BASEURL} is automatically translated to "http://localhost". Similarly, you may use {BASEURL} to translate to a public deployment configuration, e.g. "https://portal.openslice.eu".</p>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3301 3302 
</blockquote>
<p>If further customization, apart from the default provided, is needed for branding (Logo, Footer) then <code>config.theming.json</code> needs to be created in io.openslice.tmf.web/src/assets/config directory, as follows:</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3303 3304 3305 3306 3307 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-27-1"><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a><span class="c1"># Starting from the root project directory</span>
</span><span id="__span-27-2"><a id="__codelineno-27-2" name="__codelineno-27-2" href="#__codelineno-27-2"></a><span class="nb">cd</span><span class="w"> </span>org.etsi.osl.tmf.web/src/assets/config
</span></code></pre></div>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-28-1"><a id="__codelineno-28-1" name="__codelineno-28-1" href="#__codelineno-28-1"></a>sudo<span class="w"> </span>cp<span class="w"> </span>config.theming.default.json<span class="w"> </span>config.theming.json
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3308 3309 3310 3311 3312 3313 
<blockquote>
<p><strong><em>IMPORTANT NOTE:</em></strong>
If you want to apply changes to the JSON configuration files without the need to rebuild the application, you have to apply the changes at the <code>org.etsi.osl.tmf.web/dist/io-openslice-portal-web/assets/config</code> directory. Although, it is <u>mandatory</u> to also apply these changes to the <code>org.etsi.osl.tmf.web/src/assets/config</code> for <u>persistancy</u>, as after any future rebuild of OpenSlice the <code>/dist</code> directory is being overwritten along with its contents. The OpenSlice team strongly recommends to always apply your changes to the TMF web UI configuration files at <code>org.etsi.osl.tmf.web/src/assets/config</code> and rebuild the application.</p>
</blockquote>
<h2 id="deploy-openslice-via-docker-compose">Deploy OpenSlice via Docker Compose</h2>
<p>After configuring the services, and editing the docker compose file accordingly, the docker compose instantiation command can be performed.</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3314 3315 3316 3317 3318 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-29-1"><a id="__codelineno-29-1" name="__codelineno-29-1" href="#__codelineno-29-1"></a><span class="c1"># Starting from the root project directory</span>
</span><span id="__span-29-2"><a id="__codelineno-29-2" name="__codelineno-29-2" href="#__codelineno-29-2"></a><span class="nb">cd</span><span class="w"> </span>org.etsi.osl.main/compose/
</span></code></pre></div>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-30-1"><a id="__codelineno-30-1" name="__codelineno-30-1" href="#__codelineno-30-1"></a>sudo<span class="w"> </span>docker<span class="w"> </span>compose<span class="w"> </span>--profile<span class="w"> </span>prod<span class="w"> </span>down<span class="p">;</span>sudo<span class="w"> </span>docker<span class="w"> </span>compose<span class="w"> </span>--profile<span class="w"> </span>prod<span class="w"> </span>up<span class="w"> </span>-d<span class="w"> </span>--build
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 
<blockquote>
<p>Depending on your machine, this process might take time. if for any reason the deployment fails during first time, please rerun the above before any further measures.</p>
</blockquote>
<h2 id="validating-deployments-and-container-monitoring">Validating deployments and container monitoring</h2>
<p>You can monitor containers' status with portainer at port 9000 (http://your-ip:9000).</p>
<p>Initially, you may monitor the local machine at portainer.</p>
<p>Please check that all containers are in running state.</p>
<h2 id="post-installation-steps">Post installation steps</h2>
<p>After the successful deployment of OpenSlice, to ensure the E2E user experience, <strong>this section is mandatory</strong>. It contains crucial configuration in regard of authentication and user creation.</p>
<h3 id="configure-keycloak-server">Configure Keycloak server</h3>
<p>The Keycloack server is managing authentication and running on a container at port 8080. It is also proxied to your host via nginx under http://localhost/auth. </p>
<ul>
<li>
<p>Navigate to http://domain.com/auth/ or https://domain.com/auth/, (http://ipaddress:8080/auth/ or https://ipaddress:8443/auth/ which are directly accessible without proxy) </p>
</li>
<li>
<p>Navigate to Administration Console </p>
</li>
<li>
<p>Login with the credentials from section <a href="#3-configure-keycloak-container-optional">Configure keycloak container</a>. Default values are:</p>
<ul>
<li>user: admin and </li>
<li>password: Pa55w0rd</li>
</ul>
</li>
</ul>
<blockquote>
<p>if you are running in HTTP you will get a message: HTTPS required.</p>
</blockquote>
<p>To resolve this issue <u>when running in HTTP</u>: </p>
<ul>
<li>Select the master realm from top left corner</li>
<li>Go to login Tab and select "Require SSL": None</li>
<li>Repeat for realm Openslice</li>
</ul>
<blockquote>
<p>If you are running in HTTPS, then "Require SSL" can be left unchanged to external requests.</p>
</blockquote>
<h4 id="1-configure-redirects">1. Configure redirects</h4>
<p>Navigate to realm Openslice &gt; Clients &gt; osapiWebClientId and change the Root URL to your domain. </p>
Dimitrios Giannopoulos's avatar
Deployed 23f31d4 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3359 3360 3361 3362 3363 
<p>Also, insert your domain, e.g. http://example.org/*, at:</p>
<ul>
<li>Valid Redirect URIs</li>
<li>Web Origins</li>
</ul>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 
<h4 id="2-configure-email">2. Configure email</h4>
<p>Keycloak allows new users to register. Subsequently, this will also allow new users to register to the OpenSlice portal.</p>
<p>Navigate to realm Openslice &gt; Realm Settings &gt; Login Tab &gt; check User registration, Verify email, Forgot password etc.</p>
<p>Finally, enter the details of the mail server at the Email Tab.</p>
<blockquote>
<p>Email configuration is optional for test runs, but if not provided the above functionalities (e.g. external user registration) will not be possible.</p>
</blockquote>
<h4 id="3-add-an-openslice-admin-user">3. Add an OpenSlice admin user</h4>
<p>This step is mandatory so as to access the OpenSlice Web UI. To add an OpenSlice admin user you must:</p>
<ul>
<li>Navigate to realm Openslice &gt; Users &gt; Add user</li>
<li>Set a password</li>
<li>Upon creation, navigate to Role Mappings and add ADMIN to Assigned Roles list</li>
</ul>
<blockquote>
<p>That user is different from the Keycloak admin user. It is required to login and browse the OpenSlice Web UI. The Role ADMIN guarantee full access through the OpenSlice UI, thus such a user is always required.</p>
</blockquote>
<h3 id="keycloak-at-localhost">Keycloak at localhost</h3>
<blockquote>
<p><strong>This is an important step if you run Keycloak on localhost!</strong></p>
</blockquote>
<p>1 - Edit your Hosts File, adding the line below</p>
<p><code>127.0.0.1 keycloak</code></p>
<p>Hosts File Location:</p>
<ul>
<li>
<p>In Linux/Unix, the file's location is at /etc/hosts </p>
</li>
<li>
<p>In Windows, its location is at c:\Windows\System32\Drivers\etc\hosts</p>
</li>
</ul>
<p>2 - Replace http://localhost/auth/ with http://keycloak:8080/auth/ in your Keycloak config for AngularJS and Angular (see examples below).</p>
<blockquote>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3398 
<p><strong>Explanation</strong>: Nginx uses the http://keycloak:8080 URL, which is accessible via the internal docker system's network.
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3399 3400 
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>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3401 
</blockquote>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3402 
<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>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3403 3404 3405 3406 3407 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-31-1"><a id="__codelineno-31-1" name="__codelineno-31-1" href="#__codelineno-31-1"></a><span class="c1"># Starting from the root project directory</span>
</span><span id="__span-31-2"><a id="__codelineno-31-2" name="__codelineno-31-2" href="#__codelineno-31-2"></a><span class="nb">cd</span><span class="w"> </span>org.etsi.osl.tmf.web/src/assets/config
</span></code></pre></div>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-32-1"><a id="__codelineno-32-1" name="__codelineno-32-1" href="#__codelineno-32-1"></a>nano<span class="w"> </span>config.prod.json
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3408 
<p>After editing, the displayed properties should look like the example below:</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 
<div class="language-json highlight"><pre><span></span><code><span id="__span-33-1"><a id="__codelineno-33-1" name="__codelineno-33-1" href="#__codelineno-33-1"></a><span class="p">{</span><span class="w">         </span>
</span><span id="__span-33-2"><a id="__codelineno-33-2" name="__codelineno-33-2" href="#__codelineno-33-2"></a><span class="w">  </span><span class="nt">&quot;OAUTH_CONFIG&quot;</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
</span><span id="__span-33-3"><a id="__codelineno-33-3" name="__codelineno-33-3" href="#__codelineno-33-3"></a><span class="w">      </span><span class="nt">&quot;issuer&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice&quot;</span><span class="p">,</span>
</span><span id="__span-33-4"><a id="__codelineno-33-4" name="__codelineno-33-4" href="#__codelineno-33-4"></a><span class="w">      </span><span class="nt">&quot;loginUrl&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth&quot;</span><span class="p">,</span>
</span><span id="__span-33-5"><a id="__codelineno-33-5" name="__codelineno-33-5" href="#__codelineno-33-5"></a><span class="w">      </span><span class="nt">&quot;tokenEndpoint&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token&quot;</span><span class="p">,</span>
</span><span id="__span-33-6"><a id="__codelineno-33-6" name="__codelineno-33-6" href="#__codelineno-33-6"></a><span class="w">      </span><span class="nt">&quot;userinfoEndpoint&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/userinfo&quot;</span><span class="p">,</span>
</span><span id="__span-33-7"><a id="__codelineno-33-7" name="__codelineno-33-7" href="#__codelineno-33-7"></a><span class="w">      </span><span class="nt">&quot;redirectUri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}/redirect&quot;</span><span class="p">,</span>
</span><span id="__span-33-8"><a id="__codelineno-33-8" name="__codelineno-33-8" href="#__codelineno-33-8"></a><span class="w">      </span><span class="nt">&quot;logoutUrl&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/logout&quot;</span><span class="p">,</span><span class="w"> </span>
</span><span id="__span-33-9"><a id="__codelineno-33-9" name="__codelineno-33-9" href="#__codelineno-33-9"></a><span class="w">      </span><span class="nt">&quot;postLogoutRedirectUri&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;{BASEURL}&quot;</span><span class="p">,</span>
</span><span id="__span-33-10"><a id="__codelineno-33-10" name="__codelineno-33-10" href="#__codelineno-33-10"></a><span class="w">  </span><span class="p">}</span>
</span><span id="__span-33-11"><a id="__codelineno-33-11" name="__codelineno-33-11" href="#__codelineno-33-11"></a><span class="p">}</span>
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3421 3422 
<blockquote>
<p>Note the difference in changing {BASEURL} -&gt; http://keycloak:8080</p>
Dimitrios Giannopoulos's avatar
Deployed 87ce273 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3423 
<p><strong>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</strong></p>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3424 3425 
</blockquote>
<p>2.2 - For the AngularJS configuration (NVF portal UI), navigate to org.etsi.osl.portal.web/src/js and edit config.js</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3426 3427 3428 3429 3430 
<div class="language-bash highlight"><pre><span></span><code><span id="__span-34-1"><a id="__codelineno-34-1" name="__codelineno-34-1" href="#__codelineno-34-1"></a><span class="c1"># Starting from the root project directory</span>
</span><span id="__span-34-2"><a id="__codelineno-34-2" name="__codelineno-34-2" href="#__codelineno-34-2"></a><span class="nb">cd</span><span class="w"> </span>org.etsi.osl.portal.web/src/js
</span></code></pre></div>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-35-1"><a id="__codelineno-35-1" name="__codelineno-35-1" href="#__codelineno-35-1"></a>nano<span class="w"> </span>config.js
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3431 
<p>After editing, the displayed properties should look like the example below:</p>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3432 3433 3434 3435 3436 3437 3438 3439 3440 
<div class="language-js highlight"><pre><span></span><code><span id="__span-36-1"><a id="__codelineno-36-1" name="__codelineno-36-1" href="#__codelineno-36-1"></a><span class="kd">var</span><span class="w"> </span><span class="nx">appConfig</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">angular</span><span class="p">.</span><span class="nx">module</span><span class="p">(</span><span class="s1">&#39;portalwebapp.config&#39;</span><span class="p">,[]);</span>
</span><span id="__span-36-2"><a id="__codelineno-36-2" name="__codelineno-36-2" href="#__codelineno-36-2"></a>
</span><span id="__span-36-3"><a id="__codelineno-36-3" name="__codelineno-36-3" href="#__codelineno-36-3"></a>
</span><span id="__span-36-4"><a id="__codelineno-36-4" name="__codelineno-36-4" href="#__codelineno-36-4"></a><span class="nx">appConfig</span><span class="p">.</span><span class="nx">factory</span><span class="p">(</span><span class="s1">&#39;APIEndPointService&#39;</span><span class="p">,</span><span class="w"> </span><span class="kd">function</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
</span><span id="__span-36-5"><a id="__codelineno-36-5" name="__codelineno-36-5" href="#__codelineno-36-5"></a><span class="w">   </span><span class="k">return</span><span class="w"> </span><span class="p">{</span><span class="w">       </span>
</span><span id="__span-36-6"><a id="__codelineno-36-6" name="__codelineno-36-6" href="#__codelineno-36-6"></a><span class="w">      </span><span class="nx">APIOAUTHURL</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;http://keycloak:8080/auth/realms/openslice&quot;</span><span class="p">,</span>
</span><span id="__span-36-7"><a id="__codelineno-36-7" name="__codelineno-36-7" href="#__codelineno-36-7"></a><span class="w">   </span><span class="p">};</span>
</span><span id="__span-36-8"><a id="__codelineno-36-8" name="__codelineno-36-8" href="#__codelineno-36-8"></a><span class="p">});</span>
</span></code></pre></div>
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3441 3442 3443 3444 3445 3446 
<blockquote>
<p>Note the difference in "APIOAUTHURL" property, changing ROOTURL -&gt; http://keycloak:8080</p>
</blockquote>
<h3 id="nfv-orchestrator-configuration">NFV Orchestrator Configuration</h3>
<p>After successfully deploying and configuring OpenSlice, you may configure its environment (e.g. the NFVO) that will facilitate the deployment of NFV artifacts.</p>
<p>See <a href="../nfvoconfig/">NFV Orchestrator Configuration</a>.</p>
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 












                
              </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>
Dimitrios Giannopoulos's avatar
Deployed a160322 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Dimitrios Giannopoulos committed
3469 
  <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>
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 
  Back to top
</button>
        
      </main>
      
        <footer class="md-footer">
  
    
      
      <nav class="md-footer__inner md-grid" aria-label="Footer" >
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3482 
          <a href="../deployment/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Introduction">
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3483 3484 
            <div class="md-footer__button md-icon">
Dimitrios Giannopoulos's avatar
Deployed a160322 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Dimitrios Giannopoulos committed
3485 
              <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>
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3486 3487 3488 3489 3490 3491 
            </div>
            <div class="md-footer__title">
              <span class="md-footer__direction">
                Previous
              </span>
              <div class="md-ellipsis">
Dimitrios Giannopoulos's avatar
Deployed ebfa2f7 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3492 
                Introduction
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 
              </div>
            </div>
          </a>
        
        
          
          <a href="../deploymentK8s/" class="md-footer__link md-footer__link--next" aria-label="Next: Kubernetes">
            <div class="md-footer__title">
              <span class="md-footer__direction">
                Next
              </span>
              <div class="md-ellipsis">
                Kubernetes
              </div>
            </div>
            <div class="md-footer__button md-icon">
Dimitrios Giannopoulos's avatar
Deployed a160322 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Dimitrios Giannopoulos committed
3510 
              <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>
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 
            </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">
Dimitrios Giannopoulos's avatar
Deployed f547ae9 to develop in public with MkDocs 1.6.0 and mike 2.1.2  
Dimitrios Giannopoulos committed
3522 
      Copyright &copy; 2024 ETSI OSL
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 
    </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://osl.etsi.org/" target="_blank" rel="noopener" title="osl.etsi.org" class="md-social__link">
Julien Satti's avatar
Deployed 5cf2493 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Julien Satti committed
3543 
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.7.1 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>
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 
    </a>
  
    
    
    
    
      
      
    
    <a href="https://labs.etsi.org/rep/osl" target="_blank" rel="noopener" title="labs.etsi.org" class="md-social__link">
Julien Satti's avatar
Deployed 5cf2493 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Julien Satti committed
3554 
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.7.1 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>
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 
    </a>
  
    
    
    
    
      
      
    
    <a href="https://www.linkedin.com/company/openslice/" target="_blank" rel="noopener" title="www.linkedin.com" class="md-social__link">
Julien Satti's avatar
Deployed 5cf2493 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Julien Satti committed
3565 
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 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>
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 
    </a>
  
    
    
    
    
      
      
    
    <a href="https://twitter.com/OpensliceOSS" target="_blank" rel="noopener" title="twitter.com" class="md-social__link">
Julien Satti's avatar
Deployed 5cf2493 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Julien Satti committed
3576 
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.7.1 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>
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 
    </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>
Kostis Trantzas's avatar
Deployed 5c2de56 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3593 
    <script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight", "content.code.copy"], "search": "../assets/javascripts/workers/search.6ce7567c.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>
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3594 3595
Kostis Trantzas's avatar
Deployed 2fc02f6 to develop in public with MkDocs 1.6.1 and mike 2.1.3  
Kostis Trantzas committed
3596 
      <script src="../assets/javascripts/bundle.88dd0f4e.min.js"></script>
Dimitrios Giannopoulos's avatar
Deployed f50bfff to develop in public with MkDocs 1.6.0 and mike 2.1.2
Dimitrios Giannopoulos committed
3597 3598 3599 3600 
      
    
  </body>
</html>
Show full blame