jalle19 / haphproxy
A HAProxy configuration parser for PHP
Installs: 6 440
Dependents: 0
Suggesters: 0
Security: 0
Stars: 6
Watchers: 2
Forks: 2
Open Issues: 0
Requires
- php: >=5.6.0
Requires (Dev)
- phpunit/phpunit: ^5.4
- symfony/process: ^3.1
README
haphproxy is a PHP library which can parse and create HAproxy configuration files.
The library operates on the configuration at a low level. A configuration is made up of sections (e.g. global
and
default
). Each section is made up of parameters (e.g. mode
and timeout
). Each parameter has a value associated
with it, e.g. a parameter named timeout
can have a value of timeout 30s
.
Since the library doesn't actually understand how HAproxy works, it is only guaranteed to generate syntactically valid
configurations. For proper validation, please use haproxy -f <configurationFile> -c
.
Requirements
- PHP 5.6 or newer
Installation
Install via Composer:
composer require jalle19/haphproxy
Usage
Reading a configuration
This example reads an existing configuration file, parses it and dumps it back as a string:
// Create a parser try { $parser = new Parser('/etc/haproxy/haproxy.cfg'); } catch (FileNotFoundException $e) { die($e->getMessage()); } // Parse and dump the configuration $configuration = $parser->parse(); $writer = new Writer($configuration); echo $writer->dump();
Writing a configuration
This example shows how you can dynamically create a configuration:
$configuration = new Configuration(); // Add a global section $globalSection = new Section\GlobalSection(); $globalSection->addParameter(new Parameter('daemon')) ->addParameter(new Parameter('maxconns', 128)); $configuration->addSection($globalSection); // Add a defaults section $defaultsSection = new Section\DefaultsSection(); $defaultsSection->addParameter(new Parameter('mode', 'http')); $configuration->addSection($defaultsSection); // Dump the configuration $writer = new Writer($configuration); echo $writer->dump();
The above results in the following configuration being generated:
# Generated with Jalle19\haphproxy
global
daemon
maxconns 128
defaults
mode http
Changing the output formatting
You can change the indentation and preface of the generated configuration. Changing the preface may be useful when used in combination with other tools to indicate whether the configuration file has been generated dynamically or not.
$configuration = new Configuration(); $writer = new Writer($configuration); // Remember to include the comment character in the preface $writer->setPreface('# AUTOGENERATED, DO NOT EDIT MANUALLY'); $writer->setIndent(' '); echo $writer->dump();
Inspecting a configuration
You can access the individual parameters of each section like this:
// Make a section with some parameters $section = new Section\DefaultsSection(); $section->addParameter(new Parameter('mode', 'http')); $section->addParameter(new Parameter('timeout', 'client 30s')); $section->addParameter(new Parameter('timeout', 'connect 30s')); $section->addParameter(new Parameter('timeout', 'server 30s')); // Get the value of a single parameter $modeParameter = $section->getParameter('mode'); $mode = $modeParameter->getValue(); // Loop through all the "timeout" parameters foreach ($section->getParametersByName('timeout') as $timeoutParameter) { }
You can also loop through specific sections of a configuration:
$configuration = new Configuration(); $configuration->addSection(new FrontendSection('frontend frontend-1')); $configuration->addSection(new FrontendSection('frontend frontend-2')); $configuration->addSection(new FrontendSection('frontend frontend-3')); foreach ($configuration->getFrontendSections() as $frontendSection) { }
Magic comments
A magic comment is a comment that beings with HAPHPROXY_COMMENT
. In contrast to normal comments, these are not
omitted during parsing and writing. Magic comments only apply to sections and can be useful to store arbitrary data.
$configuration = new Configuration(); $section = new Section\DefaultsSection(); $section->addMagicComment('magic'); $section->addParameter(new Parameter('mode', 'http')); $writer = new Writer($configuration); echo $writer->dump();
The above results in the following configuration being generated:
# Generated with Jalle19\haphproxy
defaults
# HAPHPROXY_COMMENT magic
mode http
Testing
The test suite leaves all the validation of the generated configurations to HAproxy itself, so in order to run the test
suite you'll need to have haproxy
in your path. To run the test suite, run php vendor/bin/phpunit
.
There is a Vagrantfile
shipped with the library which automatically provisions itself with all the required software.
License
This library is licensed under the GNU General Public License 2 or newer