4. Progettazione di Sophon

Vista la situazione della ricerca collaborativa, si è ritenuto potesse essere utile sviluppare un'alternativa al progetto JupyterHub.

4.1. Requisiti del progetto

Si è stabilito che per essere un'alternativa valida, il progetto dovesse avere i seguenti requisiti:

estendibilità
security by default
interfaccia grafica facile ed intuitiva
maggiore possibilità di collaborazione
codice open source
possibilità di personalizzazione
accessibilità

Seguono descrizioni dettagliate dei requisiti elencati.

Estendibilità

Aggiungere nuove funzionalità al software deve essere facile, e non richiedere ristrutturazioni profonde del codice.

Inoltre, il software deve essere modulare, in modo da semplificare l'aggiornamento, la sostituzione e la eventuale rimozione di componenti.

Infine, il software deve esporre un'interfaccia alla quale altri software esterni possono connettersi per interagirvi come se fossero un utente.

Sicurezza

I dati immagazzinati all'interno del software devono essere protetti da acccessi non autorizzati.

Tentativi di ingannare gli utenti del software devono essere impediti, riducendo il fattore umano nelle falle di sicurezza.

Non si reputa importante impedire agli utenti di comunicare con Internet all'interno delle loro ricerche, in quanto si ritiene che essi siano utenti fidati; qualora ne sorga la necessità, ciò deve essere possibile senza ristrutturazione del codice.

Non si reputa nemmeno importante limitare le risorse utilizzate dai notebook in uso; deve però essere possibile implementare la funzionalità in futuro, se divenisse necessario.

Intuitività

Il modo in cui utilizzare l'interfaccia utente del software deve essere intuitiva per l'utente medio, senza che egli abbia bisogno di leggere alcuna guida o manuale.

A tale scopo, l'interfaccia grafica deve utilizzare design patterns comuni e familiari all'utente medio.

In aggiunta, i dettagli implementativi devono essere nascosti all'utente, in modo che possa concentrarsi sull'utilizzo del software.

Personalizzabilità

Il software deve permettere all'utente di personalizzare il suo workflow senza alcuna limitazione, che ciò venga fatto tramite plugin, configurazioni speciali o modifica di file dell'ambiente di lavoro, assicurando che i workflow personalizzati di un utente non possano interferire con quelli degli altri.

Inoltre, il software deve inoltre permettere all'amministratore di personalizzare nome e aspetto mostrati agli utenti nell'interfaccia grafica, in modo che essa possa essere adattata al brand dell'istituzione che utilizza il progetto.

Possibilità di collaborazione

Il software deve permettere agli utenti di collaborare sui notebook in tempo reale, come all'interno dei web-based editor.

Devono essere facilitate le interazioni tra utenti, al fine di ridurre errori e incomprensioni tra essi.

Open source

Il software deve essere interamente open source.

In pieno spirito collaborativo, il codice sorgente deve essere liberamente consultabile, modificabile, utilizzabile e condivisibile, sia per soddisfare la curiosità degli utenti, sia per permetterne lo studio e il miglioramento.

Tutte le modifiche al codice sorgente devono essere rese disponibili agli utenti del software modificato, in modo che possano verificare l'affidabilità del software che utilizzano.

Responsività

Il software deve essere utilizzabile su schermi di dimensione ridotta, come quelli di un cellulare.

Pertanto, gli elementi dell'interfaccia devono essere disposti in modo tale da permetterne la visualizzazione corretta su schermi di qualsiasi dimensione e risoluzione.

Accessibilità

Il software deve essere utilizzabile da qualsiasi tipologia di utente, inclusi utenti con disabilità visive e motorie.

Deve essere quindi possibile utilizzare il software interamente da tastiera, senza dover ricorrere a un mouse.

Inoltre, i colori dell'interfaccia grafica devono essere scelti favorendo l'accessibilità degli utenti daltonici.

4.2. Separazione in moduli

Per realizzare il requisito dell'estendibilità, si è scelto di separare le parti dell'applicazioni in 4 diversi moduli interagenti.

../../_images/diagram_modules.png — Figura 4.2.1 Schema che mostra come interagiscono tra loro i moduli di Sophon.

