You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

143 lines
4.0 KiB

5 years ago
= SwarmLab.io !
5 years ago
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} +
5 years ago
The followin HowTo shows how services are used in swarmlab.io!
5 years ago
== What is swarmlab.io?
=== Git service.
5 years ago
**git.swarmlab.io is a painless self-hosted Git service. **
5 years ago
5 years ago
It is similar to GitHub, Bitbucket, and GitLab. git.swarmlab.io uses **Gitea**.
5 years ago
=== A cluster management and orchestration tool
5 years ago
**api-client.swarmlab.io is a cluster management and orchestration tool that provides On Demand Lab Instances**
5 years ago
==== 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]
5 years ago
==== Repo Directory_Structure_4_Lab_Instance Service
5 years ago
5 years ago
Lab_Instance service first clone your Repo and then automatically loads certain files based on a known file
5 years ago
structure.
.Directory_Structure
[source,bash]
----
swarmlab/
├── run
├── runafter
└── runbefore
----
===== runbefore
5 years ago
Lab_Instance dependencies. **"runbefore"** allows you to automatically pull-in other dependencies when using a Lab_Instance service.
5 years ago
This file should contain a list of tasks and parameters to insert before the specified repos are executed on Lab_Instance.
5 years ago
===== run
5 years ago
Contains the main list of tasks to be executed by the Lab_Instance service.
5 years ago
===== runafter
5 years ago
**"runafter"** is the machanism that allows you to to permanently save your data.
5 years ago
5 years ago
Lab_Instances are mortal, and it’s pretty much routine them to be stoped and deleted.
5 years ago
5 years ago
If you have something like a data/log file that needs to be saved then at this point make sure to back it up!
5 years ago
[NOTE]
====
5 years ago
You can use any Script Programming Language you want to automate the execution of Lab_Instance service
5 years ago
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]
5 years ago
5 years ago
== 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.
====