Skip to content

E
erp5-doc
Commit 582f817b authored by Alain Takoudjou's avatar Alain Takoudjou
Browse files
Options

[erp5_slapos_tutorial] Add OSTV documentation files

parent ed867326
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 5815 additions and 2 deletions
bt5/erp5_slapos_tutorial/PathTemplateItem/test_page_module/P-OSTV-HowTo.Add.User.To.Simcard.Db.html 0 → 100644
View file @ 582f817b
<!-- 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="P-OSTV-Tutorial.Install.Slapos.Master.Comp.Root">SlapOS Master</a> (<b>COMP-ROOT</b>) and <a href="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="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="https://www.nexedi.com/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="https://www.nexedi.com/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="https://www.nexedi.com/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="https://www.nexedi.com/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="https://www.nexedi.com/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="https://www.nexedi.com/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="https://www.nexedi.com/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="https://www.nexedi.com/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="https://www.nexedi.com/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 @ 582f817b
<!-- 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="P-OSTV-Tutorial.Install.Slapos.Master.Comp.Root">SlapOS Master</a> (<b>COMP-ROOT</b>) and <a href="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="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="https://www.nexedi.com/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="https://www.nexedi.com/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="https://www.nexedi.com/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="https://www.nexedi.com/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="https://www.nexedi.com/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="https://www.nexedi.com/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="https://www.nexedi.com/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="https://www.nexedi.com/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/PathTemplateItem/test_page_module/P-OSTV-Tutorial.Nms.Learning.Track.User.html 0 → 100644
View file @ 582f817b
<!-- 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>NMS User Learning Track</h1>
<details open="open">
<p>This learning track is meant for <b>USERS</b> of a <b>Network Management System</b> (NMS) based on SlapOS. After finishing this learning track, you should have a good enough understanding of how to use the NMS to manage a network.</p>
<p>The track is split into lectures introducing a certain component and showing how they are setup and fit into the overall architecture.</p>
</details>
</section>
<section class="master">
<h1>Table of Content</h1>
<ul>
<li>Lecture 0: Introduction</li>
<li>Lecture 1: How to add LTE Service</li>
<li>Lecture 2: How to create a new Software Release</li>
<li>Lecture 3: How to update configuration of eNB or EPC</li>
<li>Lecture 4: How to add User to SimcardDB</li>
</ul>
</section>
<section class="chapter">
<h1>Lecture 0: NMS Introduction</h1>
<details open="open">
<p>This section is a global introduction to NMS and only contains reading materials. It will introduce the NMS and underlying SlapOS sytems and provide answers to key questions. The following documents should be read:</p>
<ul>
<li><a href="P-OSTV-DesignDocument.OSTV.NMS">OSTV Design Document - OSVT NMS Introduction (</a><a href="P-OSTV-DesignDocument.OSTV.NMS?portal_skin=Slide">presentation</a>)</li>
</ul>
</details>
</section>
<section class="chapter">
<h1>Lecture 1: How to add LTE Service</h1>
<details open="open">
<p>This section will show how to instantiate a new LTE service (eNB or EPC) on a machine. It does NOT cover setting up a machine itself or adding the Amarisoft LTE software release to the software catalog of the SlapOS Master so it can be installed on this machine. These steps are part of the admin learning track and can be found in <a href="P-OSTV-Tutorial.Install.Slapos.Node.Comp.123">installing COMP-123 LTE Box</a> (<a href="P-OSTV-Tutorial.Install.Slapos.Node.Comp.123?portal_skin=Slide">presentation</a>). The following document should be read:</p>
<ul>
<li><a href="P-OSTV-HowTo.Add.Lte.Service">OSTV HowTo - Add LTE Service</a> (<a href="P-OSTV-HowTo.Add.Lte.Service?portal_skin=Slide">presentation</a>)</li>
</ul>
</details>
</section>
<section class="chapter">
<h1>Lecture 2: How to create a new Software Release</h1>
<details open="open">
<p>This section will show how to create a basic software release and explain how the different parts interact. The result of this howto will be a software profile (<code>software.cfg</code>) file. If put on a repository with accessible url, this profile can be used in a NMS network.</p>
<p>This howto does NOT cover how to add a new software product and this release to the NMS software catalogue or how to install this software on a network node. These steps can be found in&nbsp;<a href="slapos-Tutorial.Install.Slapos.Node.Comp.0">Install SlapOS Node (COMP-0) (</a><a href="slapos-Tutorial.Install.Slapos.Node.Comp.0?portal_skin=Slide">presentation</a>) and <a href="P-OSTV-Tutorial.Install.Slapos.Node.Comp.123">installing a network node (COMP-123)</a> (<a href="P-OSTV-Tutorial.Install.Slapos.Node.Comp.123?portal_skin=Slide">presentation</a>). The following document should be read for this lecture:</p>
<ul>
<li><a href="P-OSTV-HowTo.Create.Software.Release">OSTV HowTo - Create Software Release</a> (<a href="P-OSTV-HowTo.Create.Software.Release?portal_skin=Slide">presentation</a>)</li>
</ul>
</details>
</section>
<section class="chapter">
<h1>Lecture 3: How to update configuration of eNB or EPC</h1>
<details open="open">
<p>This section will show how to update the configuration of an eNB or EPC instance through the NMS Dashboard. It does NOT cover adding new parameters to eNB or EPC themself, which is shown in the lecture on&nbsp;<a href="slapos-Tutorial.Extend.Software.Release">extending the software release</a>&nbsp;(<a href="slapos-Tutorial.Extend.Software.Release?portal_skin=Slide">presentation</a>). The following document should be read for this lecture:</p>
<ul>
<li><a href="P-OSTV-HowTo.Update.Enb.Or.Epc">OSTV HowTo - Update eNB or EPC</a> (<a href="P-OSTV-HowTo.Update.Enb.Or.Epc?portal_skin=Slide">presentation</a>)</li>
</ul>
</details>
</section>
<section class="chapter">
<h1>Lecture 4: How to add User to SimcardDB</h1>
<details open="open">
<p>This section will show how to instantiate a new user (SimcardID) on the SimcardDB. The following document should be read:</p>
<ul>
<li><a href="P-OSTV-HowTo.Add.User.To.Simcard.Db">OSTV HowTo - Add User to SimcardDB</a> (<a href="P-OSTV-HowTo.Add.User.To.Simcard.Db?portal_skin=Slide">presentation</a>)</li>
</ul>
</details>
</section>
<section class="master">
<h1>Thank You</h1>
<div style="float:left;margin-top:9%;width:48%;"><img alt="Image Nexedi Office" src="https://slapos.nexedi.com/NXD-Media.Image.Office.Munich?display=large&amp;format=png" title="Image Nexedi Office" 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">&nbsp;</details>
</section>
bt5/erp5_slapos_tutorial/PathTemplateItem/test_page_module/P-SLAPOS-Home.Page.html
View file @ 582f817b
......@@ -244,6 +244,15 @@
<p>Once you have accomplished all of the above tutorials, you should be familiar enough with SlapOS to use it to create your own cloud infrastrucre and provide services to users.</p>
-->
<h1>OSTV Tutorials - NMS Learning Track</h1>
<p>This tutorials will&nbsp;teach the setup and use of a Network Management System (NMS) based on SlapOS for ADMINS and Users.</p>
<ul>
<li><a href="P-OSTV-Tutorial.Nms.Learning.Track.User">User Learning Track</a> - understanding of how to use NMS to manage a network.</li>
<li><a href="P-OSTV-Tutorial.Nms.Learning.Track">Admin Learning Track</a> - how to setup and use of NMS.</li>
</ul>
<h1>Documentation</h1>
<p>Aside from the above tutorials, a number of additional documentation provides insights into certain topics.</p>
......
bt5/erp5_slapos_tutorial/PathTemplateItem/test_page_module/P-SLAPOS-Home.Page.xml
View file @ 582f817b
......@@ -240,7 +240,7 @@
</item>
<item>
<key> <string>serial</string> </key>
<value> <string>975.49009.14029.60696</string> </value>
<value> <string>975.56316.5423.23504</string> </value>
</item>
<item>
<key> <string>state</string> </key>
......@@ -258,7 +258,7 @@
</tuple>
<state>
<tuple>
<float>1557996584.85</float>
<float>1558438926.36</float>
<string>UTC</string>
</tuple>
</state>
......
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