.. _readme:
|img_travis| |img_sr|
.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/nginx-formula.svg?branch=master :alt: Travis CI Build Status :scale: 100% :target: https://travis-ci.com/saltstack-formulas/nginx-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 NGINX <https://www.nginx.com/>
_.
.. list-table:: :name: banner-breaking-changes-v1.0.0 :header-rows: 1 :widths: 1
v1.0.0
Prior to
v1.0.0 <https://github.com/saltstack-formulas/nginx-formula/releases/tag/v1.0.0>
_,
this formula provided two methods for managing NGINX;
the old method under nginx
and the new method under nginx.ng
.
The old method has now been removed and nginx.ng
has been promoted to
be nginx
in its place.
If you are not in a position to migrate, please pin your repo to the final
release tag before
v1.0.0 <https://github.com/saltstack-formulas/nginx-formula/releases/tag/v1.0.0>
,
i.e.
v0.56.1 <https://github.com/saltstack-formulas/nginx-formula/releases/tag/v0.56.1>
.
To migrate from nginx.ng
, simply modify your pillar to promote the
entire section under nginx:ng
so that it is under nginx
instead.
So with the editor of your choice, highlight the entire section and then
unindent one level. Finish by removing the ng:
line.
To migrate from the old nginx
, first convert to nginx.ng
under
v0.56.1 <https://github.com/saltstack-formulas/nginx-formula/releases/tag/v0.56.1>
_
and then follow the steps laid out in the paragraph directly above.
.. contents:: Table of Contents
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.
Commit message formatting is significant!!
Please see How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>
_ for more details.
.. contents:: :local:
nginx
^^^^^^^^^
Meta-state for inclusion of all states.
Note: nginx requires the merge parameter of salt.modules.pillar.get(), first available in the Helium release.
nginx.pkg
^^^^^^^^^^^^^
Installs nginx from package, from the distribution repositories, the official nginx repo or the ppa from Launchpad.
nginx.src
^^^^^^^^^^^^^
Builds and installs nginx from source.
nginx.certificates
^^^^^^^^^^^^^^^^^^^^^^
Manages the deployment of nginx certificates.
nginx.config
^^^^^^^^^^^^^^^^
Manages the nginx main server configuration file.
nginx.service
^^^^^^^^^^^^^^^^^
Manages the startup and running state of the nginx service.
nginx.servers_config
^^^^^^^^^^^^^^^^^^^^^^^^
Manages virtual host files. This state only manages the content of the files and does not bind them to service calls.
nginx.servers
^^^^^^^^^^^^^^^^^
Manages nginx virtual hosts files and binds them to service calls.
nginx.passenger
^^^^^^^^^^^^^^^^^^^
Installs and configures Phusion Passenger module for nginx. You need to enable
the upstream phusion passenger repository with install_from_phusionpassenger: true
.
Nginx will also be installed from that repository, as it needs to be modified to
allow the passenger module to work.
Linux testing is done with kitchen-salt
.
Requirements ^^^^^^^^^^^^
.. 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 nginx
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.
Windows/FreeBSD/OpenBSD testing is done with kitchen-salt
.
Requirements ^^^^^^^^^^^^
Setup ^^^^^
.. code-block:: bash
$ gem install bundler $ bundle install --with=vagrant $ bin/kitchen test [platform]
Where [platform]
is the platform name defined in kitchen.vagrant.yml
,
e.g. windows-81-latest-py3
.
Note ^^^^
When testing using Vagrant you must set the environment variable KITCHEN_LOCAL_YAML
to kitchen.vagrant.yml
. For example:
.. code-block:: bash
$ KITCHEN_LOCAL_YAML=kitchen.vagrant.yml bin/kitchen test # Alternatively, $ export KITCHEN_LOCAL_YAML=kitchen.vagrant.yml $ bin/kitchen test
Then run the following commands as needed.
bin/kitchen converge
^^^^^^^^^^^^^^^^^^^^^^^^
Creates the Vagrant instance and runs the nginx
main state, ready for testing.
bin/kitchen verify
^^^^^^^^^^^^^^^^^^^^^^
Runs the inspec
tests on the actual instance.
bin/kitchen destroy
^^^^^^^^^^^^^^^^^^^^^^^
Removes the Vagrant instance.
bin/kitchen test
^^^^^^^^^^^^^^^^^^^^
Runs all of the stages above in one go: i.e. destroy
+ converge
+ verify
+ destroy
.
bin/kitchen login
^^^^^^^^^^^^^^^^^^^^^
Gives you RDP/SSH access to the instance for manual testing.