Commit e29dc8b4 authored by Dimitrios Giannopoulos's avatar Dimitrios Giannopoulos
Browse files

Deployed b4e6126d to develop in public with MkDocs 1.6.0 and mike 2.1.2

parent 49971d5f

public/develop/deploymentCompose/index.html

+53 −51
Original line number Diff line number Diff line
@@ -670,27 +670,27 @@ 
</li>

        

          <li class="md-nav__item">

  <a href="#5-configure-osportalapi-container-nfv-services-conditional" class="md-nav__link">

  <a href="#5-configure-cridge-container-optional" class="md-nav__link">

    <span class="md-ellipsis">

      5. Configure osportalapi container (NFV services) (conditional)

      5. Configure CRIDGE container (optional)

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

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

  <a href="#6-configure-osportalapi-container-nfv-services-conditional" class="md-nav__link">

    <span class="md-ellipsis">

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

      6. Configure osportalapi container (NFV services) (conditional)

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#7-configure-cridge-container" class="md-nav__link">

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

    <span class="md-ellipsis">

      7. Configure CRIDGE container

      7. Configure osscapi container (TMF API service) (conditional)

    </span>

  </a>
@@ -3199,27 +3199,27 @@ 
</li>

        

          <li class="md-nav__item">

  <a href="#5-configure-osportalapi-container-nfv-services-conditional" class="md-nav__link">

  <a href="#5-configure-cridge-container-optional" class="md-nav__link">

    <span class="md-ellipsis">

      5. Configure osportalapi container (NFV services) (conditional)

      5. Configure CRIDGE container (optional)

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

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

  <a href="#6-configure-osportalapi-container-nfv-services-conditional" class="md-nav__link">

    <span class="md-ellipsis">

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

      6. Configure osportalapi container (NFV services) (conditional)

    </span>

  </a>

  

</li>

        

          <li class="md-nav__item">

  <a href="#7-configure-cridge-container" class="md-nav__link">

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

    <span class="md-ellipsis">

      7. Configure CRIDGE container

      7. Configure osscapi container (TMF API service) (conditional)

    </span>

  </a>
@@ -3501,7 +3501,45 @@ DB_PASSWORD: password 
<li>VPN Credentials/Access: Used for requesting VPN Credentials/Access   </li>

</ul>

<p>Also in the 'Main Site Operations' product, a version named 'unspecified' must be created.</p>

<h3 id="5-configure-osportalapi-container-nfv-services-conditional">5. Configure osportalapi container (NFV services) <em>(conditional)</em></h3>

<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>

<pre><code class="language-yaml">volumes:

- ./kubedir/:/root/.kube

</code></pre>

<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>

<pre><code class="language-yaml">volumes:

- ./kubedir/custom-config-name:/root/.kube/config

</code></pre>

<p>OpenSlice also offers management support of <em>multiple Kubernetes Clusters</em> simultaneously. For this, you will have to:</p>

<ul>

<li>add all the respective kubeconf files into the <code>org.etsi.osl.main/compose/kubedir</code> directory. </li>

<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>

<pre><code class="language-yaml">cridge-cluster1:

  container_name: openslice-cluster1

  ...

  volumes:

  - ./kubedir/config-cluster1:/root/.kube/config



cridge-cluster2:

  container_name: openslice-cluster2

  ...

  volumes:

  - ./kubedir/config-cluster2:/root/.kube/config

</code></pre>

<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>

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

<ul>

<li>If you made changes to mysql and keycloak credentials.</li>
@@ -3522,14 +3560,14 @@ DB_PASSWORD: password 
  &quot;logging.level.org.springframework&quot; : &quot;INFO&quot;

}'

</code></pre>

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

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

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

<ul>

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

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

</ul>

<blockquote>

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

<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>

</blockquote>

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

<pre><code>SPRING_APPLICATION_JSON: '{
@@ -3542,42 +3580,6 @@ DB_PASSWORD: password 
  &quot;logging.level.org.springframework&quot; : &quot;INFO&quot;

}'

</code></pre>

<h3 id="7-configure-cridge-container">7. Configure CRIDGE container</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>

<pre><code class="language-yaml">volumes:

- ./kubedir/:/root/.kube

</code></pre>

<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>

<pre><code class="language-yaml">volumes:

- ./kubedir/custom-config-name:/root/.kube/config

</code></pre>

<p>OpenSlice also offers management support of <em>multiple Kubernetes Clusters</em> simultaneously. For this, you will have to:

- add all the respective kubeconf files into the <code>org.etsi.osl.main/compose/kubedir</code> directory. 

- 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>.</p>

<p>Below you may find an indicative example that only references the affected fields of the docker-compose file:</p>

<pre><code class="language-yaml">cridge-cluster1:

  container_name: openslice-cluster1

  ...

  volumes:

  - ./kubedir/config-cluster1:/root/.kube/config



cridge-cluster2:

  container_name: openslice-cluster2

  ...

  volumes:

  - ./kubedir/config-cluster2:/root/.kube/config

</code></pre>

<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>

<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/

public/develop/deploymentK8s/index.html

+6 −4
Original line number Diff line number Diff line
@@ -3501,10 +3501,12 @@ cd org.etsi.osl.main/kubernetes/helm/openslice/ 
<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>org.etsi.osl.main/kubernetes/helm/openslice/files/org.etsi.osl.cridge</code> directory. If you are working with custom kubeconf file names, you will have to rename them.</strong></p>

</blockquote>

<p>OpenSlice also offers management support of <em>multiple Kubernetes Clusters</em> simultaneously. For this, you will have to:

- add all the respective kubeconf files into the <code>org.etsi.osl.main/compose/kubedir</code> directory. 

- create a copy of the <code>cridge.yaml</code> and <code>cridge-config.yaml</code> in <code>\org.etsi.osl.main\kubernetes\helm\openslice\templates</code> directory for every Cluster. <em>Mind the need for different naming</em>.

- update every <code>cridge-config.yaml</code> file to get the appropriate kubeconf file for every Cluster.</p>

<p>OpenSlice also offers management support of <em>multiple Kubernetes Clusters</em> simultaneously. For this, you will have to:</p>

<ul>

<li>add all the respective kubeconf files into the <code>org.etsi.osl.main/compose/kubedir</code> directory. </li>

<li>create a copy of the <code>cridge.yaml</code> and <code>cridge-config.yaml</code> in <code>\org.etsi.osl.main\kubernetes\helm\openslice\templates</code> directory for every Cluster. <em>Mind the need for different naming</em>.</li>

<li>update every <code>cridge-config.yaml</code> file to get the appropriate kubeconf file for every Cluster.</li>

</ul>

<p>Below you may find an indicative example that only references the affected fields of each cridge-config.yaml file:</p>

<pre><code class="language-yaml">data:

  config: |-

public/develop/search/search_index.json

+1 −1

File changed.

Preview size limit exceeded, changes collapsed.