PHP Formula

Manage PHP with Salt.

Table of Contents

• General notes
• Special notes
• Configuration
• Available states
• Contributing to this repo
• Testing

General notes

See the full SaltStack Formulas installation and usage instructions.

If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.

If you want to use this formula, please pay attention to the FORMULA file and/or git tag, which contains the currently released version. This formula is versioned according to Semantic Versioning.

See Formula Versioning Section for more details.

If you need (non-default) configuration, please refer to:

• how to configure the formula with map.jinja
• the pillar.example file
• the Special notes section

Special notes

Configuration

An example pillar is provided, please see pillar.example. Note that you do not need to specify everything by pillar. Often, it's much easier and less resource-heavy to use the parameters/<grain>/<value>.yaml files for non-sensitive settings. The underlying logic is explained in map.jinja.

Available states

The following states are found in this formula:

• php
• php.package
• php.package.repo
• php.modules
• php.config
• php.fpm
• php.fpm.config
• php.fpm.ini
• php.fpm.package
• php.fpm.pools
• php.fpm.service
• php.clean
• php.package.clean
• php.package.repo.clean
• php.modules.clean
• php.config.clean
• php.fpm.clean
• php.fpm.config.clean
• php.fpm.ini.clean
• php.fpm.package.clean
• php.fpm.pools.clean
• php.fpm.service.clean

php

Meta-state.

This installs the php package, manages the php configuration file

php.package

Installs the php package only.

php.package.repo

This state will install the configured php repository. This works for apt/dnf/yum/zypper-based distributions only by default.

php.modules

Installs PHP module packages. Has a dependency on php.package.

php.config

Manages the php package configuration. Has a dependency on php.package.

php.fpm

Installs PHP-FPM, manages its configuration including pools and php.ini and starts/enables the PHP-FPM service.

php.fpm.config

Configures PHP-FPM and has a dependency on php.fpm.package.

php.fpm.ini

Manages the PHP-FPM php.ini and has a dependency on php.fpm.package.

php.fpm.package

Installs PHP-FPM and service overrides and has a dependency on php.package.

php.fpm.pools

Manages PHP-FPM pools and has a dependency on php.fpm.package.

php.fpm.service

Starts the PHP-FPM service and enables it at boot time. Has a dependency on php.fpm.config, php.fpm.ini and php.fpm.pools.

php.clean

Meta-state.

Undoes everything performed in the php meta-state in reverse order, i.e. removes the configuration file and then uninstalls the package.

php.package.clean

Removes the php package. Has a dependency on php.config.clean.

php.package.repo.clean

This state will remove the configured php repository. This works for apt/dnf/yum/zypper-based distributions only by default.

php.modules.clean

Removes PHP module packages.

php.config.clean

Removes the php package configuration.

php.fpm.clean

Undoes everything done in php.fpm in reverse order, i. e. stops/disables the PHP-FPM service, removes its configuration including managed pools and php.ini and removes the package.

php.fpm.config.clean

Removes the PHP-FPM configuration.

php.fpm.ini.clean

Removes the PHP-FPM php.ini.

php.fpm.package.clean

Removes PHP-FPM and service overrides and has a dependency on php.fpm.config.clean.

php.fpm.pools.clean

Removes all managed PHP-FPM pools.

php.fpm.service.clean

Stops the PHP-FPM service and disables it at boot time.

Contributing to this repo

Commit messages

Commit message formatting is significant!

Please see How to contribute for more details.

pre-commit

pre-commit is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes. First install the pre-commit package manager using the appropriate method, then run bin/install-hooks and now pre-commit will run automatically on each git commit.

$ bin/install-hooks
pre-commit installed at .git/hooks/pre-commit
pre-commit installed at .git/hooks/commit-msg

State documentation

There is a script that semi-autodocuments available states: bin/slsdoc.

If a .sls file begins with a Jinja comment, it will dump that into the docs. It can be configured differently depending on the formula. See the script source code for details currently.

This means if you feel a state should be documented, make sure to write a comment explaining it.

Testing

Linux testing is done with kitchen-salt.

Requirements

• Ruby
• Docker

$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]

Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.

bin/kitchen converge

Creates the docker instance and runs the php main state, ready for testing.

bin/kitchen verify

Runs the inspec tests on the actual instance.

bin/kitchen destroy

Removes the docker instance.

bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge + verify + destroy.

bin/kitchen login

Gives you SSH access to the instance for manual testing.