From 2533894dedc2cb1b217cff02f05adfac94a1af23 Mon Sep 17 00:00:00 2001 From: zeus Date: Thu, 16 Dec 2021 02:05:19 +0200 Subject: [PATCH] readme --- README.md | 106 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 61 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 51e865d..6523bdf 100644 --- a/README.md +++ b/README.md @@ -20,68 +20,84 @@ ### -## Swarmlab Hybrid is Swarmlabs younger, more tech savvy brother. -Swarmlab hybrid provides the user with the unique abillity to create Labrooms (or other applications) and share them as project images expanding the simple swarmlab Labrooms to full-blown systems. An all of that using onlly the browser and the command line of their system. - -## Why? -Ever imagined having a normal lesson as you would in the University from the comfort of your livingroom? -Ever created a service that you would like to test on a real-world network? -Ever designed an Labroom/application you would like to distribute to your students/applications? -Swarmlab Hybrid comes to bridge the gap between tutor and student, the coder/developer of a service and the and user and at the same time meet the needs for a real-world testing environment. -With Hybrid we can now as part of the cloud work independantly but also stay connected. -The hybrid format allows us to utilize the power of Swarmlab itself but also combine it with the practiaclly unlimited computing of our own machines. +An open source work/study-from-home application. + +Swarmlab provides you with all the required tools, tools to teach work or try out demos in a completely virtual environment. + +Swarmlab is a collection of services that aims to: + +- provide teachers and professors with online remote tools to do their lessons + +- give students the opportunity to study real life examples in their chosen area of expertise + +- allow developers to fully test and debug their applications and provide POC’s + +Swarmlab, up and running since 2020, is already used for teaching purposes in a university and has proven itself as a powerful tool in the post covid remote-based situation. -## How? -How does Swarmlab Hybrid differ from Swarmlab? Well...its Swarmlab...just....HYBRID! -Easy enough right? But what does that mean in practice? -Well for us it means a couple million more lines of code. For you it means a few more installation steps and the newfound access to YOUR OWN RESOURCES! +Source code is available at https://git.swarmlab.io:3000 under the AGPL licence. -You will be connected to the Swarmlab Cloud (hence HYBRID) but you will be able to use your own storage(move files around, delete/copy etc),your own networking and computational power(cpu/graphics etc) and create a system exactly the way you need it. -This way you will be able to : -- create images for testing. -- Run them using docker. -- Share them for others to use and develop. -- Finally browse the cloud for shared images to integrate into your project and make it even better. +### Ready to run out-of-the-box -## Ready to run out-of-the-box +As of now the services provided by swarmlab are: -Normally the docker dataflow is as described in the following images: +- Labrooms(virtual classrooms in the form of model applications to be tweaked at will) - - + - linux → base linux system – designed for use as a base to further develop your app -To make the service easier to use we have created an ever-growing database of readilly accessible images you can choose from, thus making the first step optionall! + - MPI → Instances of Ubuntu Linux with MPICH — portable implementation of Message Passing Interface (MPI) standard. Designed for MPI program development and deployment. -## Swarmlab vs Swarmlab Hybrid in a nutshell + - Node.js -### Swarmlab + - sec → a basic linux-based os with security tools – designed as a template for apps -- Ready to use, on demand virtual labs -- Optimized for both Students and Tutors -- Tutors bootstrap their labrooms using our tools +- Storage to automatically create a cluster of databases. + +- Proof Of Concept (POC) options + + - datacollector → using provided services a fully developed application may collect data from a swarm and use it for further analysis + +- Microservices + + - Jupyter + + - numpy + + - scipy + + - nodejs + + - nginx + + - haproxy + + - gns3 + + - wireshark + + - snmpsim + + - xelatexthesis + + - ansible + + - etherpad + + - codeserver (vscode) + + - redisserver + + - mongoserver + + - mongoclient (GUI) + to be continued… -### Hybrid -- Create Labrooms/Applications -- Run and manage said rooms and application -- create once - scale up or down without rebuilding -- Connect multiple computers through a network. -- Move Labs between environments -- Create your own labs -- open source barebone -> Share them with your friends -### In any case students can: -- join the created labrooms according to their interrests -- run the evailable labs at will -- create their own rooms for exercising -## IMPORTANT -:exclamation: If you wish to use the service in Hybrid mode, that is if you want to share, download or perform other activites on the cloud you will need a KEY. Read installation instructions to learn how to do that. -Local usage of the service doesnt require one, you only need to log in to your account. ## System requirements