Modulo backend

Il modulo backend consiste in una web API che si interfaccia con il database e i moduli Jupyter, permettendo un accesso controllato alle risorse del software.

È 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 è ospitato Sophon.

Python

Python è un linguaggio di programmazione orientato agli oggetti interpretato con tipizzazione dinamica forte, particolarmente popolare negli ambiti dello sviluppo web e data science.

Ha numerosissime librerie (dette packages), sia incluse nella distribuzione base del linguaggio, sia disponibili per il download sul Python Package Index.

La sua sintassi è semplice ed human-friendly, come è possibile vedere dal seguente frammento di codice:

class Animale:
   def verso():
      raise NotImplementedError()

class Cane(Animale):
   def verso():
      print("Woof!")

class Gatto(Animale):
   def verso():
      print("Miao!")

zoo = [
   Cane(),
   Gatto(),
   Cane(),
]

for animale in zoo:
   animale.verso()

La sua semplicità e l'enorme quantità di librerie a disposizione lo ha reso il secondo linguaggio di programmazione più popolare al mondo [so:survey2021], subito dopo JavaScript; proprio per questi motivi è stato scelto per lo sviluppo del modulo backend.

Poetry

Per gestire le dipendenze di Sophon si è scelto di usare Poetry, un innovativo package manager per il linguaggio Python.

Poetry è in grado di risolvere automaticamente alberi complessi di dipendenze, generando un lockfile (poetry.lock) con la soluzione adottata, in modo che le dipendenze utilizzate siano congelate e uguali per tutti gli ambienti in cui deve essere sviluppato Sophon.

Django

Django è un framework Python per lo sviluppo di siti web dinamici.

Fornisce una suite di strumenti che assistono nella creazione di siti di medie dimensioni, come un ORM per i database, una pagina di amministrazione integrata per la gestione dei contenuti del sito e un sistema di moduli scollegabili detti "app".

Le pagine restituite vengono definite attraverso funzioni, dette function-based views, o attraverso classi, dette class-based views, che ricevono in input la richiesta effettuata dall'utente ed restituscono in output la risposta HTTP da inoltrargli.

È stato scelto per la realizzazione del modulo backend in quanto presentato al corso di Tecnologie web di Unimore, e in quanto contenente tutte le funzionalità necessarie per la realizzazione del progetto del sito.

Django REST Framework

Django REST Framework è un'estensione per Django che aggiunge la possibilità di inserire REST API all'interno delle applicazioni Django.

Permette di definire metodi dell'API in modo molto simile alle views di Django: si vengono a creare le function-based API views se i metodi sono definiti attraverso funzioni, o le class-based API views se i metodi sono definiti attraverso classi.

Inoltre, permette la generazione automatica di metodi per l'interazione con certe entità del database, attraverso particolari classi dette viewset.

Come per Django, è stato scelto per lo sviluppo di Sophon in quanto è stato presentato al corso di Tecnologie web di Unimore, e perchè si è ritenuto che fosse l'opzione più semplice per realizzare una web API all'interno di Django.

Docker SDK for Python

Per interfacciarsi con i moduli Jupyter, si è deciso di utilizzare Docker SDK for Python, un client Python per l'interazione con il daemon Docker.

Vedi anche

Containerizzazione, più avanti nel capitolo.

Modulo frontend

Il modulo frontend consiste in una applicazione web che consente agli utenti di interagire con Sophon da un'interfaccia grafica.

Le interazioni vengono inviate al modulo proxy, che le ispeziona e le inoltra al modulo backend.

È scritto in TypeScript, usando React e le librerie FontAwesome e Bluelib, in aggiunta alle loro dipendenze ed altre piccole librerie di supporto.

Viene eseguito dal browser web dell'utente che desidera interagire con Sophon, transcompilato da TypeScript a JavaScript.

JavaScript

JavaScript è un linguaggio di programmazione interpretato con tipizzazione dinamica debole.

È l'unico linguaggio utilizzabile per rendere interattive le pagine web; pertanto, è indirettamente utilizzato dal modulo frontend di Sophon.

