1
0
Fork 0
docker-easy-haproxy/docs/Plugins/cleanup.md
Joao Gilberto Magalhaes 045dd3817e Migrate configuration paths to /etc/easyhaproxy and improve health check support in E2E tests
- Refactored HAProxy configuration files, templates, and paths to use `/etc/easyhaproxy` instead of `/etc/haproxy`.
- Updated Dockerfile to generate DH params and placeholder certificates in the new configuration directory.
- Added health check support with timeout to `DockerComposeFixture` in E2E test utilities.
- Adjusted tests, templates, and plugins to use the new `Consts`-based configuration paths.
- Introduced pytest fixtures for environment isolation and temporary directory management.
2026-02-15 14:32:16 -05:00

2.8 KiB

sidebar_position
21

Cleanup Plugin

Type: Global Plugin Runs: Once per discovery cycle

Overview

The Cleanup plugin performs cleanup tasks during each discovery cycle, such as removing old temporary files.

Why Use It

Prevents disk space issues by automatically cleaning up temporary files created by EasyHAProxy.

Configuration Options

Option Description Default
enabled Enable/disable plugin true
max_idle_time Maximum age in seconds before deleting files 300
cleanup_temp_files Enable temp file cleanup true

Configuration Examples

Static YAML Configuration

# /etc/easyhaproxy/static/config.yaml
plugins:
  enabled: [cleanup]
  config:
    cleanup:
      max_idle_time: 600
      cleanup_temp_files: true

Environment Variables

Configure the Cleanup plugin globally:

Environment Variable Config Key Type Default Description
EASYHAPROXY_PLUGINS_ENABLED - string - Enable cleanup plugin (value: cleanup)
EASYHAPROXY_PLUGIN_CLEANUP_ENABLED enabled boolean true Enable/disable plugin
EASYHAPROXY_PLUGIN_CLEANUP_MAX_IDLE_TIME max_idle_time integer 300 Maximum age in seconds before deleting files
EASYHAPROXY_PLUGIN_CLEANUP_CLEANUP_TEMP_FILES cleanup_temp_files boolean true Enable temp file cleanup

Note: This is a global plugin - configuration applies to the entire system.

Custom Idle Time (1 hour)

# /etc/easyhaproxy/static/config.yaml
plugins:
  enabled: [cleanup]
  config:
    cleanup:
      enabled: true
      max_idle_time: 3600  # 1 hour

How It Works

The cleanup plugin:

  • Runs once during each discovery cycle
  • Scans temporary directories for old files
  • Removes files older than max_idle_time seconds
  • Helps maintain disk space efficiency

Important Notes

  • This is a global plugin - it runs once per discovery cycle, not per domain
  • Does not generate HAProxy configuration
  • Performs maintenance operations in the background
  • Safe to enable in production environments