MFDATA documentation

Table of Contents

• 1. Introduction to MFDATA
  • 1.1. What is mfdata?
  • 1.2. How do plugins work?
  • 1.3. Why would I use mfdata?
• 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 mfdata metwork module (with internet access)
  • 3.1. Prerequisites
  • 3.2. Install mfdata metwork module
  • 3.3. Full installation
  • 3.4. Minimal installation
  • 3.5. Optional Addons
    • 3.5.1. Optional dependencies addons
    • 3.5.2. Optional mfdata addons
  • 3.6. Services
  • 3.7. Uninstall mfdata metwork module
  • 3.8. Upgrade mfdata metwork module
  • 3.9. Uninstall all metwork modules
  • 3.10. Upgrade all metwork modules
• 4. How to configure mfdata 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 MFDATA environment
  • 5.1. General
  • 5.2. Activate MFDATA environment by logging in as mfdata user.
  • 5.3. Activate MFDATA environment from any user.
  • 5.4. Activate MFDATA for one command only from any user.
  • 5.5. Miscellaneous
• 6. Quick Start
  • 6.1. Activate the MFDATA 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
  • 6.3. Use of the ungzip plugin
• 7. How to create custom plugins
  • 7.1. Create and customize the plugin
  • 7.2. Plugin templates
    • 7.2.1. The move template
    • 7.2.2. The fork template
    • 7.2.3. The delete template
    • 7.2.4. The default template
    • 7.2.5. The archive template
    • 7.2.6. The ftpsend template
• 8. Debug a plugin
  • 8.1. Log level
  • 8.2. Run the plugin as an independent unit
• 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. Additional Tutorials
  • 10.1. A PNG to JPEG conversion plugin
  • 10.2. Sending a file by FTP
  • 10.3. Create a plugin from scratch
    • 10.3.1. Create the plugin
    • 10.3.2. Set dependencies
    • 10.3.3. Fill in the plugin
    • 10.3.4. Override a configuration parameter
    • 10.3.5. Using the after callback
  • 10.4. Creating a batch plugin
  • 10.5. Implement custom monitoring and metrics in a plugin
    • 10.5.1. Add metrics in the Python code of the plugin
    • 10.5.2. Create a specific dashboard with our metrics
    • 10.5.3. View metrics on the dashboard
    • 10.5.4. Useful links and Tips
• 11. Plugins guide
  • 11.1. Plugins Configuration
  • 11.2. Plugins Commands
    • 11.2.1. plugins.list
    • 11.2.2. plugins.install
    • 11.2.3. plugins.uninstall
    • 11.2.4. plugins.info
    • 11.2.5. plugin_env
    • 11.2.6. plugin_wrapper
  • 11.3. Make Commands
    • 11.3.1. make develop
    • 11.3.2. make release
    • 11.3.3. make clean
    • 11.3.4. make superclean
    • 11.3.5. make
  • 11.4. Python virtualenv
    • 11.4.1. The ‘Simple’ requirements
    • 11.4.2. The ‘Exact’ Requirements
    • 11.4.3. The ‘Best’ Requirements
    • 11.4.4. Python3 requirements-to-freeze.txt
    • 11.4.5. Python2 requirements-to-freeze.txt
• 12. Identify particular types of files
  • 12.1. Introduction
  • 12.2. Example:
• 13. Miscellaneous
  • 13.1. The switch_logical_condition field
  • 13.2. The switch plugin tags attributes
  • 13.3. The .layerapi2_dependencies file
  • 13.4. The .layerapi2_extra_env file
  • 13.5. Inject data files in HTTP
  • 13.6. Plugins with more than one step
  • 13.7. The outside Metwork command
  • 13.8. The crontab support
  • 13.9. Extra daemon
  • 13.10. Access a database
  • 13.11. MFDATA - How it works ?
• 14. MFDATA Log
  • 14.1. Default logs files
  • 14.2. Custom logs files
    • 14.2.1. Classic Python logger
    • 14.2.2. Metwork MFLOG logger