Il suo modello di oggetti si basa su dizionari che mappano i nomi degli attributi ai loro corrispondenti valori.

Fa inoltre abbondante uso della capacità dei linguaggi dinamici di definire funzioni a runtime (dette anche callback), sfruttandole per favorire la programmazione funzionale.

const cane = {
   verso: () => console.log("Woof!"),
};

const gatto = {
   verso: () => console.log("Miao!"),
};

const zoo = [cane, gatto];

zoo.forEach(
   (animale) => animale.verso()
);

Node.js

Node.js è un runtime JavaScript che permette la scrittura e l'esecuzione di programmi all'esterno del contesto di un browser web, utilizzando invece come contesto il sistema operativo su cui viene eseguito.

Include npm, un gestore di pacchetti per il download di librerie Node, che interagisce con l'npm Registry.

È utilizzato da Sophon come toolchain per lo sviluppo e il deployment del modulo frontend, in quanto necessario per l'esecuzione di Create React App.

Create React App

Create React App è un insieme di strumenti Node.js per lo sviluppo di una applicazione web utilizzando la libreria per la creazione di interfacce grafiche React.

È utilizzato da Sophon per la costruzione della pagina del modulo frontend che sarà servita all'utente.

Si è scelto di usare Create React App in quanto astrae al programmatore tutta la logica di creazione della pagina, semplificando enormemente la manutenzione ed estensione futura del software.

TypeScript

TypeScript è un'estensione al linguaggio di programmazione JavaScript che vi introduce un sistema di tipizzazione forte.

Non essendo immediatamente utilizzabile all'interno delle pagine web, deve essere prima convertito in JavaScript: ciò viene effettuato da Create React App in fase di costruzione dell'applicazione.

interface Animale {
   verso: () => string,
}

var cane: Animale = {
   verso: () => console.log("Woof!"),
};

var gatto: Animale = {
   verso: () => console.log("Miao!"),
};

var zoo: Animale[] = [cane, gatto];

zoo.forEach(
   (animale) => animale.verso()
);

È stata utilizzata in quasi ogni singola parte del modulo frontend, in quanto avere una tipizzazione forte riduce significativamente i bug prodotti e facilita manutenzione ed estensione del software.

React

React è una libreria JavaScript per lo sviluppo di interfacce grafiche interattive all'interno di pagine web o applicazioni mobile.

L'interfaccia viene definita in modo dichiarativo e funzionale attraverso una variante dei linguaggi JavaScript (o TypeScript) detta JSX (o TSX), che permette l'inserimento di nodi HTML all'interno del codice.

Si basa sul concetto di componenti, piccole parti incapsulate di interfaccia grafica riutilizzabili attraverso tutta l'applicazione definite attraverso funzioni pure, e di hooks, particolari funzioni il cui nome inizia con use in grado di tenere traccia dello stato di un componente o di causare effetti collaterali all'interno di esso.

const ComponenteTitoloMaiuscolo = ({text}) => {
   const capitalizedText = text.toUpperCase();

   return (
      <h1>
         {capitalizedText}
      </h1>
   );
}

È 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 intuitiva.

FontAwesome

FontAwesome è una libreria che fornisce più di mille icone utilizzabili gratuitamente all'interno di pagine web.

È stata usata per favorire l'intuibilità dell'interfaccia grafica attraverso simboli familiari all'utente.

Bluelib

Bluelib è un foglio di stile per pagine web orientato alla modularità, alla responsività e all'accessibilità.

È stato sviluppato nell'Estate 2021 come progetto personale dell'autore di questa tesi, ed è stato esteso con temi aggiuntivi in Autunno 2021, tra cui uno sviluppato appositamente per Sophon.

Si basa sul concetto di pannelli, sezioni di pagina separate dal resto tramite un colore di sfondo o un bordo diverso.

Fa ampio uso delle CSS Custom Properties, permettendo lo sviluppo di vari temi con aspetto differente.

../../_images/bluelib_royalblue.png — Figura 4.2.2 Il tema "Royal Blue" (`royalblue`) di Bluelib, da cui ha origine il nome.

../../_images/bluelib_paper.png — Figura 4.2.3 Il tema "Sheet of Paper" (`paper`) di Bluelib, pensato per la stampa su carta.

