Update Specifications.md

This commit is contained in:
eleonore 2024-07-29 16:04:58 +00:00
parent 856768a470
commit 9c6dab6a45

View File

@ -26,49 +26,49 @@ or just a call ./deployer deploy/remove all/service_name
deploy_service(service) deploy_service(service)
{ {
- determines if the service is on this server - determines if the service is on this server
if it is: if it is:
- checks the environment (/data/mounted and new nginx conf exists) - checks the environment (/data/mounted and new nginx conf exists)
- creates directories (secret, data, http) if necessary - creates directories (secret, data, http) if necessary
- calls the bash scripts specific to the service if they exist (deploy_as) - calls the bash scripts specific to the service if they exist (deploy_as)
- creates user and .env variables if necessary - creates user and .env variables if necessary
- calls the deployment functions from the libraries - calls the deployment functions from the libraries
} }
remove_service(service) //should there be some kind of less absolute removal? remove_service(service) //should there be some kind of less absolute removal?
{ {
- determines if the service is on this server - determines if the service is on this server
if it is: if it is:
- calls the removing bash scripts specific to the service if they exist - calls the removing bash scripts specific to the service if they exist
- calls the removing functions from the libraries - calls the removing functions from the libraries
- deletes .env variables - deletes .env variables
- deletes directories - deletes directories
- deletes user - deletes user
- removes from .csv //should this get done before by the sysadmin? but how to check that something was here if it has been removed ? - removes from .csv //should this get done before by the sysadmin? but how to check that something was here if it has been removed ?
} }
**main.cpp** **main.cpp**
- reads the instructions - reads the instructions
If deploy all: If deploy all:
- tests system requirements (/data/mounted) - tests system requirements (/data/mounted)
- prepares Nginx - prepares Nginx
- prepares Docker - prepares Docker
- prepares .env - prepares .env
for each service: for each service:
- deploy_service(service) - deploy_service(service)
- cleans - cleans
else if deploy one service: else if deploy one service:
- deploy_service(service) - deploy_service(service)
else if remove all: else if remove all:
for each service: for each service:
- remove_service(service) - remove_service(service)
- stop Docker - stop Docker
- stop wireguard - stop wireguard
- stop Nginx - stop Nginx
- cleans .env - cleans .env
- cleans - cleans
else if remove one service: else if remove one service:
- remove_service(service) - remove_service(service)
**plugins/static libraries** **plugins/static libraries**
- nginx - nginx