Du kan inte välja fler än 25 ämnen
Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
15KB
15KB
.. _readme:
php-formula
===========
|img_travis| |img_sr|
.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/php-formula.svg?branch=master
:alt: Travis CI Build Status
:scale: 100%
:target: https://travis-ci.com/saltstack-formulas/php-formula
.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
:alt: Semantic Release
:scale: 100%
:target: https://github.com/semantic-release/semantic-release
Formula to set up and configure php
.. list-table::
:name: banner-breaking-changes-v1.0.0
:header-rows: 1
:widths: 1
* - WARNING: BREAKING CHANGES IN UPCOMING ``v1.0.0``
* - This formula currently provides two methods for managing PHP; the old method
under ``php`` and the new method under ``php.ng``.
In upcoming `v1.0.0 <https://github.com/saltstack-formulas/php-formula/releases/tag/v1.0.0>`_,
the old method will be removed and ``php.ng`` will be promoted to ``php`` in its place.
If you are not in a position to migrate, you will need to pin your repo to
the final release tag before
`v1.0.0 <https://github.com/saltstack-formulas/php-formula/releases/tag/v1.0.0>`_,
which is expected to be
`v0.39.2 <https://github.com/saltstack-formulas/php-formula/releases/tag/v0.39.2>`_.
If you are currently using ``php.ng``, there is nothing to do until
`v1.0.0 <https://github.com/saltstack-formulas/php-formula/releases/tag/v1.0.0>`_
is released.
To migrate from the old ``php``, the first step is to convert to ``php.ng``,
before `v1.0.0 <https://github.com/saltstack-formulas/php-formula/releases/tag/v1.0.0>`_
is released.
.. contents:: **Table of Contents**
General notes
-------------
See the full `SaltStack Formulas installation and usage instructions
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.
If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas>`_.
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 <http://semver.org/>`_.
See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>`_ for more details.
Contributing to this repo
-------------------------
**Commit message formatting is significant!!**
Please see :ref:`How to contribute <CONTRIBUTING>` for more details.
Available states
----------------
.. contents::
:local:
``php``
^^^^^^^
Installs the php package.
``php.adodb``
^^^^^^^^^^^^^
Installs the php-adodb package.
``php.apc``
^^^^^^^^^^^
Installs the php-apc package.
Disabled by default on opensuse need server:php repo
``php.apcu``
^^^^^^^^^^^^
Installs the php-apcu package.
Disabled by default on opensuse need server:php repo
``php.bcmath``
^^^^^^^^^^^^^^
Installs the php-bcmath package.
``php.cgi``
^^^^^^^^^^^
Installs the php-cgi package.
Disabled on opensuse not available, only fastcgi
``php.cli``
^^^^^^^^^^^
Installs the php-cli package.
``php.composer``
^^^^^^^^^^^^^^^^
Installs [composer](https://getcomposer.org) and keeps it updated.
``php.curl``
^^^^^^^^^^^^
Installs the php5-curl package on Debian, and ensures that curl itself is
installed for RedHat systems, this is due to the curl libs being provided by
php-common, which will get installed with the main php package.
``php.dev``
^^^^^^^^^^^
Installs the php-dev package.
``php.fileinfo``
^^^^^^^^^^^^^^^^
Installs the php-fileinfo package and enables it.
``php.fpm``
^^^^^^^^^^^
Installs the php-fpm package, starts the service, and enables it.
``php.gd``
^^^^^^^^^^
Installs the php-gd package.
``php.imagick``
^^^^^^^^^^^^^^^
Installs the php-imagick package.
Disabled on opensuse not available.
``php.imap``
^^^^^^^^^^^^
Installs the php-imap package.
``php.intl``
^^^^^^^^^^^^
Installs the php-intl package.
``php.json``
^^^^^^^^^^^^
Installs the php-json package.
``php.ldap``
^^^^^^^^^^^^
Installs the php-ldap package.
``php.mail``
^^^^^^^^^^^^
Installs the php-mail package.
``php.mbstring``
^^^^^^^^^^^^^^^^
Installs the php-mbstring package.
``php.mcrypt``
^^^^^^^^^^^^^^
Installs the php-mcrypt package.
``php.memcache``
^^^^^^^^^^^^^^^^
Installs the php-memcache package.
Disabled on opensuse need server:php:extensions repo
``php.memcached``
^^^^^^^^^^^^^^^^^
Installs the php-memcached package.
Disabled on opensuse need server:php:extensions repo
``php.mongo``
^^^^^^^^^^^^^
Installs the php-mongo package.
Disabled on opensuse need server:php:extensions repo
``php.mysql``
^^^^^^^^^^^^^
Installs the php-mysql package.
``php.mysqlnd``
^^^^^^^^^^^^^^^
Installs the php-mysqlnd package.
Disabled on opensuse no package.
``php.oauth``
^^^^^^^^^^^^^
Installs the php-oauth package.
``php.pear``
^^^^^^^^^^^^
Installs the php-pear package.
``php.pgsql``
^^^^^^^^^^^^^
Installs the php-pgsql package.
``php.readline``
^^^^^^^^^^^^^^^^
Installs the php-readline package.
``php.redis``
^^^^^^^^^^^^^
Installs the php-redis package.
Disabled on opensuse need server:php:extensions repo
``php.soap``
^^^^^^^^^^^^
Installs the php-soap package.
``php.sqlite``
^^^^^^^^^^^^^^
Installs the php-sqlite package,
``php.suhosin``
^^^^^^^^^^^^^^^
Installs the php-suhosin package.
``php.sybase``
^^^^^^^^^^^^^^
Installs the php-sybase package for Sybase/MS-SQL. Debian / Ubuntu as RedHat has no similar package.
``php.tokenizer``
^^^^^^^^^^^^^^^^^
Installs the php-tokenizer package and enables it.
``php.xml``
^^^^^^^^^^^
Installs the php-xml package.
``php.zip``
^^^^^^^^^^^
Installs the php-zip package.
Next-generation, alternate approach
-----------------------------------
The following states provide an alternate approach to managing PHP and FPM
pools, as well as code organization. Please provide feedback by filing issues,
discussing in ``#salt`` in Freenode and the mailing list as normal.
**Note:** php.ng states require the merge parameter of salt.modules.pillar.get(),
first available in the Helium release.
.. contents::
:local:
``php.ng``
^^^^^^^^^^
Installs the php package.
``php.ng.adodb``
^^^^^^^^^^^^^^^^
Installs the php-adodb package.
``php.ng.apache2``
^^^^^^^^^^^^^^^^^^
Meta-state that combines `php.ng.apache2.install`_ and `php.ng.apache2.ini`_.
``php.ng.apache2.ini``
^^^^^^^^^^^^^^^^^^^^^^
Manages the apache2 php.ini file
``php.ng.apache2.install``
^^^^^^^^^^^^^^^^^^^^^^^^^^
Installs the apache2 and libapache2-mod-php5 package. Debian Only.
``php.ng.apc``
^^^^^^^^^^^^^^
Installs the php-apc package.
Disabled on opensuse need server:php repo
``php.ng.apcu``
^^^^^^^^^^^^^^^
Installs the php-apcu package.
Disabled on opensuse need server:php repo
``php.ng.auth-sasl``
^^^^^^^^^^^^^^^^^^^^
Installs the php-auth-sasl package.
``php.ng.bcmath``
^^^^^^^^^^^^^^^^^
Installs the php-bcmath package.
``php.ng.bz2``
^^^^^^^^^^^^^^
Installs the php-bz2 package.
``php.ng.cache-lite``
^^^^^^^^^^^^^^^^^^^^^
Installs the php-cache-lite package.
``php.ng.cgi``
^^^^^^^^^^^^^^
Installs the php-cgi package.
Disabled on opensuse only php5-fastcgi available.
``php.ng.cli``
^^^^^^^^^^^^^^
Meta-state that combines `php.ng.cli.install`_ and `php.ng.cli.ini`_.
``php.ng.cli.ini``
^^^^^^^^^^^^^^^^^^
Manages the php-cli ini file.
``php.ng.cli.install``
^^^^^^^^^^^^^^^^^^^^^^
Installs the php-cli package.
``php.ng.composer``
^^^^^^^^^^^^^^^^^^^
Installs [composer](https://getcomposer.org) and keeps it updated.
``php.ng.console-table``
^^^^^^^^^^^^^^^^^^^^^^^^
Installs the php-console-table package.
``php.ng.ctype``
^^^^^^^^^^^^^^^^
Installs the php-ctype package.
``php.ng.curl``
^^^^^^^^^^^^^^^
Installs the php5-curl package on Debian, and ensures that curl itself is
installed for RedHat systems, this is due to the curl libs being provided by
php-common, which will get installed with the main php package.
``php.ng.dba``
^^^^^^^^^^^^^^
Installs the php-dba package.
``php.ng.dev``
^^^^^^^^^^^^^^
Installs the php5-dev and build-essential package.
``php.ng.filter``
^^^^^^^^^^^^^^^^^
Installs the php-filter package.
``php.ng.fpm``
^^^^^^^^^^^^^^
Meta-state that combines all php.ng.fpm states.
``php.ng.fpm.config``
^^^^^^^^^^^^^^^^^^^^^
Manages the (non-pool) php-fpm config files.
``php.ng.fpm.install``
^^^^^^^^^^^^^^^^^^^^^^
Installs the php-fpm package.
``php.ng.fpm.pools``
^^^^^^^^^^^^^^^^^^^^
Meta-state that combines `php.ng.fpm.service`_ and `php.ng.fpm.pools_config`_
``php.ng.fpm.pools_config``
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Manages php-fpm pool config files.
``php.ng.fpm.service``
^^^^^^^^^^^^^^^^^^^^^^
Manages the php-fpm service.
``php.ng.gd``
^^^^^^^^^^^^^
Installs the php-gd package.
``php.ng.gearman``
^^^^^^^^^^^^^^^^^^
Installs the php-gearman package.
``php.ng.geoip``
^^^^^^^^^^^^^^^^
Installs the php-geoip package.
``php.ng.geshi``
^^^^^^^^^^^^^^^^
Installs the php-geshi package.
``php.ng.gettext``
^^^^^^^^^^^^^^^^^^
Installs the php-gettext package.
``php.ng.gmp``
^^^^^^^^^^^^^^
Installs the php-gmp package. Debian Only.
``php.ng.hash``
^^^^^^^^^^^^^^^
Installs the php-hash package.
``php.ng.http``
^^^^^^^^^^^^^^^
Installs the php-http package.
``php.ng.hhvm``
^^^^^^^^^^^^^^^
Meta-state that combines php.ng.hhvm states
``php.ng.hhvm.config``
^^^^^^^^^^^^^^^^^^^^^^
Manages the php-hhvm config files
``php.ng.hhvm.install``
^^^^^^^^^^^^^^^^^^^^^^^
Installs the php-hhvm package
``php.ng.hhvm.repo``
^^^^^^^^^.REPO^^^^^^
Configures the hhvm repo for debian/ubuntu
``php.ng.hhvm.service``
^^^^^^^^^^^^^^^^^^^^^^^
Manages the php-hhvm service.
``php.ng.igbinary``
^^^^^^^^^^^^^^^^^^^
Installs the php-igbinary package.
``php.ng.imagick``
^^^^^^^^^^^^^^^^^^
Installs the php-imagick package.
Disabled on opensuse no package.
``php.ng.imap``
^^^^^^^^^^^^^^^
Installs the php-imap package.
``php.ng.intl``
^^^^^^^^^^^^^^^
Installs the php-intl package.
``php.ng.json``
^^^^^^^^^^^^^^^
Installs the php-json package.
``php.ng.ldap``
^^^^^^^^^^^^^^^
Installs the php-ldap package.
``php.ng.mail``
^^^^^^^^^^^^^^^
Installs the php-mail package.
``php.ng.mbstring``
^^^^^^^^^^^^^^^^^^^
Installs the php-mbstring package.
``php.ng.mcrypt``
^^^^^^^^^^^^^^^^^
Installs the php-mcrypt package.
``php.ng.mdb2``
^^^^^^^^^^^^^^^
Installs the php-mdb2 package.
``php.ng.mdb2-driver-mysql``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Installs the php-mdb2-driver-mysql package.
``php.ng.mdb2-driver-pgsql``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Installs the php-mdb2-driver-pgsql package.
``php.ng.memcache``
^^^^^^^^^^^^^^^^^^^
Installs the php-memcache package.
Disabled on opensuse need server:php:extensions repo
``php.ng.memcached``
^^^^^^^^^^^^^^^^^^^^
Installs the php-memcached package.
Disabled on opensuse need server:php:extensions repo
``php.ng.modules``
^^^^^^^^^^^^^^^^^^
Calls ``php.ng.<name>`` for each entry in ``php:ng:modules`` if available, or
try to install the matching packages that can be set via from
``php:ng:lookup:pkgs``
``php.ng.mongo``
^^^^^^^^^^^^^^^^
Installs the php-mongo package.
``php.ng.mongodb``
^^^^^^^^^^^^^^^^^^
Installs the php-mongodb package.
``php.ng.msgpack``
^^^^^^^^^^^^^^^^^^
Installs the php-msgpack package.
``php.ng.mysql``
^^^^^^^^^^^^^^^^
Installs the php-mysql package.
``php.ng.mysqlnd``
^^^^^^^^^^^^^^^^^^
Installs the php-mysqlnd package.
Disabled on opensuse no package.
``php.ng.net-smtp``
^^^^^^^^^^^^^^^^^^^
Installs the php-net-smtp package.
``php.ng.net4``
^^^^^^^^^^^^^^^
Installs the php-net4 package.
``php.ng.net6``
^^^^^^^^^^^NET6
Installs the php-net6 package.
``php.ng.oauth``
^^^^^^^^^^^^^^^^
Installs the php-oauth package.
``php.ng.opcache``
^^^^^^^^^^^^^^^^^^
Installs the php-opcache package.
``php.ng.openssl``
^^^^^^^^^^^^^^^^^^
Installs the php-openssl package.
``php.ng.pear``
^^^^^^^^^^^^^^^
Installs the php-pear package.
``php.ng.pgsql``
^^^^^^^^^^^^^^^^
Installs the php-pgsql package.
``php.ng.phar``
^^^^^^^^^^^^^^^
Installs the php-phar package.
``php.ng.posix``
^^^^^^^^^^^^^^^^
Installs the php-posix package.
``php.ng.pspell``
^^^^^^^^^^^^^^^^^
Installs the php-pspell package.
``php.ng.readline``
^^^^^^^^^^^^^^^^^^^
Installs the php-readline package.
``php.ng.redis``
^^^^^^^^^^^^^^^^
Installs the php-redis package.
Disabled on opensuse need server:php:extensions repo
``php.ng.seclib``
^^^^^^^^^^^^^^^^^
Installs the php-seclib package.
``php.ng.session``
^^^^^^^^^^^^^^^^^^
Installs the php-session package.
``php.ng.snmp``
^^^^^^^^^^^^^^^
Installs the php-snmp package.
``php.ng.soap``
^^^^^^^^^^^^^^^
Installs the php-soap package.
``php.ng.sqlite``
^^^^^^^^^^^^^^^^^
Installs the php-sqlite package,
``php.ng.ssh2``
^^^^^^^^^^^^^^^
Installs the php-ssh2 package,
``php.ng.suhosin``
^^^^^^^^^^^^^^^^^^
Installs the php-suhosin package.
``php.ng.svn``
^^^^^^^^^^^^^^
Installs the php-svn package.
``php.ng.sybase``
^^^^^^^^^^^^^^^^^
Installs the php-sybase package.
``php.ng.tcpdf``
^^^^^^^^^^^^^^^^
Installs the php-tcpdf package.
``php.ng.tidy``
^^^^^^^^^^^^^^^
Installs the php-tidy package.
``php.ng.uuid``
^^^^^^^^^^^^^^^
Installs the php-uuid package.
``php.ng.xcache``
^^^^^^^^^^^^^^^^^
Meta-state that combines `php.ng.xcache.install`_ and `php.ng.xcache.ini`_.
``php.ng.xcache.ini``
^^^^^^^^^^^^^^^^^^^^^
Manages the php-xcache ini file
``php.ng.xcache.install``
^^^^^^^^^^^^^^^^^^^^^^^^^
Installs the php-xcache package.
Disabled on opensuse need server:php:extensions repo
``php.ng.xdebug``
^^^^^^^^^^^^^^^^^
Installs the php-xdebug package.
``php.ng.xml``
^^^^^^^^^^^^^^
Installs the php-xml package.
``php.ng.xsl``
^^^^^^^^^^^^^^
Installs the php-xsl package.
``php.ng.zip``
^^^^^^^^^^^^^^
Installs the php-zip package.
Testing
-------
Linux testing is done with ``kitchen-salt``.
Requirements
^^^^^^^^^^^^
* Ruby
* Docker
.. code-block:: bash
$ 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 ``template`` 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.