diff --git a/thesis/source/docs/4_progetto/index.rst b/thesis/source/docs/4_progetto/index.rst index 29f37f9..3760e27 100644 --- a/thesis/source/docs/4_progetto/index.rst +++ b/thesis/source/docs/4_progetto/index.rst @@ -159,7 +159,7 @@ Il modulo backend consiste in una web :abbr:`API (application programming interf È scritto in `Python`, usando `Poetry` e le librerie `Django`, `Django REST Framework` e `Docker SDK for Python`, descritte nei prossimi paragrafi. -Esso è **eseguito dal server** sul quale si desidera ospitare Sophon. +Esso è **eseguito dal server** sul quale è ospitato Sophon. .. index:: @@ -307,6 +307,7 @@ Fa inoltre abbondante uso della capacità dei linguaggi dinamici di definire fun (animale) => animale.verso() ); + .. index:: single: Node.js single: npm @@ -394,7 +395,7 @@ Si basa sul concetto di *componenti*, piccole parti incapsulate di interfaccia g ); } -È stata scelta per l'utilizzo in Sophon in quanto permette la realizzazione di interfacce grafiche molto complesse attraverso codice di facile comprensione, rendendo possibile la creazione di un'interfaccia altamente `intuibile `. +È stata scelta per l'utilizzo in Sophon in quanto permette la realizzazione di interfacce grafiche molto complesse attraverso codice di facile comprensione, rendendo possibile la creazione di un'interfaccia interattiva ed `intuibile `. .. index:: @@ -429,7 +430,30 @@ Bluelib Modulo proxy ------------ -.. todo:: Modulo proxy +Il *modulo proxy* consiste in un web server che permette di accedere al `modulo backend `, ai `moduli Jupyter ` e a una versione preconfigurata del `modulo frontend `. + +È stato realizzato configurando `Apache HTTP Server` in modo che effettuasse dinamicamente `reverse proxying ` verso gli altri moduli basandosi su una rubrica aggiornata dal backend. + +Viene **eseguito dal server** sul quale è ospitato Sophon. + +.. index:: + pair: reverse; proxy + +Reverse proxy +^^^^^^^^^^^^^ + +Il *reverse proxying* è un'operazione effettuabile dai web server per permettere l'accesso controllato ad altri web server collocati su una rete interna attraverso l'inoltro di pacchetti. + +Frequentemente, il reverse proxying viene utilizzato per "aggiungere" l'HTTPS a un web server disponibile solo in HTTP, o per disambiguare tra più web server che devono essere accessibili allo stesso indirizzo IP ma con nomi di dominio diversi. + +In un'installazione predefinita di Sophon, il reverse proxying effettuato è duplice: + +* il server web della macchina host riceve richieste HTTPS e le inoltra in HTTP al server web del `modulo proxy `; +* il server web del modulo proxy riceve richieste HTTP che inoltra ai vari moduli in base al valore dell'header ``Host`` della richiesta ricevuta. + +.. figure:: proxy.png + + Schema del reverse proxying di Sophon. .. index:: @@ -440,7 +464,23 @@ Modulo proxy Apache HTTP server ^^^^^^^^^^^^^^^^^^ -.. todo:: Apache HTTP server +`Apache HTTP Server `_, comunemente chiamato anche *httpd* o *apache2*, è uno dei tre webserver "general purpose" più comunemente usati al mondo. + +Ha una struttura a moduli, che forniscono funzionalità aggiuntive, ed è configurabile tramite uno o più file ``.conf`` aventi sintassi come la seguente: + +.. code-block:: apacheconf + + # Questa è un'istruzione globale. + Bind 80 + + # Questo è un blocco di istruzioni ristretto a un contesto specifico. + + ServerName "ilmiosophon.it" + ServerAlias "*.ilmiosophon.it" + + RewriteEngine On + RewriteRule ^(.*)$ https://%{HTTP_HOST}$1 [R=301,L] + .. index:: @@ -450,7 +490,11 @@ Apache HTTP server Modulo Jupyter -------------- -.. todo:: Modulo backend +Il *modulo Jupyter* consiste in una versione preconfigurata di `Jupyter` pronta per essere istanziata dal `modulo backend `. + +Tanti moduli Jupyter possono esistere contemporaneamente su Sophon: ne viene creato uno per ogni `notebook computazionale ` gestito dal modulo backend. + +Viene **eseguito dal server** sul quale è ospitato Sophon. .. index:: @@ -459,7 +503,7 @@ Modulo Jupyter Containerizzazione ================== -.. todo:: Containerizzazione +Al fine di facilitare l'installazione e di migliorare la `sicurezza ` dell'applicazione, si è stabilito di costruire `container ` `Docker` per tutti i moduli di Sophon. .. index:: @@ -468,7 +512,25 @@ Containerizzazione Docker ------ -.. todo:: Containerizzazione +`Docker `_ è un software che permette di eseguire applicazioni all'interno di `container ` isolati dal resto del sistema, in maniera simile all'esecuzione di macchine virtuali, ma **condividendo il kernel** con la macchina host. + +È composto da due parti, `Docker Engine` e `Docker Compose`, e prevede varie astrazioni, quali le `immagini `, i `container `, i `network ` e i `volumi `. + + +.. index:: + single: image + single: immagine + single: Docker; image + single: Docker; immagine + +Immagini +^^^^^^^^ + +Le *immagini* Docker sono sequenze di regole e insiemi di file per la creazione di un `container `, tipicamente partendo da un altro container come base. :cite:`docker:overview` + +Utilizzano un filesystem copy-on-write a strati: vengono registrate all'interno dell'immagine solamente le modifiche che ogni regola ha apportato al filesystem interno, rendendo le immagini molto più leggere di quanto lo sarebbero se dovesse essere salvato tutto il disco virtuale. + +Possono essere comparate a immagini di macchine virtuali con tanti "punti di ripristino". .. index:: @@ -478,7 +540,9 @@ Docker Container ^^^^^^^^^ -.. todo:: Container +I *container* Docker sono istanze di `immagini ` che possono essere eseguite dal `Docker Engine` :cite:`docker:overview`. + +Sono l'equivalente di un'intera macchina virtuale, che può essere avviata o arrestata. .. index:: @@ -488,7 +552,11 @@ Container Network ^^^^^^^ -.. todo:: Network +I *network* Docker sono astrazioni per vari tipi di reti di calcolatori: in particolare, essi permettono di collegare vari `container ` ad una rete locale virtuale, permettendone l'interazione :cite:`docker:networking`. + +All'interno di un network è disponibile una funzionalità di risoluzione automatica degli indirizzi IP virtuali dei container: per accedere al container ``pear`` in HTTP, ad esempio, sarà sufficiente utilizzare ``apple`` come se fosse un nome di dominio: ``http://pear/``. + +Sono una versione più potente dei moduli di rete per macchine virtuali. .. index:: @@ -498,7 +566,22 @@ Network Volumi ^^^^^^ -.. todo:: Volumi +I *volumi* Docker sono astrazioni per filesystem che permettono la condivisione di file tra container :cite:`docker:volumes`. + +Essi vengono montati all'interno di un container in una cartella configurabile detta *mount point*; tutti i container con accesso al volume vedranno gli stessi file all'interno di essa. + +Sono il parallelo delle immagini disco delle macchine virtuali. + + +.. index:: + single: Docker; Engine + +Docker Engine +------------- + +`Docker Engine `_ è il daemon che si occupa della gestione di `immagini `, `container `, `network ` e `volumi `. + +Astrae la piattaforma su cui viene eseguito, in modo che tutte le immagini possano essere eseguite su Linux come su Windows o Mac OS X. .. index:: @@ -507,7 +590,41 @@ Volumi Docker Compose -------------- -.. todo:: Containerizzazione +`Docker Compose `_ è uno strumento da linea di comando che permette l'esecuzione di applicazioni Docker composte da tanti container. + +Le applicazioni Compose sono definite all'interno di un file `YAML `_ come il seguente: + +.. code-block:: yaml + + version: "3.9" + + # Elenco dei volumi dell'applicazione + volumes: + db-data: + + # Elenco dei network dell'applicazione + networks: + main: + + # Elenco dei container dell'applicazione + services: + db: + # Immagine del container + image: postgres + # Mount point dei volumi del container + volumes: + - db-data:/var/lib/postgresql/data + # Network del container + networks: + - main + + app: + image: my-app-image + networks: + - main + # Container richiesti da questo container + depends_on: + - db .. index:: diff --git a/thesis/source/docs/4_progetto/proxy.png b/thesis/source/docs/4_progetto/proxy.png new file mode 100644 index 0000000..95825dd --- /dev/null +++ b/thesis/source/docs/4_progetto/proxy.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9034f4e6daea84257bb8401a70f0c87fdbb46dbf9cf0186bc1a5be44e727e4b4 +size 165848 diff --git a/thesis/source/refs.bib b/thesis/source/refs.bib index a57b65a..f4017e1 100644 --- a/thesis/source/refs.bib +++ b/thesis/source/refs.bib @@ -38,7 +38,6 @@ jupyter:collaboration, note = {Accessed: 2021-11-18}, } - @misc{ enwiki:993314047, author = {English Wikipedia}, @@ -63,3 +62,27 @@ so:survey2021, howpublished = {https://insights.stackoverflow.com/survey/2021}, note = {Accessed: 2021-11-20}, } + +@misc{ +docker:overview, + author = {Docker}, + title = {Overview}, + howpublished = {https://web.archive.org/web/20211121165850/https://docs.docker.com/get-started/overview/}, + note = {Accessed: 2021-11-21}, +} + +@misc{ +docker:networking, + author = {Docker}, + title = {Networking overview}, + howpublished = {https://web.archive.org/web/20211111155419/https://docs.docker.com/network/}, + note = {Accessed: 2021-11-21}, +} + +@misc{ +docker:volumes, + author = {Docker}, + title = {Use volumes}, + howpublished = {https://web.archive.org/web/20211121172749/https://docs.docker.com/storage/volumes/}, + note = {Accessed: 2021-11-21}, +} \ No newline at end of file