MFSERV documentation

Table of Contents

• 1. Introduction to MFSERV
  • 1.1. What is mfserv?
  • 1.2. How it works?
  • 1.3. MFSERV configuration
• 2. How to configure the metwork yum repository ?
  • 2.1. Prerequisites
  • 2.2. Choose a version
  • 2.3. Configure the metwork yum repository for CentOS 6 distribution
  • 2.4. Configure the metwork yum repository for CentOS 7 distribution
  • 2.5. Test
• 3. How to install/upgrade/remove mfserv metwork module (with internet access)
  • 3.1. Prerequisites
  • 3.2. Install mfserv metwork module
  • 3.3. Full installation
  • 3.4. Minimal installation
  • 3.5. Optional Addons
    • 3.5.1. Optional dependencies addons
    • 3.5.2. Optional mfserv addons
  • 3.6. Services
  • 3.7. Uninstall mfserv metwork module
  • 3.8. Upgrade mfserv metwork module
  • 3.9. Uninstall all metwork modules
  • 3.10. Upgrade all metwork modules
• 4. How to configure mfserv metwork module ?
  • 4.1. General
    • 4.1.1. How to configure a metwork module (mfserv, mfbase, mfdata…) during development process ?
    • 4.1.2. How to configure plugins during development process ?
    • 4.1.3. How to configure a metwork module (mfserv, mfbase, mfdata…) during production deployment process ?
    • 4.1.4. How to configure plugins during production deployment process ?
• 5. Loading MFSERV environment
  • 5.1. General
  • 5.2. Activate MFSERV environment by logging in as mfserv user.
  • 5.3. Activate MFSERV environment from any user.
  • 5.4. Activate MFSERV for one command only from any user.
  • 5.5. Miscellaneous
• 6. Quick Start
  • 6.1. Activate the MFSERV environment
  • 6.2. Create your first plugin
    • 6.2.1. Create the plugin
    • 6.2.2. Run the plugin
    • 6.2.3. Release the plugin
    • 6.2.4. Deploy the plugin
• 7. How to create custom plugins
  • 7.1. Create and customize the plugin
  • 7.2. Custom plugin configuration
  • 7.3. Plugin templates
    • 7.3.1. The default template
    • 7.3.2. The django template
    • 7.3.3. The flask template
    • 7.3.4. The node template
    • 7.3.5. The static template
    • 7.3.6. The empty template
• 8. Debug a plugin
  • 8.1. Application Log level
  • 8.2. Nginx Access Log
  • 8.3. Interactive debugger
  • 8.4. Entering the plugin environment
• 9. Release and Deploy a plugin
  • 9.1. Release a plugin
  • 9.2. Deploy a plugin in a production environment
    • 9.2.1. The ‘basic’ way
    • 9.2.2. The ‘well-done’ way
  • 9.3. Override a plugin configuration
• 10. Tutorials
  • 10.1. Django project plugin
  • 10.2. Flask plugin
  • 10.3. Node.js plugin
  • 10.4. aiohttp python plugin
• 11. Tuning, Monitoring and Dashboard
  • 11.1. Tuning
    • 11.1.1. Number of processes
    • 11.1.2. Resource limits
    • 11.1.3. Nginx tuning an rate limiting
    • 11.1.4. Advanced settings
    • 11.1.5. Miscellaneous
  • 11.2. Monitoring and Dashboards
    • 11.2.1. Monitor a plugin
    • 11.2.2. Dashboards
    • 11.2.3. Useful links and Tips
• 12. Plugins guide
  • 12.1. Plugins Configuration
  • 12.2. Plugins Commands
    • 12.2.1. plugins.list
    • 12.2.2. plugins.install
    • 12.2.3. plugins.uninstall
    • 12.2.4. plugins.info
    • 12.2.5. plugin_env
    • 12.2.6. plugin_wrapper
  • 12.3. Make Commands
    • 12.3.1. make develop
    • 12.3.2. make release
    • 12.3.3. make clean
    • 12.3.4. make superclean
    • 12.3.5. make
  • 12.4. Python virtualenv
    • 12.4.1. The ‘Simple’ requirements
    • 12.4.2. The ‘Exact’ Requirements
    • 12.4.3. The ‘Best’ Requirements
    • 12.4.4. Python3 requirements-to-freeze.txt
    • 12.4.5. Python2 requirements-to-freeze.txt
• 13. Miscellaneous
  • 13.1. The .layerapi2_dependencies file
  • 13.2. The .layerapi2_extra_env file
  • 13.3. Plugins with more than one application
  • 13.4. The outside Metwork command
  • 13.5. The crontab support
  • 13.6. Extra daemon
  • 13.7. Extra route
  • 13.8. Access a database
  • 13.9. Disable request ID to be appeared in the logs
  • 13.10. Disable middleware (asyncio, aiohttp plugins)