• 15. Tuning, Monitoring and Dashboard
  • 15.1. Tuning
    • 15.1.1. Number of processes
    • 15.1.2. Resource limits
    • 15.1.3. Miscellaneous
  • 15.2. Monitoring and Dashboards
    • 15.2.1. Monitor a plugin
    • 15.2.2. Dashboards
    • 15.2.3. Useful links and Tips
• 16. XATTRFILE API
  • 16.1. xattrfile Package
    • 16.1.1. Functions
    • 16.1.2. Classes
    • 16.1.3. Variables
    • 16.1.4. Class Inheritance Diagram
  • 16.2. xattrfile.print_tags Module
    • 16.2.1. Functions
  • 16.3. xattrfile.get_tag Module
    • 16.3.1. Functions
  • 16.4. xattrfile.set_tag Module
    • 16.4.1. Functions
• 17. ACQUISITION API
  • 17.1. acquisition Package
    • 17.1.1. Classes
    • 17.1.2. Class Inheritance Diagram
• 18. Layer root
  • 18.1. Overview
  • 18.2. Special focus on python wrappers
    • 18.2.1. python2 wrapper
    • 18.2.2. python3 wrapper
    • 18.2.3. python wrapper
  • 18.3. Metadata
    • 18.3.1. Layer Home
    • 18.3.2. Label
    • 18.3.3. Dependencies
  • 18.4. Utilities
    • 18.4.1. mfdata.start
    • 18.4.2. mfdata.stop
    • 18.4.3. mfdata.status
    • 18.4.4. mfdata.init
    • 18.4.5. mfdata_wrapper
• 19. Layer python2
  • 19.1. Overview
  • 19.2. Metadata
    • 19.2.1. Layer Home
    • 19.2.2. Label
    • 19.2.3. Dependencies
  • 19.3. Utilities
    • 19.3.1. inject_file
    • 19.3.2. print_tags
    • 19.3.3. get_tag
    • 19.3.4. set_tag
• 20. Layer python3
  • 20.1. Overview
  • 20.2. Metadata
    • 20.2.1. Layer Home
    • 20.2.2. Label
    • 20.2.3. Dependencies
  • 20.3. Utilities
    • 20.3.1. inject_file
    • 20.3.2. print_tags
    • 20.3.3. get_tag
    • 20.3.4. set_tag
• 21. Layer default
  • 21.1. Overview
  • 21.2. Metadata
    • 21.2.1. Layer Home
    • 21.2.2. Label
    • 21.2.3. Dependencies
• 22. TODO List
• 23. CHANGELOGs
  • 23.1. release_0.7 CHANGELOG
    • 23.1.1. v0.7.3 (2019-08-29)
    • 23.1.2. v0.7.2 (2019-06-13)
    • 23.1.3. v0.7.1 (2019-06-12)
    • 23.1.4. v0.7.0 (2019-05-24)
  • 23.2. release_0.5 CHANGELOG
    • 23.2.1. v0.5.10 (2019-04-26)
    • 23.2.2. v0.5.9 (2019-04-01)
    • 23.2.3. v0.5.8 (2019-03-22)
    • 23.2.4. v0.5.7 (2019-03-15)
    • 23.2.5. v0.5.6 (2019-03-04)
    • 23.2.6. v0.5.5 (2019-02-15)
    • 23.2.7. v0.5.4 (2019-02-06)
    • 23.2.8. v0.5.3 (2019-01-31)
    • 23.2.9. v0.5.2 (2019-01-31)
    • 23.2.10. v0.5.1 (2019-01-29)
    • 23.2.11. v0.5.0 (2019-01-29)
  • 23.3. release_0.4 CHANGELOG
    • 23.3.1. [Unreleased]
    • 23.3.2. v0.4.1 (2019-01-09)
    • 23.3.3. v0.4.0 (2019-01-08)

Indices and tables

• Index
• Module Index
• Search Page