SwarmLab-HowTos/index.adoc

= SwarmLab.io !
Apostolos rootApostolos@swarmlab.io
// Metadata:
:description: Εισαγωγή στο SwarmLab
:keywords: iot, swarm
:data-uri:
:toc: right
:toc-title: Πίνακας περιεχομένων
:toclevels: 4
:source-highlighter: highlight
:icons: font
:sectnums: 

include::header.adoc[]


{empty} +


The followin HowTo shows how services are used in swarmlab.io!


== What is swarmlab.io?

A Lab management and orchestration tool that provides On Demand Lab Instances.

Lab Instances are services that run your project in a particular programming enviroment. 

The swarmlab.io consists of a main **Git Service** and a **Web-based interactive Lab environment.** 

=== Git service. 

**git.swarmlab.io is a painless self-hosted Git service. **

It is similar to GitHub, Bitbucket, and GitLab. 

https://git.swarmlab.io:3000 - uses **Gitea**.

=== Web-based interactive Lab environment

https://api-client.swarmlab.io:8088 - **api-client.swarmlab.io is a web-based interactive development environment for On Demand Lab Instances**



==== Purpose

The goal of this project is to provide the easiest, fastest, and most painless way of using a LAB and its services and technologies. 


== Docs


=== http://docs.swarmlab.io/SwarmLab-HowTos/HowTo-register.adoc.html[HowTo-register] 

=== http://docs.swarmlab.io/SwarmLab-HowTos/HowTo-gitea.adoc.html[HowTo-create Repo] 

==== Repo Directory_Structure_4_Lab_Instance Service

Lab_Instance service first clone your Repo and then automatically loads certain files based on a known file
structure.


.Directory_Structure
[source,bash]
----
swarmlab/
├── run
├── runafter
└── runbefore
----

===== runbefore

Lab_Instance dependencies. **"runbefore"** allows you to automatically pull-in other dependencies when using a Lab_Instance service. 

This file should contain a list of tasks and parameters to insert before the specified repos are executed on Lab_Instance.

===== run

Contains the main list of tasks to be executed by the Lab_Instance service.

===== runafter


**"runafter"** is the machanism that allows you to to permanently save your data. 

Lab_Instances are mortal, and it’s pretty much routine them to be stoped and deleted. 

If you have something like a data/log file that needs to be saved then at this point make sure to back it up! 

[NOTE]
====
You can use any Script Programming Language you want to automate the execution of Lab_Instance service 

The shebang **MUST** be in the first line

.e.g.
[source,bash]
----
#!/usr/bin/perl

use strict;
use warnings;

print "hello world!\n";
----


====




=== http://docs.swarmlab.io/SwarmLab-HowTos/HowTo-create-lab.adoc.html[HowTo-create_and_Run Lab_Instance] 


== The Lab Instance Interface

=== Main Interface

.Main Interface
image::./main1.png[Main Interface]

=== Main Lab Intance Interface

.Lab Instance Interface
image::./main3.png[Lab Instance Interface]

The default menus are:

- **a**  Run your project in  particular Lab
- **b**  Terminal provides full support for system shells (bash, tsch, etc.). You can run anything in your system shell, including languages such as php, perl, python etc. The terminal runs on the Lab Instance with sudo rights.
- **c**  Opens a collaborative text editor. The text editor includes syntax highlighting, key maps and basic theming. It can also be used as a terminal with **console output**.  It includes a basic **chat** room enviroment.   
- **d** Link to invite users. The "Invite users" function is not available yet, you will have to e-mail it by your self! :-) 
 

[NOTE]
====

b, c, d only appear after you click on a Lab Instance

====


== Terms

https://api-client.swarmlab.io:8088/#/terms[Terms of Service] 


== Legal Disclaimer and Notices

.Legal Disclaimer and Notices
[source,bash]
----
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of Swarmlab.io nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
----

**before you continue.**


[NOTE]
====
Using swarmlab.io confirms that you agree to both documents.
====