MFDATA documentation¶

Table of Contents¶

1. What is it?
2. What is not in?
3. Quickstart
- 3.1. Installation
- 3.2. Usage
4. Installation guide
- 4.1. Prerequisites
- 4.2. Configure the metwork RPM repository
- 4.3. How to install mfdata metwork module
- 4.4. How to uninstall mfdata module
- 4.5. How to uninstall all metwork modules
- 4.6. How to upgrade all metwork modules (for a patch update)
- 4.7. How to upgrade all metwork modules (for a major/minor update)
- 4.8. How to start all metwork modules (after installation)
- 4.9. How to stop all metwork modules (after installation)
- 4.10. How to get the status of all metwork modules (after installation)
5. How to configure mfdata metwork module ?
- 5.1. General
6. Loading MFDATA environment
- 6.1. General
- 6.2. Activate MFDATA environment by logging in as mfdata user.
- 6.3. Activate MFDATA environment from any user.
- 6.4. Activate MFDATA for one command only from any user.
- 6.5. Miscellaneous
7. Quick Start
- 7.1. Activate the MFDATA environment
- 7.2. Create your first plugin
- 7.3. Use of the ungzip plugin
8. How to create custom plugins
- 8.1. Create and customize the plugin
- 8.2. Plugin templates
9. Debug a plugin
- 9.1. Log level
- 9.2. Run the plugin as an independent unit
10. Release and Deploy a plugin
- 10.1. Release a plugin
- 10.2. Deploy a plugin in a production environment
  - 10.2.1. The ‘basic’ way
  - 10.2.2. The ‘well-done’ way
- 10.3. Override a plugin configuration
11. How it works ?
12. Additional Tutorials
- 12.1. A PNG to JPEG conversion plugin
- 12.2. Sending a file by FTP
- 12.3. Create a plugin from scratch
- 12.4. Creating a batch plugin
- 12.5. Implement custom monitoring and metrics in a plugin
13. Identify particular types of files
- 13.1. Introduction
- 13.2. Example:
14. Miscellaneous
- 14.1. The switch_logical_condition field
- 14.2. The switch plugin tags attributes
- 14.3. The .layerapi2_dependencies file
- 14.4. The .layerapi2_extra_env file
- 14.5. Inject data files in HTTP
- 14.6. Trigger MFDATA plugins with MQTT messages
- 14.7. AMQP incoming messages support
- 14.8. Plugins with more than one step
- 14.9. The outside Metwork command
- 14.10. The crontab support
- 14.11. Extra daemon
- 14.12. Access a database
15. MFDATA Log
- 15.1. Default logs files
- 15.2. Custom logs files
  - 15.2.1. Classic Python logger
  - 15.2.2. Metwork MFLOG logger
16. Tuning, Monitoring and Dashboard
- 16.1. Tuning
- 16.2. Monitoring and Dashboards
17. XATTRFILE API
- 17.1. XattrFile class
- 17.2. Misc
18. ACQUISITION API
- 18.1. AcquisitionStep class
- 18.2. AcquisitionBatchStep class
- 18.3. AcquisitionListener class
- 18.4. Acquisition decorators
19. Available layers
- 19.1. Layer root
  - 19.1.1. Overview
- 19.2. Special focus on python wrappers
- 19.3. Layer python3
- 19.4. Layer python2
- 19.5. Layer default
20. CHANGELOGs
- 20.1. release_0.9 CHANGELOG
- 20.2. release_0.8 CHANGELOG
- 20.3. release_0.7 CHANGELOG
- 20.4. release_0.6 CHANGELOG
- 20.5. release_0.5 CHANGELOG
- 20.6. release_0.4 CHANGELOG

Indices and tables¶