• 14. MFSERV Log
  • 14.1. Default logs files
  • 14.2. Custom logs files
    • 14.2.1. Classic Python logger
    • 14.2.2. Metwork MFLOG logger
• 15. Layer root
  • 15.1. Overview
• 16. Special focus on python wrappers
  • 16.1. python2 wrapper
  • 16.2. python3 wrapper
  • 16.3. python wrapper
  • 16.4. Metadata
    • 16.4.1. Layer Home
    • 16.4.2. Label
    • 16.4.3. Package
    • 16.4.4. Dependencies
  • 16.5. Utilities
    • 16.5.1. mfserv.stop
    • 16.5.2. mfserv.status
    • 16.5.3. mfserv_wrapper
• 17. Layer python2
  • 17.1. Overview
  • 17.2. Metadata
    • 17.2.1. Layer Home
    • 17.2.2. Label
    • 17.2.3. Package
    • 17.2.4. Dependencies
  • 17.3. Utilities
  • 17.4. Packages
• 18. Layer python3
  • 18.1. Overview
  • 18.2. Metadata
    • 18.2.1. Layer Home
    • 18.2.2. Label
    • 18.2.3. Package
    • 18.2.4. Dependencies
  • 18.3. Utilities
  • 18.4. Packages
• 19. Layer default
  • 19.1. Overview
  • 19.2. Metadata
    • 19.2.1. Layer Home
    • 19.2.2. Label
    • 19.2.3. Package
    • 19.2.4. Dependencies
  • 19.3. Utilities
• 20. Layer nodejs
  • 20.1. Overview
  • 20.2. Metadata
    • 20.2.1. Layer Home
    • 20.2.2. Label
    • 20.2.3. Package
    • 20.2.4. Dependencies
    • 20.2.5. Extra-environment (loaded after layer load)
  • 20.3. Utilities
• 21. CHANGELOGs
  • 21.1. release_0.9 CHANGELOG
    • 21.1.1. v0.9.14 (2021-04-27)
    • 21.1.2. v0.9.13 (2020-11-02)
    • 21.1.3. v0.9.12 (2020-10-28)
    • 21.1.4. v0.9.11 (2020-10-27)
    • 21.1.5. v0.9.10 (2020-09-25)
    • 21.1.6. v0.9.9 (2020-01-29)
    • 21.1.7. v0.9.8 (2020-01-27)
    • 21.1.8. v0.9.7 (2020-01-09)
    • 21.1.9. v0.9.6 (2020-01-02)
    • 21.1.10. v0.9.5 (2019-12-26)
    • 21.1.11. v0.9.4 (2019-12-12)
    • 21.1.12. v0.9.3 (2019-12-11)
    • 21.1.13. v0.9.2 (2019-10-31)
    • 21.1.14. v0.9.1 (2019-10-23)
    • 21.1.15. v0.9.0 (2019-10-22)
  • 21.2. release_0.8 CHANGELOG
    • 21.2.1. v0.8.4 (2019-10-15)
    • 21.2.2. v0.8.3 (2019-09-30)
    • 21.2.3. v0.8.2 (2019-09-25)
    • 21.2.4. v0.8.1 (2019-09-16)
    • 21.2.5. v0.8.0 (2019-08-14)
  • 21.3. release_0.7 CHANGELOG
    • 21.3.1. v0.7.6 (2019-08-09)
    • 21.3.2. v0.7.5 (2019-07-16)
    • 21.3.3. v0.7.4 (2019-07-15)
    • 21.3.4. v0.7.3 (2019-06-27)
    • 21.3.5. v0.7.2 (2019-06-17)
    • 21.3.6. v0.7.1 (2019-06-12)
    • 21.3.7. v0.7.0 (2019-05-29)
  • 21.4. release_0.6 CHANGELOG
    • 21.4.1. v0.6.2 (2019-05-10)
    • 21.4.2. v0.6.1 (2019-04-25)
    • 21.4.3. v0.6.0 (2019-03-27)
  • 21.5. release_0.5 CHANGELOG
    • 21.5.1. v0.5.8 (2019-04-01)
    • 21.5.2. v0.5.7 (2019-03-16)
    • 21.5.3. v0.5.6 (2019-02-16)
    • 21.5.4. v0.5.5 (2019-02-09)
    • 21.5.5. v0.5.4 (2019-02-06)
    • 21.5.6. v0.5.3 (2019-01-31)
    • 21.5.7. v0.5.2 (2019-01-31)
    • 21.5.8. v0.5.1 (2019-01-29)
    • 21.5.9. v0.5.0 (2019-01-29)
  • 21.6. release_0.4 CHANGELOG
    • 21.6.1. v0.4.1 (2019-01-09)
    • 21.6.2. v0.4.0 (2019-01-08)

Indices and tables

• Index

• Search Page