kaomi-server 0.1.1

This package contains the server endpoint for the Kaomi deployer. Kaomi server has to be run on the system where you want to deploy.

Kaomi Server

Configurazione ed uso del server

1. Creare un virtualenv con

virtualenv env --python=python3
source env/bin/activate

2. Installare il pacchetto python con

pip install kaomi_server

3. Creare i file di configurazione con

python -m kaomi_server configure --folder <path>

4. Avviare il server con

python -m kaomi_server start --config <path file server.conf> --apikey <path directory conf.d>

Creare il file di config per systemd con

nano /etc/systemd/system/kaomi-server.service

contenuto del file:

[Unit]
Description=Kaomi Server (TM) Service

[Service]
Type=simple
User=root
Group=root
# Load env vars from /etc/default/ and /etc/sysconfig/ if they exist.
# Prefixing the path with '-' makes it try to load, but if the file doesn't
# exist, it continues onward.
EnvironmentFile=-/etc/default/kaomi-server
EnvironmentFile=-/etc/sysconfig/kaomi-server
ExecStart=<virtualenv path>/env/bin/python -m kaomi_server start --config <path file server.conf> --apikey <path directory conf.d> 
Restart=on-abnormal
WorkingDirectory=<virtualenv path>

# When stopping, how long to wait before giving up and sending SIGKILL?
# Keep in mind that SIGKILL on a process can cause data loss.
TimeoutStopSec=3min

[Install]
WantedBy=multi-user.target

---

Formato rispose del server

Le risposte ottenute dal server in seguito ad una richiesta sono formate da una stringa contenente un dizionario con il formato:

{ "status": "status code", "substatus": "substatus code", "message": "meaning of the substatus" "data": "eventual useful data" }

Codici di stato e sotto-stato

Di seguito si riporta la tabella di conversione dei codici di stato e sub-stato ritornati dall'API del server.

status	substatus	meaning	data	example
0		EVERYTHING WENT OK
	0	Action executed	-	Specified folder has been created
	1	Final status reached but not in common way	-	Folder already existed
1		REQUEST'S ERRORS
	0	Wrong request type	-	Get request where only POST admitted
	1	Payload content-length greater than maximum allowed	Max request size in bytes
	2	Json content cannot be parsed	-
	3	Content-length not specified or not valid	-
	4	Missing fields in JSON	List of requeted fields
	5	ValueError in JSON	Exception text	Permissions received are not valid
2		APPLICATION'S ERRORS
	0	Generic server error occurred	Exception text
	1	Invalid apikey	-
	2	Action not permitted	Exception text
	3	A RuntimeError occurred	Exception text
	4	File/folder already exists	Exception text
	5	The uploaded file is too big	-	Uploaded file exceed maximum size (data contains maximum size in MB)
	6	Client ip not allowed	-	The client ip is not in the allowed list