Skip to content

erp5
erp5
Commit d525a9d7 authored by Alain Takoudjou's avatar Alain Takoudjou
Browse files
Options

OSTV documentation

parent e333c0a5
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 5368 additions and 0 deletions
bt5/erp5_slapos_tutorial/PathTemplateItem/test_page_module/P-OSTV-HowTo.Add.User.To.Simcard.Db.html 0 → 100644
View file @ d525a9d7
<!-- this should be built as a book from separate files. The book should
contain the description for the entry slide, all other slides are file whose
header is used as slide header, image as image and text wrapped in 1+ details
tags -->
<!-- replaces:
-->
<section class="master">
<h1>How To Add User to SimcardDB</h1>
<details open="open">
<p>
This document will guide through the steps of adding a new user to the SimcardDB which will be queried by eNBs in regular intervals for new IDs.
For following this howto, it is required to have:
</p>
<ul>
<li>A NMS network set up with a <a href="https://www.nexedi.com/P-OSTV-Tutorial.Install.Slapos.Master.Comp.Root">SlapOS Master</a> (<b>COMP-ROOT</b>) and <a href="https://www.nexedi.com/P-OSTV-Tutorial.Install.Slapos.Node.Comp.0">first node</a> (<b>COMP-0</b>) and ready to use.</li>
<li>A SimcardDB software release <a href="https://www.nexedi.com/P-OSTV-Tutorial.Install.Slapos.Node.Comp.0">installed on the COMP-0 or any other machine</a> (<b>COMP-123</b>)</li>
<li>A user account on the NMS system</li>
</ul>
</details>
</section>
<section class="master">
<h1>Table of Content</h1>
<ul>
<li>Add User to SimcardDB</li>
</ul>
</section>
<section class="chapter">
<h1>Add Simcard to SimcardDB</h1>
<details open="open">
<p>
The eNB will query the SimcardDB in regular intervals for new simcard ids.
In this section we will add a simcard to the SimcardDB. You could then
investigate when the simcard id becomes available on the eNB and whether it
can be used (both steps are not part of the howto).
</p>
</details>
</section>
<section>
<h1>NMS Login</h1>
<img src="slapos-Interface.Add.Service.Simcard.Id.Login?display=&amp;format=png" alt="SlapOS Interface - Login" />
<details open="open">
<p>
Start by logging into your NMS Dashboard.
</p>
</details>
</section>
<section>
<h1>NMS Dashboard</h1>
<img src="slapos-Interface.Add.Service.Simcard.Id.Dashboard?display=&amp;format=png" alt="SlapOS Interface - Dashboard" />
<details open="open">
<p>
Click on the <i>Services</i> button on the to see currently instantiated services.
</p>
</details>
</section>
<section>
<h1>List of Instantiated Services</h1>
<img src="slapos-Interface.Add.Service.Simcard.Id.Service.List?display=&amp;format=png" alt="SlapOS Dashboard - Service List" />
<details open="open">
<p>
Click <i>Add</i> in the subheader to add a new service.
</p>
</details>
</section>
<section>
<h1>Create New SimcardId Instance</h1>
<img src="slapos-Interface.Add.Service.Simcard.Id.Select.Service?display=&amp;format=png" alt="SlapOS Dashboard - Select Service" />
<details open="open">
<p>
Select SimcardDB as this is the service we want to provide.
The differentiation between instantiating a new SimcardDB and adding a Simcard
will be made using the configuration parameter <i>Software-Type</i> in the next steps.
</p>
</details>
</section>
<section>
<h1>Select SimcardId Service Version</h1>
<img src="slapos-Interface.Add.Service.Simcard.Id.Select.Version?display=&amp;format=png" alt="SlapOS Dashboard - Select Service Version" />
<details open="open">
<p>Please choose the latest version.
</p>
</details>
</section>
<section>
<h1>SimcardId Configuration</h1>
<img src="slapos-Interface.Add.Service.Simcard.Id.Configuration.Parameter.List?display=&amp;format=png" alt="SlapOS Dashboard - Service Configuration Parameters" />
<details open="open">
<p>
Select <code>Software Type</code> <i>SimCard</i>, choose the computer which supplied the SimcardDB and fill out the
configuration parameters as shown.
</p>
<p>
Click <i>Proceed</i> to continue.
</p>
</details>
</section>
<section>
<h1>SimcardId Instantiation</h1>
<img src="slapos-Interface.Add.Service.Simcard.Id.Instantiation?display=&amp;format=png" alt="SlapOS Dashboard - Service Instantiation" />
<details open="open">
<p>
Refresh the page to see the new instance. Click on it once appears.
</p>
</details>
</section>
<section>
<h1>SimcardId Connection Parameters</h1>
<img src="slapos-Interface.Add.Service.Simcard.Id.Connection.Parameter.List?display=&amp;format=png" alt="SlapOS Dashboard - Connection Parameters" />
<details open="open">
<p>
Wait and refresh the page from time to time until the status changes from <i>Start Requested</i>. Once your instance has been deployed the SimcardId
should be propagated to the eNB/EPC associated with the underlying SimcardDB.
</p>
</details>
</section>
<section class="master">
<h1>Thank You</h1>
<div style="float:left;margin-top:9%;width:48%;">
<img alt="Image Nexedi Office"
title="Image Nexedi Office"
src="NXD-Media.Image.Office.Munich?display=large&amp;format=png"
type="image/png" />
</div>
<div>
<ul style="list-style:none;display:block;">
<li>Nexedi SA</li>
<li>147 Rue du Ballon</li>
<li>59110 La Madeleine</li>
<li>France</li>
</ul>
<ul style="list-style:none;display:block;">
<li><a href="http://nexedi.com/contact">nexedi.com/contact</a></li>
</ul>
</div>
<details open="open"></details>
</section>
\ No newline at end of file
bt5/erp5_slapos_tutorial/PathTemplateItem/test_page_module/P-OSTV-HowTo.Update.Enb.Or.Epc.html 0 → 100644
View file @ d525a9d7
<!-- this should be built as a book from separate files. The book should
contain the description for the entry slide, all other slides are file whose
header is used as slide header, image as image and text wrapped in 1+ details
tags -->
<!-- replaces:
-->
<section class="master">
<h1>How To Update eNB or EPC</h1>
<details open="open">
<p>
This document will show how to modify the parameters on an instantiated
eNB or EPC service. It is required to have:</p>
<ul>
<li>A NMS network setup with a <a href="https://www.nexedi.com/P-OSTV-Tutorial.Install.Slapos.Master.Comp.Root">SlapOS Master</a> (<b>COMP-ROOT</b>) and <a href="https://www.nexedi.com/P-OSTV-Tutorial.Install.Slapos.Node.Comp.0">first node</a> (<b>COMP-0</b>)</li>
<li>An Amarisoft LTE or equiavalent software release <a href="https://www.nexedi.com/P-OSTV-Tutorial.Install.Slapos.Node.Comp.0">installed on a LTE Box</a> (<b>COMP-123</b>)</li>
<li>An existing instance of eNB or EPC</li>
<li>A user account to the NMS system</li>
</ul>
</details>
</section>
<section class="master">
<h1>Table of Content</h1>
<ul>
<li>Updating Instance Parameters</li>
</ul>
</section>
<section class="chapter">
<h1>Updating Instance Parameters</h1>
<details open="open">
<p>
Each software usually provides a number of configuration parameters which can
be set before instantiating a service (creating an instance). After the service
has been instantiated, all parameters are accessible and editable on the service
page of the NMS Dashboard.
</p>
<p>
<b>Note</b>, that updating an instance (for example by <b>changing a parameter</b>),
will only update this specific instance. All other instances of the same service
remain unchanged. In order to update all instances of a service (for example <b>adding
a new parameter</b>), it is required to create a new software release and trigger the
update of all instances to change to this new release.
</p>
</details>
</section>
<section>
<h1>NMS Login</h1>
<img src="slapos-Interface.Edit.Service.Enb.Login?display=&amp;format=png" alt="SlapOS Interface - Login" />
<details open="open">
<p>
Start by logging into your NMS Master Dashboard.
</p>
</details>
</section>
<section>
<h1>NMS Dashboard</h1>
<img src="slapos-Interface.Edit.Service.Enb.Dashboard?display=&amp;format=png" alt="SlapOS Interface - Dashboard" />
<details open="open">
<p>
Click on the <i>Services</i> button on the to see currently instantiated services.
</p>
</details>
</section>
<section>
<h1>Select Service ENB-EDIT</h1>
<img src="slapos-Interface.Edit.Service.Enb.Service.List?display=&amp;format=png" alt="SlapOS Interface - Service List" />
<details open="open">
<p>Select the ENB-EDIT service. As Amarisoft ENBs require a license to run, this info needs to be provided in the <code>License Key Path</code> field for proper instantiation.</p>
</details>
</section>
<section>
<h1>Edit Service ENB-EDIT</h1>
<img src="slapos-Interface.Edit.Service.Enb.Edit.Service?display=&amp;format=png" alt="SlapOS Interface - Edit Service" />
<details open="open">
<p>
Add the <code>License Key Path</code> which in this case points to <i>/etc/amarisoft/</i>.
</p>
</details>
</section>
<section>
<h1>Save Service ENB-EDIT</h1>
<img src="slapos-Interface.Edit.Service.Enb.Save.Service?display=&amp;format=png" alt="SlapOS Interface - Save Service" />
<details open="open">
<p>
Click <i>Save</i> in the subheader to update the ENB configuration parameters and trigger a rebuild of the instance.
</p>
</details>
</section>
<section>
<h1>Save Service ENB-EDIT</h1>
<img src="slapos-Interface.Edit.Service.Enb.Saved.Service?display=&amp;format=png" alt="SlapOS Interface - Saved Service" />
<details open="open">
<p>
Once saved, wait for the instance to be updated. Refresh the page from time to time, it should take a few minutes.
</p>
</details>
</section>
<section>
<h1>Updated Service ENB-EDIT</h1>
<img src="slapos-Interface.Edit.Service.Enb.Updated.Service?display=&amp;format=png" alt="SlapOS Interface - Updated Service" />
<details open="open">
<p>
After the update, the service could correctly be instantiated (green indicator).
</p>
</details>
</section>
<section>
<h1>Updated Service ENB-EDIT</h1>
<img src="slapos-Interface.Edit.Service.Enb.Updated.Service.List?display=&amp;format=png" alt="SlapOS Interface - Update Service List" />
<details open="open">
<p>
Changing other parameters works in the same way. Edit the form, save changes and
wait for the instance to be rebuild.
</p>
</details>
</section>
<section class="master">
<h1>Thank You</h1>
<div style="float:left;margin-top:9%;width:48%;">
<img alt="Image Nexedi Office"
title="Image Nexedi Office"
src="NXD-Media.Image.Office.Munich?display=large&amp;format=png"
type="image/png" />
</div>
<div>
<ul style="list-style:none;display:block;">
<li>Nexedi SA</li>
<li>147 Rue du Ballon</li>
<li>59110 La Madeleine</li>
<li>France</li>
</ul>
<ul style="list-style:none;display:block;">
<li><a href="http://nexedi.com/contact">nexedi.com/contact</a></li>
</ul>
</div>
<details open="open"></details>
</section>
\ No newline at end of file
bt5/erp5_slapos_tutorial/bt/copyright_list 0 → 100644
View file @ d525a9d7
Copyright 2019, Nexedi SA
\ No newline at end of file
bt5/erp5_slapos_tutorial/bt/dependency_list 0 → 100644
View file @ d525a9d7
erp5_run_my_doc
\ No newline at end of file
bt5/erp5_slapos_tutorial/bt/description 0 → 100644
View file @ d525a9d7
This bt5 contains SlapOS user documentation
\ No newline at end of file
bt5/erp5_slapos_tutorial/bt/license 0 → 100644
View file @ d525a9d7
Creative Common Attribution NonCommercial ShareAlike
\ No newline at end of file
bt5/erp5_slapos_tutorial/bt/template_keep_last_workflow_history_only_path_list 0 → 100644
View file @ d525a9d7
test_page_module/P-OSTV-DesignDocument.OSTV.NMS
test_page_module/P-OSTV-DesignDocument.Understanding.Nms.Software.Release
test_page_module/P-OSTV-HowTo.Add.Lte.Service
test_page_module/P-OSTV-HowTo.Add.User.To.Simcard.Db
test_page_module/P-OSTV-HowTo.Create.Software.Release
test_page_module/P-OSTV-HowTo.Update.Enb.Or.Epc
test_page_module/P-OSTV-Tutorial.Install.Slapos.Node.Comp.123
test_page_module/P-OSTV-Tutorial.Nms.Learning.Track
\ No newline at end of file
bt5/erp5_slapos_tutorial/bt/template_path_list 0 → 100644
View file @ d525a9d7
test_page_module/P-OSTV-DesignDocument.OSTV.NMS
test_page_module/P-OSTV-DesignDocument.Understanding.Nms.Software.Release
test_page_module/P-OSTV-HowTo.Add.Lte.Service
test_page_module/P-OSTV-HowTo.Add.User.To.Simcard.Db
test_page_module/P-OSTV-HowTo.Create.Software.Release
test_page_module/P-OSTV-HowTo.Update.Enb.Or.Epc
test_page_module/P-OSTV-Tutorial.Install.Slapos.Node.Comp.123
test_page_module/P-OSTV-Tutorial.Nms.Learning.Track
\ No newline at end of file
bt5/erp5_slapos_tutorial/bt/title 0 → 100644
View file @ d525a9d7
erp5_slapos_tutorial
\ No newline at end of file
bt5/erp5_slapos_tutorial/bt/version 0 → 100644
View file @ d525a9d7
5.4.7
\ No newline at end of file
Markdown is supported
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7