../../_images/bluelib_sophon.png — Figura 4.2.4 Il tema "The Sophonity" (`sophon`) di Bluelib, creato appositamente per questo progetto.

../../_images/bluelib_hacker.png — Figura 4.2.5 Il tema "Hacker Terminal" (`hacker`) di Bluelib, creato per testare la visualizzazione di caratteri monospace.

../../_images/bluelib_amber.png — Figura 4.2.6 Il tema "Gestione Amber" (`amber`) di Bluelib, realizzato da Lorenzo Balugani.

Bluelib React

Bluelib React è un adattamento a React del foglio di stile Bluelib.

È stato sviluppato a inizio Autunno 2021 come parte del tirocinio interno dell'autore di questa tesi.

Definice componenti per ogni elemento grafico introdotto in Bluelib, e rende velocemente configurabili alcuni parametri, come il colore o la disabilitazione di un pannello.

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.

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.

../../_images/diagram_proxy.png — Figura 4.2.7 Schema del reverse proxying di Sophon.

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:

# Questa è un'istruzione globale.
Bind 80

# Questo è un blocco di istruzioni ristretto a un contesto specifico.
<VirtualHost *:80>
   ServerName "ilmiosophon.it"
   ServerAlias "*.ilmiosophon.it"

   RewriteEngine On
   RewriteRule ^(.*)$ https://%{HTTP_HOST}$1 [R=301,L]
</VirtualHost>

Modulo Jupyter

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.

4.3. 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.

Docker

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.

