Changed README to emphasize the differences with the "ng" states

This commit is contained in:
Seth House 2014-05-19 11:50:15 -06:00
parent 56a333295f
commit 3494514e46

View File

@ -51,34 +51,43 @@ Installs nginx via the source files.
Installs apache utils, and configures nginx users specified in the pillar. Installs apache utils, and configures nginx users specified in the pillar.
Next-generation, alternate approach
===================================
The following states provide an alternate approach to managing Nginx and Nginx
vhosts, as well as code organization. Please provide feedback by filing issues,
discussing in ``#salt`` in Freenode and the mailing list as normal.
``nginx.ng`` ``nginx.ng``
------------ ------------
Meta-state for inclusion of all ng states. This is a reimplementation that provides basic support for vhost management. Meta-state for inclusion of all ng states.
**Note:** nginx.ng requires the merge parameter of salt.modules.pillar.get(), first available in the Helium release. **Note:** nginx.ng requires the merge parameter of salt.modules.pillar.get(),
first available in the Helium release.
``nginx.ng.install`` ``nginx.ng.install``
~~~~~~~~~~~~~~~~~~~~ --------------------
Installs the nginx package. Installs the nginx package.
``nginx.ng.config`` ``nginx.ng.config``
~~~~~~~~~~~~~~~~~~~ -------------------
Manages the nginx main server configuration file. Manages the nginx main server configuration file.
``nginx.ng.service`` ``nginx.ng.service``
~~~~~~~~~~~~~~~~~~~~ --------------------
Manages the startup and running state of the nginx service. Manages the startup and running state of the nginx service.
``nginx.ng.vhosts_config`` ``nginx.ng.vhosts_config``
~~~~~~~~~~~~~~~~~~~~~~~~~~ --------------------------
Manages virtual host files. This state only manages the content of the files and does not bind them to service calls. Manages virtual host files. This state only manages the content of the files
and does not bind them to service calls.
``nginx.ng.vhosts`` ``nginx.ng.vhosts``
~~~~~~~~~~~~~~~~~~~ -------------------
Manages nginx virtual hosts files and binds them to service calls. Manages nginx virtual hosts files and binds them to service calls.