Spotter-VM/doc/applications/tech-knowledge.rst

375 lines
12 KiB
ReStructuredText
Raw Normal View History

2020-06-01 22:05:55 +02:00
Technological knowledge requirements
====================================
2019-03-19 11:32:31 +01:00
2020-06-01 22:05:55 +02:00
Basic system
-------------
2019-03-19 11:32:31 +01:00
Components which are installed directly as part of the basic virtual machine.
2020-06-01 22:05:55 +02:00
Alpine linux
^^^^^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Operating system
- **Tech. description:** Lightweight linux distribution based on musl C libraries
- **Depends on:** -
- **Used by:** Everything
- **Related skills:** EXTLINUX / ISOLINUX, git, linux administration (cron, filesystems, iptables, networking, user/group mgmt etc.), LUKS, LVM, OpenRC init system, POSIX standards, s6 init system, shell scripting
2020-06-01 22:05:55 +02:00
Acme.sh
^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Certificate renewal tool
- **Tech. description:** Shell-based Automated Certificate Management Environment client
- **Depends on:** -
- **Used by:** nginx, VMMgr
- **Related skills:** shell scripting, SSL/TLS
2020-06-01 22:05:55 +02:00
Nginx
^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Web server
- **Tech. description:** Lightweight HTTP server
- **Depends on:** -
- **Used by:** All application containers, VMMgr
- **Related skills:** HTTP (proxying, rewriting)
2020-06-01 22:05:55 +02:00
LXC
^^^
2019-03-19 11:32:31 +01:00
- **General description:** Container virtualization host
- **Tech. description:** Operating system-level container virtualization host
- **Depends on:** -
- **Used by:** All containers
- **Related skills:** container virtualization fundamentals, linux kernel (cgroups, overlayfs, seccomp), shell scripting
2020-06-01 22:05:55 +02:00
Postfix
^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Mail server
- **Tech. description:** Outbound mail transfer agent
- **Depends on:** -
- **Used by:** All application containers
- **Related skills:** SMTP
2020-06-01 22:05:55 +02:00
SPOC
^^^^
- **General description:** Container virtualization manager
- **Tech. description:** Convenience abstraction layer on top of LXC
- **Depends on:** LXC, Python 3
- **Used by:** All containers, VMMgr
2020-10-22 23:05:13 +02:00
- **Related skills:** JSON, python frameworks and modules (cryptography, requests, subprocess), LXC, shell scripting
2020-06-01 22:05:55 +02:00
VMMgr
^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Virtual machine and application manager web interface
- **Tech. description:** In-house Werkzeug-based virtual machine and application manager WSGI application
- **Depends on:** Nginx, LXC, Python 3
- **Used by:** User
2020-10-22 23:05:13 +02:00
- **Related skills:** JSON, python frameworks and modules (cryptography, jinja2, requests, subprocess, werkzeug), shell scripting, WSGI application development
2019-03-19 11:32:31 +01:00
2020-06-01 22:05:55 +02:00
Runtimes
--------
2019-03-19 11:32:31 +01:00
Components which are supplied as LXC overlay layers but don't run as standalone containers
2020-06-01 22:05:55 +02:00
Java
^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Java runtime environment
- **Tech. description:** Java OpenJDK 8 runtime environment
- **Depends on:** -
- **Used by:** ActiveMQ, FrontlineSMS, Tomcat, CrisisCleanup, MifosX, Motech, OpenDataKit, OpenMapKit, Sigmah, Solr
- **Related skills:** -
2020-06-01 22:05:55 +02:00
Nodejs
^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** JavaScript runtime environment
2020-06-01 22:05:55 +02:00
- **Tech. description:** Server-side Nodejs 8 JavaScript runtime environment
2019-03-19 11:32:31 +01:00
- **Depends on:** -
- **Used by:** CrisisCleanup, GNU Health, Odoo, OpenDataKit Build, OpenMapKit
- **Related skills:** HTTP (proxying), JavaScript (language overview)
2020-06-01 22:05:55 +02:00
PHP
^^^
2019-03-19 11:32:31 +01:00
- **General description:** PHP 7 runtime environment
- **Tech. description:** PHP 7 hypertext preprocessor scripting runtime
- **Depends on:** -
2020-06-01 22:05:55 +02:00
- **Used by:** Kanboard, SeedDMS, Ushahidi
2019-03-19 11:32:31 +01:00
- **Related skills:** HTTP (proxying), PHP 7 (language overview), PHP-FPM
2020-06-01 22:05:55 +02:00
Python 2
^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Python 2 runtime environment
2020-06-01 22:05:55 +02:00
- **Tech. description:** Python 2 runtime environment and standard libraries
2019-03-19 11:32:31 +01:00
- **Depends on:** -
- **Used by:** CKAN, CKAN DataPusher, CTS, OpenMapKit, Sahana Eden
- **Related skills:** linux compilation toolchain (header files, gcc, make etc.), pip, python (language overview)
2020-06-01 22:05:55 +02:00
Python 3
^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Python 3 runtime environment
2020-06-01 22:05:55 +02:00
- **Tech. description:** Python 3 runtime environment and standard libraries
2019-03-19 11:32:31 +01:00
- **Depends on:** -
- **Used by:** GNU Health, Odoo, Pan.do/ra, SeedDMS, VMMgr (doesn't use container)
- **Related skills:** linux compilation toolchain (header files, gcc, make etc.), pip, python (language overview)
2020-06-01 22:05:55 +02:00
Ruby
^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Ruby runtime environment
- **Tech. description:** Ruby 2.4 runtime environment and gem package installer
- **Depends on:** -
- **Used by:** CrisisCleanup, OpenDataKit Build
- **Related skills:** linux compilation toolchain (header files, gcc, make etc.)
2020-06-01 22:05:55 +02:00
Tomcat
^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Lightweight Java application server
- **Tech. description:** Java application JSP and servlet container
- **Depends on:** Java
- **Used by:** MifosX, Motech, OpenDataKit, Sigmah
- **Related skills:** JVM tuning, shell scripting
2020-06-01 22:05:55 +02:00
Components
----------
2019-03-19 11:32:31 +01:00
Components which are supplied as LXC containers required by other applications but aren't exposed directly to the end user
2020-06-01 22:05:55 +02:00
ActiveMQ
^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Message broker middleware
- **Tech. description:** Java-based message broker and messaging server
- **Depends on:** Java
- **Used by:** Motech
- **Related skills:** JVM tuning, XML
2020-06-01 22:05:55 +02:00
MariaDB
^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** MySQL database server
- **Tech. description:** MySQL-compatible relational database management system
- **Depends on:** -
- **Used by:** MifosX, Ushahidi
- **Related skills:** SQL (language overview)
2020-06-01 22:05:55 +02:00
Postgres
^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** PostgreSQL database server
- **Tech. description:** PostgreSQL relational database management system
- **Depends on:** -
2020-06-01 22:05:55 +02:00
- **Used by:** CKAN, CrisisCleanup, CTS, GNU Health, Kanboard, Motech, Odoo, OpenDataKit, OpenDataKit Build, OpenMapKit, Pan.do/ra, Sahana Eden, SeedDMS, Sigmah
2019-03-19 11:32:31 +01:00
- **Related skills:** SQL (language overview)
2020-06-01 22:05:55 +02:00
RabbitMQ
^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Message broker middleware
- **Tech. description:** Erlang-based message broker and messaging server
- **Depends on:** -
- **Used by:** Pan.do/ra
- **Related skills:** -
2020-06-01 22:05:55 +02:00
Redis
^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Key-value NoSQL database server
- **Tech. description:** In-memory NoSQL key-value data structure object store
- **Depends on:** -
- **Used by:** CKAN
- **Related skills:** -
2020-06-01 22:05:55 +02:00
Solr
^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Full-text search server
- **Tech. description:** Apache Lucene-based full-text search and indexing platform
- **Depends on:** Java
- **Used by:** CKAN
- **Related skills:** shell scripting, JVM tuning
2020-06-01 22:05:55 +02:00
Applications
------------
2019-03-19 11:32:31 +01:00
Components which are supplied as LXC containers exposed directly to the end user
2020-06-01 22:05:55 +02:00
CKAN
^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Data management and data store system
- **Tech. description:** Flask-based data store application
2020-10-22 23:05:13 +02:00
- **Depends on:** CKAN DataPusher, Postgres, Python 3, Redis, Solr
2019-03-19 11:32:31 +01:00
- **Used by:** User
- **Related skills:** PostGIS, python frameworks and modules (flask, paster, setuptools), Solr core configuration
2020-06-01 22:05:55 +02:00
CKAN DataPusher
^^^^^^^^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Data file parser for CKAN
- **Tech. description:** Python-based data file parser service for CKAN
2020-10-22 23:05:13 +02:00
- **Depends on:** Python 3
2019-03-19 11:32:31 +01:00
- **Used by:** CKAN
- **Related skills:** MIME types identification, WSGI application development
2020-06-01 22:05:55 +02:00
CrisisCleanup
^^^^^^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Disaster response and relief coordination
2020-06-01 22:05:55 +02:00
- **Tech. description:** Ruby-on-Rails-based application with Nodejs-generated frontend assets
- **Depends on:** LibXML, Nodejs, Postgres, Ruby
2019-03-19 11:32:31 +01:00
- **Used by:** User
2020-06-01 22:05:55 +02:00
- **Related skills:** Nodejs build systems (npm, yarn), Ruby build systems and frameworks (Bundle, Devise, Gems, Rails, Rake)
2019-03-19 11:32:31 +01:00
2020-06-01 22:05:55 +02:00
CTS
^^^
2019-03-19 11:32:31 +01:00
- **General description:** Commodity tracking system
- **Tech. description:** Django-based forms applicaton
- **Depends on:** Postgres, Python 2
- **Used by:** User
- **Related skills:** python frameworks (Django), WSGI application development
2020-06-01 22:05:55 +02:00
Decidim
^^^^^^^
- **General description:** Platform for citizen participation
- **Tech. description:** Ruby on Rails-based forms and polls applicaton
- **Depends on:** Nodejs, Postgres, Ruby
- **Used by:** User
- **Related skills:** Nodejs build systems (npm, yarn), Ruby build systems and frameworks (Bundle, Devise, Gems, Rails, Rake)
FrontlineSMS
^^^^^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Bulk text messaging
- **Tech. description:** Spring-based application for modem device access
- **Depends on:** Java
- **Used by:** User
- **Related skills:** Java build systems and frameworks (grails, Spring), Jetty, linux modem/tty handling, Xorg (X server)
2020-06-01 22:05:55 +02:00
GNU Health
^^^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Hospital information system (ERP)
2020-06-01 22:05:55 +02:00
- **Tech. description:** Tryton-based form application RPC backend with Nodejs-based frontend
2020-10-22 23:05:13 +02:00
- **Depends on:** Nodejs, Postgres, Python 3
2019-03-19 11:32:31 +01:00
- **Used by:** User
2020-06-01 22:05:55 +02:00
- **Related skills:** Nodejs build systems (grunt, npm), python modules (setuptools, virtualenv)
2019-03-19 11:32:31 +01:00
2020-06-01 22:05:55 +02:00
Kanboard
^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:** Kanban project management
- **Tech. description:** Symfony-based forms application
- **Depends on:** PHP, Postgres
- **Used by:** User
- **Related skills:** PHP build systems and frameworks (Composer, Symfony)
2020-06-01 22:05:55 +02:00
MifosX
^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:**
2020-06-01 22:05:55 +02:00
- **Tech. description:** Spring-based forms application RPC backend with Nodejs-packed frontend
2019-03-19 11:32:31 +01:00
- **Depends on:** MariaDB, Tomcat
- **Used by:** User
2020-06-01 22:05:55 +02:00
- **Related skills:** Java frameworks (Spring), Nodejs and JavaScript development (Angular, Bower, Grunt)
2019-03-19 11:32:31 +01:00
2020-06-01 22:05:55 +02:00
Motech
^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:**
- **Tech. description:** Apache Felix-based forms application
- **Depends on:** ActiveMQ, Postgres, Tomcat
- **Used by:** User
- **Related skills:** Java frameworks (Apache Felix, Spring)
2020-06-01 22:05:55 +02:00
Odoo
^^^^
2019-03-19 11:32:31 +01:00
- **General description:**
2020-06-01 22:05:55 +02:00
- **Tech. description:** Werkzeug-based forms application RPC backend with Nodejs-based frontend
- **Depends on:** Nodejs, Postgres, Python 3
2019-03-19 11:32:31 +01:00
- **Used by:** User
- **Related skills:** WSGI application development
2020-06-01 22:05:55 +02:00
OpenDataKit
^^^^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:**
- **Tech. description:** Spring and OpenRosa-based data store application
- **Depends on:** Postgres, Tomcat
- **Used by:** User
- **Related skills:** Java build systems and frameworks (Gradle, Spring)
2020-06-01 22:05:55 +02:00
OpenDataKit Build
^^^^^^^^^^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:**
2020-06-01 22:05:55 +02:00
- **Tech. description:** Ruby-based forms application with Nodejs-based data converter
- **Depends on:** Nodejs, Ruby
2019-03-19 11:32:31 +01:00
- **Used by:** User
2020-06-01 22:05:55 +02:00
- **Related skills:** Nodejs build systems (npm), Ruby build systems and frameworks (Bundler, Rake)
2019-03-19 11:32:31 +01:00
2020-06-01 22:05:55 +02:00
OpenMapKit
^^^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:**
2020-10-22 23:05:13 +02:00
- **Tech. description:** Nodejs-based forms application with python dependencies
2020-06-01 22:05:55 +02:00
- **Depends on:** Nodejs, Postgres, Python 2
2019-03-19 11:32:31 +01:00
- **Used by:** User
2020-06-01 22:05:55 +02:00
- **Related skills:** JavaScript development, Nodejs build systems (Yarn)
2019-03-19 11:32:31 +01:00
2020-06-01 22:05:55 +02:00
Pan.do/ra
^^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:**
- **Tech. description:** Python-based media store with Javascript-based frontend
- **Depends on:** Postgres, Python 3, RabbitMQ
- **Used by:** User
- **Related skills:** ffmpeg, imagemagick, JavaScript development (oxjs)
2020-06-01 22:05:55 +02:00
Sahana Eden
^^^^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:**
- **Tech. description:** Web2py-based forms application
- **Depends on:** Postgres, Python 2
- **Used by:** User
- **Related skills:** PostGIS, python frameworks and modules (requests, selenium, Web2py)
2020-06-01 22:05:55 +02:00
SeedDMS
^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:**
- **Tech. description:** PHP-based data store application with Lucene-based fulltext index
- **Depends on:** PHP, Postgres
- **Used by:** User
- **Related skills:** Apache Lucene, ghostscript, LibreOffice (unoconv), imagemagick, MIME types identification
2020-06-01 22:05:55 +02:00
Sigmah
^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:**
- **Tech. description:** Apache Commons-based forms application
- **Depends on:** Postgres, Tomcat
- **Used by:** User
- **Related skills:** Java development (hibernate, log4j)
2020-06-01 22:05:55 +02:00
Ushahidi
^^^^^^^^
2019-03-19 11:32:31 +01:00
- **General description:**
- **Tech. description:** Laravel-based RPC backend with Angular-based frontend
- **Depends on:** MariaDB, PHP
- **Used by:** User
2020-06-01 22:05:55 +02:00
- **Related skills:** JavaScript build tools and frameworks (Angular, Babel, WebPack), PHP build tools and frameworks (composer, Laravel, phinx)