Immagini Docker

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. [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".

Container Docker

I container Docker sono istanze di immagini che possono essere eseguite dal Docker Engine [docker:overview].

Sono l'equivalente di un'intera macchina virtuale, che può essere avviata o arrestata.

Network Docker

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 [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ù elaborata ed efficiente dei moduli di rete per macchine virtuali.

Volumi Docker

I volumi Docker sono astrazioni per filesystem che permettono la permanenza e la condivisione tra container di file [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.

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.

Docker Compose

Docker Compose è uno strumento da linea di comando che permette l'esecuzione di applicazioni Docker composte da più container.

Le applicazioni Compose sono definite all'interno di un file YAML come il seguente:

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

4.4. Controllo versione

Per assistere nello sviluppo del software si è deciso di utilizzare il sistema di controllo versione Git in ogni fase dello sviluppo del progetto.

Inoltre, per favorire lo sviluppo di una community open source attorno a Sophon, si è deciso di pubblicare il progetto su GitHub, sotto la Affero General Public License 3.0+.

Git

Git è un software di controllo versione, ovvero un software in grado di tenere traccia di modifiche effettuate su file, in modo da mantenerne uno storico, e permettere a più autori di lavorare in parallelo su documenti.

Inizialmente realizzato da Linus Torvalds per lo sviluppo del kernel Linux, ha preso velocemente piede in tutto il settore dello sviluppo software, diventando di fatto lo standard per lo sviluppo collaborativo di software.

Le cartelle di file tracciate da Git sono dette repository, mentre un blocco atomico di modifiche è detto commit.

GitHub

GitHub è un servizio web di Microsoft per l'hosting e la pubblicazione di repository Git.

Per ciascun repository sono messe a disposizione gratuitamente numerose funzionalità, quali un issue tracker, strumenti di code review e sistemi di automazione per lo sviluppo [github:features].

Affero General Public License 3.0+

Sophon è rilasciato sotto la GNU Affero General Public License v3 (o successiva).

Il testo completo della licenza è disponibile all'interno del file LICENSE.txt allegato al codice sorgente del software.

In breve, la licenza, detta virale, permette a chiunque di utilizzare, distribuire e modificare il software, a condizione che qualsiasi modifica venga ri-distribuita agli utenti del software modificato utilizzando la stessa licenza.

Si specifica che la licenza copre tutti i file all'interno del repository Steffo99/sophon, anche se essi non contengono un header che indica che sono protetti da copyright.

4.5. Entità di Sophon

Al fine di definire più in dettaglio le operazioni che devono poter essere effettuate all'interno di Sophon, sono state definite delle entità, i tipi base con cui l'utente può interagire.

Istanza in Sophon

Un'istanza rappresenta un'installazione di Sophon effettuata su un server di un'istituzione di ricerca, come ad esempio un'Università.

Ogni istanza è fisicamente e logicamente separata dalle altre; istanze diverse non condividono alcun dato tra loro.

URL dell'istanza

Ciascuna istanza è accessibile tramite uno specifico URL, scelto dall'amministratore di sistema al momento dell'installazione.

../../_images/diagram_instance_urls.png — Figura 4.5.1 Schema rappresentante un esempio di URL di istanza rispettivamente per Unimore, Unibo e il CERN. Si noti come Sophon possa essere ospitato a domini di qualsiasi livello o radici diverse da `/`, quella predefinita.

Utenti in Sophon

Un utente è una entità che interagisce con una specifica istanza Sophon: ad esempio, un utente potrebbe essere una persona fisica, oppure potrebbe essere un software di automazione che si interfaccia con Sophon.

La tabella viene creata automaticamente da Django all'interno di ogni applicazione che include

Livelli di accesso

Un utente può avere uno dei seguenti livelli di accesso:

Superutente: Utente con accesso completo a ogni singola risorsa sull'istanza Sophon, tipicamente riservato per l'amministratore di sistema.
Utente: Utente con permessi limitati alle risorse che ha creato o a cui è stato fornito accesso.
Ospite: Utente che può visualizzare alcuni contenuti dell'istanza Sophon ma non può interagirci.

Credenziali di accesso

Gli utenti di tipo Utente e Superutente devono identificarsi sull'istanza con le loro credenziali.

Di default, le credenziali sono un nome utente e una password, ma è possibile implementare un sistema diverso, ad esempio un sistema SSO.

Gruppi di ricerca in Sophon

Un gruppo di ricerca rappresenta un insieme di utenti che collaborano su uno o più progetti.

Membri e modalità di accesso

Gli utenti dell'istanza possono diventare membri dei gruppi di ricerca, con una delle seguenti modalità selezionate nelle impostazioni del gruppo:

se il gruppo è aperto, allora qualsiasi utente potrà diventarne membro semplicemente facendo richiesta attraverso l'interfaccia web;
se il gruppo è in modalità manuale, allora nessun utente potrà richiedere di unirsi, e i membri saranno selezionati manualmente dal creatore del gruppo.

In qualsiasi momento, i membri di un gruppo possono lasciarlo facendo apposita richiesta attraverso il frontend.

Creazione di nuovi gruppi

Qualsiasi utente può creare gruppi di ricerca dall'interfaccia web.

Modifica di gruppi

Il creatore di un gruppo di ricerca è l'unico utente che può cambiarne nome, descrizione, membri e modalità di accesso.

Lo slug, l'identificatore univoco del gruppo, non è modificabile successivamente alla creazione, in quanto verrà utilizzato all'interno degli URL, che devono essere immutabili.

Eliminazione di gruppi

Il creatore di un gruppo è l'unico utente in grado di cancellare il gruppo che ha creato.

Pericolo

L'eliminazione di un gruppo è un'operazione distruttiva non reversibile!

Progetti di ricerca in Sophon

Un progetto di ricerca rappresenta una collezione di oggetti relativa a un singolo argomento mantenuta da un gruppo di ricerca.

Visibilità dei progetti

I progetti hanno tre diverse impostazioni di visibilità che regolano chi può visualizzarne i contenuti:

Progetto privato: Il progetto è visibile solo ai membri del gruppo a cui appartiene il progetto.
Progetto interno: Il progetto è visibile solo agli utenti dell'istanza, e non agli ospiti.
Progetto pubblico: Il progetto è visibile a tutti.

Creazione di nuovi progetti

Qualsiasi membro di un gruppo di ricerca può creare nuovi progetti.

Modifica di progetti

Qualsiasi membro di un gruppo di ricerca può modificare nome, descrizione dei progetti al suo interno.

Solo il creatore del gruppo può modificarne la visibilità, o trasferire il progetto ad un altro gruppo.

Lo slug, l'identificatore univoco del progetto, non è modificabile successivamente alla creazione, in quanto è utilizzato all'interno degli URL, che devono essere immutabili.

Eliminazione di progetti

Qualsiasi membro di un gruppo di ricerca può eliminare i progetti al suo interno.

Pericolo

L'eliminazione di un progetto è un'operazione distruttiva non reversibile!

Notebook in Sophon

Un notebook rappresenta una postazione di lavoro che può essere allegata ad un progetto di ricerca.

Creazione di nuovi notebook

Qualsiasi membro di un gruppo di ricerca può creare nuovi notebook all'interno di uno dei progetti del gruppo a cui appartiene.

Slug riservati

Un notebook non può avere come slug uno dei seguenti valori, in quanto riservati per altri usi:

backend
frontend
proxy
api
static
src

In più, uno slug di un notebook non può iniziare o terminare con un trattino -, in quanto risulterebbe in un sottodominio non valido.

Stato del notebook

Un notebook può essere avviato o fermo in base al suo stato di esecuzione sull'istanza Sophon:

è avviato se è in esecuzione e accessibile;
è fermo se non è in esecuzione o se è in fase di preparazione.

Alla creazione, un notebook è fermo.

Avviare un notebook

Un membro del gruppo di ricerca a cui appartiene il notebook può richiedere al server l'avvio di quest'ultimo, in modo da poterlo utilizzare successivamente.

Fermare un notebook

Un membro del gruppo di ricerca a cui appartiene il notebook può richiedere al server l'arresto di quest'ultimo, salvando i dati e interrompendo la sessione di lavoro attualmente in corso.

Immagine del notebook

In fase di creazione di un notebook, oppure mentre esso è fermo, è possibile selezionare l'immagine Docker che esso deve eseguire all'avvio.

Di default, l'immagine deve essere quella del modulo Jupyter.

Le immagini ammesse devono esporre un server HTTP sulla porta 8080, su cui verrà fatto reverse proxying dal modulo proxy.

Collegamento a un notebook

I membri del gruppo di ricerca a cui appartiene il notebook possono connettersi ad un notebook avviato attraverso un URL segreto comunicatogli dal modulo backend.

L'URL segreto è ottenuto inserendo come query parameter dell'URL del notebook il token di autenticazione di Jupyter.

Blocco di un notebook

Qualsiasi membro del gruppo di ricerca a cui appartiene il notebook può bloccarlo per segnalare agli altri utenti che vi hanno accesso di non utilizzare quello specifico notebook.

Bloccare un notebook rimuove dall'interfaccia web i bottoni di interazione con esso per tutti gli utenti, tranne l'utente richiedente il blocco.

Nota

Il blocco di un notebook è solo estetico, e non ha lo scopo di impedire agli utenti di interagire con il notebook, ma serve per indicare ai propri collaboratori che si stanno effettuando modifiche che non permettono collaborazione sul notebook.

Un notebook bloccato può essere sbloccato da qualsiasi membro del gruppo di ricerca; il membro che ha richiesto il blocco potrà sbloccarlo immediatamente, mentre agli altri membri è richiesto di confermare l'azione.

Modifica di un notebook

Qualsiasi membro di un gruppo di ricerca può modificare nome e immagine dei notebook fermi al suo interno.

I notebook avviati non possono essere modificati.

Lo slug, l'identificatore univoco del notebook, non è modificabile successivamente alla creazione, in quanto è utilizzato all'interno degli URL, che devono essere immutabili.

Eliminazione di un notebook

Qualsiasi membro di un gruppo di ricerca può eliminare i notebook all'interno dei progetti del gruppo, a condizione che questi siano fermi e non bloccati.

4.6. Database

Il modulo backend di Sophon necessita di archiviare dati persistenti altamente relazionali; pertanto, è stato necessario adottare una soluzione in grado di gestirli.

A tale scopo, è stato selezionato il database relazionale PostgreSQL, in quanto FLOSS, adatto a dati relazionali, compatibile con Django, e ampiamente utilizzato in tutto il mondo.

../../_images/diagram_database.png — Figura 4.6.1 Schema semplificato del database di Sophon.