Before you have all of the powerfull tools of Swarmalb at your grasp you will have to create an account.
To do that navigate to the home page at https://api-client.swarmlab.io:8088
@@ -597,10 +538,11 @@ You should have been greeted by our login screen!
Now that your acount is ready, lets get to know Swarmlabs main page.
Once loaded the main page should look like this:
With that out of the way lets enter the heart of our platform, 'my lab'!
Nested under 'mylab' are both creation tools (bootstrap) and execution tools (run).
To create a lab instance simply add a repo to your git! First we have to select the lab we want to run. To find a specific lab we can use the search bar at the top. After we have located the desired lab we can run it by using the cloud icon. After we have located the desired lab we can run it by using the cloud icon. image::images/run/cloud_icon.png[]
You will then be able to locate that repo inside the instance list and run it.
@@ -686,7 +634,7 @@ For more info on this please refer to the Bootstrap chapter
-1.1.2. Running a lab instance
+4.1.2. Running a lab instance
@@ -696,10 +644,10 @@ For more info on this please refer to the Bootstrap chapter
-
To request more info about the lab we use the info icon 
and the trashcan 
deletes the lab (forever).
+
To request more info about the lab we use the info icon image::images/run/info_icon.png[] and the trashcan image::images/run/trash_icon.png[] deletes the lab (forever).
Carefull, forever is a long time!
This is the area where you will find the available labrooms created by tutors and join the desired one.
You can easily browse throught the available labrooms in the list using the search bar at the top.
You can get more info about a specific labroom by clicking the info button .
You can get more info about a specific labroom by clicking the info button image::images/run/info_icon.png[].
Once you have found the labroom you were looking for you can enter by simply clicking on the cloud icon .
Once you have found the labroom you were looking for you can enter by simply clicking on the cloud icon .
-You should see a screen as follows:
You should see a screen as follows:
Here you can join a meeting with your group (this will redirect you to a jitsi implementation).
For more visit https://jitsi.org/
This loads a graphic unix environment.
This loads a unix terminal.
@@ -840,7 +792,7 @@ To search for any public repo we can use the search bar.From that list we can now select the desired repository that we want to use by clicking on the plug icon. 
+
From that list we can now select the desired repository that we want to use by clicking on the plug icon. image::images/bootstrap/plug_icon.png[]
We can use any repo we like, but we will be able to commit only to those that we have access to.
If we wish to edit or contribute to the development of a project we are not part of we can use the clone option as usual!
Tutors have access to an extended 'my lab/bootstap' page where they can create labrooms from existing lab instances.
To do so we have to scroll all the way down whilst on the Bootstrap page.
-There we should find two menus, 'My labrooms' and 'Bootstrap Labroom'
-Here we can see a list of all the labrooms programmed to run today. Again like in the run tab we can distinguish open from closed ones by color (green/orange).
-We can also get info using the info icon or delete the labroom using the trashcan icon .
-To search for a specific labroom we can use the searchbar at the top.
| - - | -
-The delete command is FORCED even if the labroom is running!!! - |
-
Now lets see how we can bootstrap a new labroom using one of our lab instances.
-To do that lets navigate to the respective tab that should look like this:
-Here we can select the desired (existing!) lab instance that will be used to create the labroom using the plug icon .
-Then we have to specify starting date and time and also set the duration for which our lab room will be open.
-| - - | -
-You can only start a labroom every whole or half hour (p.e. 12.00 or 14.30) and never inbetween so please plan ahead!! -Also note that the duration cannot be greater than three hours since we consider that the maximum for any type of lesson! - |
-
Now using the searchbar that follows (you HAVE to search for students for them to come up) we search and select () the students that we want to invite to the lesson.
-Note that only students that have subscribed to our labroom will be available for invites to avoid confusion!
-After selecting all the desired students we have to fill in the last details at the bottom of the page.
-Please give concise titles and good descriptions to your labrooms!!
-Now we shall check and upon making shure that everything is right we click the 'bootstrap your lab' button!
-| - - | --Bootstraping is final and no further edits are allowed!! - | -
Architecture overview
-
Automated data availability and redundancy on IPFS.
-IPFS Cluster provides data orchestration across a swarm of IPFS daemons by allocating, replicating and tracking a global pinset distributed among multiple peers.
-It is being used for both tutors and students to publish content on a decentralized manner!
-Information will be auto-deleted after approximatelly 24 hours of not being used.
High Performance, cloud Native Object Storage.
Amazon’s S3 API is the defacto standard in the object storage world.
-MinIO is the defacto standard for S3 compatibility and was one of the first to adopt the API and the first to add support for S3 Select.
-More than 750 organizations, including Microsoft Azure, use MinIO’s S3 Gateway - more than the rest of the industry combined.
It is being used for both tutors and students to save content on a centralized manner!
-Information storage is permanent.
MariaDB Galera Cluster is a virtually synchronous multi-master cluster for MariaDB.
-Provide Active-active multi-master topology.
Used for user/admin authorization and authentication.
-MongoDB is a document database designed for ease of development and scaling.
-Used for labroom and swarmlab services administration and scheduling.
ShareDB is a realtime database backend based on Operational Transformation (OT) of JSON documents
-Slim is a PHP micro framework that helps you quickly write powerful APIs.
-Used for main api of swarmlab.io
-Slim was used for a fast and powerful router that maps route callbacks to specific HTTP request methods and URIs.
Nodejs is an asynchronous event-driven JavaScript runtime, Node.js is designed to build scalable network applications.
-Used for event-driven programming and for Sockets and WebSockets.
-Vue is a progressive JavaScript framework for building user interfaces.
-It is designed from the ground up to be incrementally adoptable, and can easily scale between a library and a framework depending on different use cases.
-It consists of an approachable core library that focuses on the view layer only, and an ecosystem of supporting libraries that helps you tackle complexity in large Single-Page Applications.
-Used for the main user interface of swarmlab.io.
Python is an interpreted, high-level, general-purpose programming language.
-Python’s design philosophy emphasizes code readability with its notable use of significant whitespace.
-Its language constructs and object-oriented approach aim to help programmers write clear, logical code for small and large-scale projects.
-Used along with ansible for maintenance and administration of the machines making up the cluster of swarmlab.io.
-se sinrgasia me tin ansible gia tin diachirissi ton michanon
PHP is a popular general-purpose scripting language that is especially suited to web development.
-Fast, flexible and pragmatic, PHP powers everything from your blog to the most popular websites in the world.
Used with slim for creation of the main API.
-CodeMirror is a versatile text editor implemented in JavaScript for the browser.
Used for the online editors for interraction with tutors and students.
OAuth 2.0 is the industry-standard protocol for authorization.
-OAuth 2.0 focuses on client developer simplicity while providing specific authorization flows for web applications, desktop applications, mobile phones, and living room devices.
-This specification and its extensions are being developed within the IETF OAuth Working Group.
This protocol is being used for the connection of users and services.
Docker provides the ability to package and run an application in a loosely isolated environment called a container.
Used for all the services implementations.
Compose is a tool for defining and running multi-container Docker applications.
-Used for development, configuration and testing of the services before deployment to the swarm.
A lot of bash scripting was used (low-level) tasks concerning the Linux operating system.
-Ansible is an open-source software provisioning, configuration management, and application-deployment tool.
Used for administration of the machines of the general cluster of swarmlab.io as well as its subclusters.
Open Source Identity and Access Management
Used as backend for authentication to provide secure services in our sso implementation.
Docker swarm is a container orchestration tool, its allow to manage multiple containers deployed across a cluster.
Used for orchestration of swarmlab.io services.
A self-hosted Git service used for the git-repo management used by students and tutors.
A secure, flexible, and completely free video conferencing.
Used for the online virtual meetings attended by students and tutors.
A open source VNC client - it’s is both a VNC client JavaScript library as well as an application built on top of that library.
-noVNC runs in any modern browser including mobile browsers (iOS and Android).
Used to access a unix graphic environment for the services provided through a normal browser.
Terminal over the web.
Used to access a unix command line for the services provided through a normal browser.