diff --git a/docs/modules/venus/pages/deploy.adoc b/docs/modules/venus/pages/deploy.adoc index 736812c..a2ba7c6 100644 --- a/docs/modules/venus/pages/deploy.adoc +++ b/docs/modules/venus/pages/deploy.adoc @@ -8,7 +8,7 @@ Swarmlab :experimental: -This is the area where you will quide you to Build the network pou theleis +This is the area where we will guide you to build the network you require == Deploy @@ -21,12 +21,12 @@ We can *create* the network by using the btn:[Create Network] button To start, we need to have a Network Stack Name -This will bring up all the services, volumes, networks and everything else +This will contain all the services, volumes, networks and everything else in an isolated environment. === Name -A name or something that gives the subject of your project. +A name that describes your network. === Start and End Time @@ -61,6 +61,8 @@ image::venus:manage-deploy-showusers.png[manage user,700,float=center] and then the buttons above to add or remove the certain user whe want using the btn:[action] button +ATTENTION: YOU WILL HAVE TO ADD YOURSELF MANUALY!!! + == Video === Create Network diff --git a/docs/modules/venus/pages/join.adoc b/docs/modules/venus/pages/join.adoc index 6e4eb81..22d4d86 100644 --- a/docs/modules/venus/pages/join.adoc +++ b/docs/modules/venus/pages/join.adoc @@ -8,11 +8,11 @@ Swarmlab :experimental: -This is the area where you will quide you to Join the network pou theleis +This is the area where we will guide you to Join the network you desire == Browse -You can easily browse throught the available *labrooms* in the list using the search bar at the top. +You can easily browse throught the available *networks* in the list using the search bar at the top. .browsing network image::venus:join.png[Browsing network,700,float=center] @@ -31,33 +31,31 @@ image::venus:join-info.png[network info,700,float=center] To request network access we use the btn:[Request Access] button -TIP: To button emfanisete mono otam den to echeis kanei idi pou simeni oti ama to kaneis mia fora den tha emfanistei +TIP: the button is only visible if youre NOT already connected! == Connect image:venus:join-status.png[network connect,300,float=right] -afou kanete request kai sas dechti o owner tha emanistoun accept icons dipla sto network pou thelete kai stin antistichi stili +After requesting access and it being granted by the owner we will be able to see the accept icon. +when this icon appears it meant we are ready to use the network using the btn:[Start Network] button -meta apo afto mporeite na chrissimopiisete to btn:[Start Network] button +obviously the network has to be up and running -fysika kai prepei prota to network na einai up and running +the *join* column informs us about our connection status -sto column *join* mporeite na deite an iste sindedemnoi idi sto diktyo i ochi +TIP: we can connect as many networks as we please -TIP: mporeite na sindethite se osa diktya thelete +=== connect mode - -=== connect modus - -.connect modus +.connect mode image::venus:join-connect-mode.png[connect modus,700,float=center] The *host* option is used to make the interface look like they are running on the host itself -The *container* option containerize the containers networking +The *container* option containerizes the containers networking ==== host @@ -66,9 +64,9 @@ image:venus:host-connection.png[host connect,350,float=right] It allows the Virtual Network Interface greater network access than it can normally get. -If you use host then you’ll get all ports listening on the host. +If you use 'host' then you’ll get all ports listening on the host. -This means you will need to check the services you runninf closely (especially if it’s not yours, e.g. an official one provided by a software project) to make sure you don’t inadvertently expose extra services on the network. +This means you will have to monitor the services you run closely (especially if it’s not yours, e.g. an official one provided by a software project) to make sure you don’t inadvertently expose extra services to the network. TIP: With this option you *can* access the other participants in the network and vice versa from your computer @@ -76,7 +74,7 @@ TIP: With this option you *can* access the other participants in the network and image:venus:container-connection.png[container connect,350,float=right] -A container option is used to isolate the services from different container and the host itself +A container option is used to isolate the services from the outside world TIP: With this option you can *NOT* access the other participants in the network and vice versa from your computer @@ -85,16 +83,16 @@ TIP: With this option you can *NOT* access the other participants in the network .connect status image::venus:join-connect-status.png[connect status,700,float=center] -after connecting vlepoume +after connecting we will be seing something along the following: -* to status sto collumn *join* -* emfanisete to btn:[Leave Network] button, to opoio mporoume na to chrissimopiisoume gia na kanoume disconnect -* stin grammi *Interface* emfanisete to onoma tou interface kai i ean einai up i down -* stin grammi *Network* emfanisete to onoma tou interface pou dimiourgithike +* our status in the *join* column +* the btn:[Leave Network] button we can use to disconnect +* the *Interface* name and whether it is up or down +* the creted *Network*(interface) name === connect info -tis parapano plirofories tis pernoume epissis using the btn:[Service Info] button +all of the above information is also accessible using the btn:[Service Info] button .connect status info image::venus:join-connect-status-info.png[connect status info,700,float=center] @@ -103,7 +101,7 @@ image::venus:join-connect-status-info.png[connect status info,700,float=center] image::venus:join-connect-status.png[connect status,700,float=center] -* sto parapanp image vlepoume to btn:[Leave Network] button, to opoio mporoume na to chrissimopiisoume gia na kanoume disconnect +* the btn:[Leave Network] button -> use it to disconnect == Video diff --git a/docs/modules/venus/pages/overview-network.adoc b/docs/modules/venus/pages/overview-network.adoc index 7332699..1c536f6 100644 --- a/docs/modules/venus/pages/overview-network.adoc +++ b/docs/modules/venus/pages/overview-network.adoc @@ -6,7 +6,7 @@ Swarmlab :!table-caption: :page-pagination: -This is the area where you will quide you to Build the network or Join one +This is the area where we will guide you to create a network or join an existing one == Deploy diff --git a/docs/modules/venus/pages/overview-share.adoc b/docs/modules/venus/pages/overview-share.adoc index 5238ca2..13ec10b 100644 --- a/docs/modules/venus/pages/overview-share.adoc +++ b/docs/modules/venus/pages/overview-share.adoc @@ -6,7 +6,7 @@ Swarmlab :!table-caption: :page-pagination: -This is the area where you will quide you to share app and volume +This is the area where you can share your apps or your volumes. == App diff --git a/docs/modules/venus/pages/share-app.adoc b/docs/modules/venus/pages/share-app.adoc index a03ee5a..aa5c6f0 100644 --- a/docs/modules/venus/pages/share-app.adoc +++ b/docs/modules/venus/pages/share-app.adoc @@ -8,16 +8,16 @@ Swarmlab :experimental: -This is the area where you will quide you to share you app +This is the area where we will guide you to share you app == browse apps .share app image::venus:share.png[share app,700,float=center] -sto menou vlepoume ta apps (Instanches) have running prin messo hybrid +The menu shows the instances that are running (we have started them beforehand using swarmlab hybrid) -edo loipon mporoume na epilexoume poia apo afta theloume na kanoume share +Now we can choose the ones we want to share. === app info @@ -31,42 +31,41 @@ image::venus:share-info.png[app info,700,float=center] === share app -To share you app we use the btn:[share] +To share an app we use the btn:[share] button .browsing network image::venus:share-networks.png[browse network,700,float=center] -kato apo to btn:[share] emfanisonte ta diktya pou imaste sindedemnoi +Underneath the btn:[share] we can see all the networks we are connected to -epilegoume to diktyo ekeiono pou theloume gia na diamirasoume to app +We now choose the one over which we would like to share the app. === share status .share status image::venus:share-networks-info.png[browse network,350,float=right] -TIP: mporoume na doume to status me to btn:[shared], otan den einai shared emfanisete to button btn:[network] +TIP: we can see our status using the btn:[shared], when the app is shared the btn:[network] button will appear. == share info .share info image::venus:share-app-info.png[share info,350,float=right] -me to btn:[info] mporoume na doume plirofories sxetika me to app pou kaname share +the btn:[info] shows information about the shared app -* to url p.x. pou mporoume na diamirasoume stous users -* to url pou mporoume emeis i idioi na sindethounme +* the "public" that we can share to other users +* the private url we can use to connect ourselves - -TIP: mporoume na doume oti emeis chrissimopioume tin address tou eth0 pou einai sindedemnei me to pc mas +TIP: for example we can see that we are using eth0 and we can also see the ip address. [source,bash] ---- http://172.26.0.2:8888/lab?token=819cfaa82577cc7ec49fec0a39f57bc12e37883119237cf3 ---- -eno stous stous users prepei na stiloume to linkl pou vlepoume sto *URL to send to participants* +The following is the link the users have to use. [source,bash] ---- @@ -75,12 +74,12 @@ http://10.1.2.67:8888/lab?token=819cfaa82577cc7ec49fec0a39f57bc12e37883119237cf3 == undo share -To undo the share pou kaname we use the btn:[Default] button +To stop sharing we can use the btn:[Default] button .share default info image::venus:share-info-default.png[share default info,350,float=right] -TIP: mporoume na doume to status me to btn:[shared], otan den einai shared emfanisete to button btn:[network] +TIP: we can again check the status using the btn:[shared], when shared, the btn:[network] button will appear. == Video @@ -96,7 +95,7 @@ video::565627934[vimeo] === Revoke access to shared **** -TIP: Learn how to revoke access to a shared +TIP: Learn how to revoke access to a shared app video::565635682[vimeo] **** diff --git a/docs/modules/venus/pages/share-volume-connect.adoc b/docs/modules/venus/pages/share-volume-connect.adoc index affa932..6ce8a41 100644 --- a/docs/modules/venus/pages/share-volume-connect.adoc +++ b/docs/modules/venus/pages/share-volume-connect.adoc @@ -8,79 +8,79 @@ Swarmlab :experimental: -This is the area where you will quide you to connect volumes +This is the area where you will learn to connect volumes == connect -shared volumes apo Users info tha paroume we using the image:venus:volume-more.png[] icon +As usual we can get info using the image:venus:volume-more.png[] icon .connect volume image::venus:volume-shared-info.png[Volume shared info,700,float=center] -TIP: oi plirofories emfanisonte gia to diktyo pou tha epilexoume (sto top-left menou) kai oxi gia ola ta diktya. +TIP: to get info about a network we first have to select it -gia na kaneis volume connect we using the image:hybrid:more.png[] icon +to connect to a volume we use the image:hybrid:more.png[] icon -tha emfanistei to akoloutho menou +we will be greeted by the following: .connect volume image::venus:volume-connect.png[Volume connect,700,float=center] -kanoume apla click stp btn:[Connect_to] button +here we can just click the btn:[Connect_to] button -meta apo afto to volume pou ekanes connect tha emfanistei sto menou *My Connections on Shared volumes* +Our volume should be visible under *My Connections on Shared volumes* -WARNING: echoume kanei connect ston server me afti tin kinissi kai ochi ston katalogo +WARNING: this step ONLY initialized the server connection and not the actual file system === Connect info -plirofories sxetika me to connect pou kaname vlepoume sto menou +information about what we just did can be found in the menu .volume info image::venus:volume-connect-info.png[Volume connect info,700,float=center] -TIP: sto icon image:venus:volume-mount-no.png[] vlepoume ean exoume kanei mount ston katalogo i oxi +TIP: the image:venus:volume-mount-no.png[] icon tells us if the file system dir is mounted or not === mount -we using the +we use the image:venus:volume-mount-no.png[] icon === umount -we using the +we use the image:venus:volume-mount-yes.png[] icon === mount info -gia na vreis to directory pou echeis kanei share we use the image:venus:volume-info-icon.png[] icon +to locate the shared directory wew use the image:venus:volume-info-icon.png[] icon -pou mporeis na vreis sto menou *My Connections on Shared volumes* kai dipla sto antisticho volume pou theeis na kaneis info +This can be found under *My Connections on Shared volumes* and next to the corresponding volume -o katalogos p.x. sto paradeigma tha einai tou styl +e.g. the dir in the example is [source,bash] ---- /data/appl/ok/swarmlab-venus/src-local/hybrid/connect/dLZWqFyPxyxOL1DiJ3xCHJhi6ziLK7MJ/volumes_client/dLZWqFyPxyxOL1DiJ3xCHJhi6ziLK7MJ_volumename ---- -se afto mporeite na valete oti archeio thelete na diamoirasete +here we can place any files we want to share -TIP: to parapano doulevi mono otan vlepoum this icon image:venus:volume-mount-yes.png[] +TIP: This only works as long as the image:venus:volume-mount-yes.png[] is visible. == disconnect -gia na kaneis disconnect we using the image:venus:volume-delete-icon.png[] icon +to disconnect we use the image:venus:volume-delete-icon.png[] icon -pou mporeis na vreis sto menou *My Connections on Shared volumes* kai dipla sto antisticho volume pou theeis na kaneis info +that can be found in the *My Connections on Shared volumes* menu and next to the corresponding entry. -TIP: me to disconnect svinete i sindessi pou ekanes share kai ochi ta dedomena pou echeis sto antisticho directory +TIP: When disconnecting, only the connection is terminated and the actual data remains untouched. == Video diff --git a/docs/modules/venus/pages/share-volume-share.adoc b/docs/modules/venus/pages/share-volume-share.adoc index ff7cb9e..7e32263 100644 --- a/docs/modules/venus/pages/share-volume-share.adoc +++ b/docs/modules/venus/pages/share-volume-share.adoc @@ -8,7 +8,7 @@ Swarmlab :experimental: -This is the area where you will quide you to share volumes +This is the area where we will guide you to share volumes == share @@ -17,57 +17,57 @@ image::venus:volume-left.png[Volume menou,700,float=center] === create -gia na kaneis volume share we using the image:venus:volume-share-icon.png[] icon +To share a volume we will be using the image:venus:volume-share-icon.png[] icon -tha emfanistei to akoloutho menou +and be greeted by the following menu: .create volume image::venus:volume-create.png[Volume create,700,float=center] -dose onoma kai rights kai pata to btn:[Create Volume] button +Please choose a name before clicking on the btn:[Create Volume] button -meta apo afto to volume pou ekanes share tha emfanistei sto menou *My shared Volumes* +You can now locate the volume under *My shared Volumes* .volume info image::venus:volume-info.png[Volume create info,700,float=center] === Directory info -gia na vreis to directory pou echeis kanei share we use the image:venus:volume-info-icon.png[] icon +To locate the shared directory we can use the image:venus:volume-info-icon.png[] icon -pou mporeis na vreis sto menou *My shared Volumes* kai dipla sto antisticho volume pou theeis na kaneis info +This is located under the *My shared Volumes* and next to the corresponding volume. .volume directory info image::venus:volume-create-info.png[Volume dir info,700,float=center] -o katalogos p.x. sto paradeigma tha einai tou styl +e.g. the dir from the example is [source,bash] ---- /data/appl/ok/swarmlab-venus/src-local/hybrid/connect/dLZWqFyPxyxOL1DiJ3xCHJhi6ziLK7MJ/volumes/dLZWqFyPxyxOL1DiJ3xCHJhi6ziLK7MJ_myvolume ---- -se afto mporeite na valete oti archeio thelete na diamoirasete +here we can drop any file we would like to share === delete -gia na kaneis delete we using the image:venus:volume-delete-icon.png[] icon +To delete we can simply use the image:venus:volume-delete-icon.png[] icon -pou mporeis na vreis sto menou *My shared Volumes* kai dipla sto antisticho volume pou theeis na kaneis delete +again found under the *My shared Volumes* menu and next to the corresponding volume. .volume info image::venus:volume-info.png[Volume create info,700,float=center] -TIP: me to delete svinete i sindessi pou ekanes share kai ochi ta dedomena pou echeis sto antisticho directory +TIP: deleting a volume only terminates the connection and DOES NOT delete the stored data. == shared volume info -me to pou tha kaneis shared opos perigrafete parapano tha emfanistei sto menou *Shared volumes* +After sharing a volme it will be available under the *Shared volumes* menu .shared volume info image::venus:volume-shared-info.png[Volume shared info,700,float=center] -TIP: stous users tha emfanistei antisticha i idia pliroforia. me tou pou tha epilexoun fysika na doun tis sxetikes plriofories tou diktyou +TIP: other users that look for your network will also have the above info == Video @@ -83,7 +83,7 @@ video::565647143[vimeo] === Remove Shared volume **** -TIP: Learn how to remove a shared +TIP: Learn how to remove a shared volume video::565659724[vimeo] **** diff --git a/docs/modules/venus/pages/share-volume.adoc b/docs/modules/venus/pages/share-volume.adoc index 65581d5..4bd7e9a 100644 --- a/docs/modules/venus/pages/share-volume.adoc +++ b/docs/modules/venus/pages/share-volume.adoc @@ -8,7 +8,7 @@ Swarmlab :experimental: -This is the area where you will quide you to share and connect to volumes +This is the area where we will guide you to share and connect to volumes == main menou @@ -24,19 +24,19 @@ on the left mporoume na doume volumes pou kanete eseis share image::venus:volume-left.png[Volume menou,700,float=center] -sto menou *Virtual networks* sto pano meros vlepoume ta diktya sta opoia imaste connect +Using the *Virtual networks* menu we can identify all the networks we are connected to. -sto menou *My shared Volumes* sto kato meros vlepoume ta volumes pou kaname share +Using the *My shared Volumes* menu we can locate all the volumes that we have shared. -TIP: plirofories gia to kathe network echoume when we use the image:venus:volume-more.png[] icon +TIP: For more info we can always use the image:venus:volume-more.png[] icon == shared from others -sta dexia mporoume na doume voumes pou ginonte shared apo sindedemneous users +To the right we can find the volumes that other connected users have shared. -kai ep[issi sto kato meros se poia apo afta iste sindedemnos idi +and also see if we are already connected to them or not. .volume from others image::venus:volume-right.png[Volume others,700,float=center] -TIP: oi plirofories emfanisonte gia to diktyo pou tha epilexoume (sto top-left menou) kai oxi gia ola ta diktya. gia na paroume aftes afta ta info we using the image:venus:volume-more.png[] icon +TIP: the info provided belongs to the selected network. If you wish to get info about another network just select it.