@@ -14,8 +14,7 @@ nginx-formula
1414 :scale: 100%
1515 :target: https://github.com/semantic-release/semantic-release
1616
17- Formula to set up and configure
18- `NGINX <https://www.nginx.com/ >`_.
17+ Formula to set up and configure `NGINX <https://www.nginx.com/ >`_.
1918
2019.. list-table ::
2120 :name: banner-breaking-changes-v1.0.0
@@ -69,59 +68,89 @@ Contributing to this repo
6968Please see :ref: `How to contribute <CONTRIBUTING >` for more details.
7069
7170Available states
72- ================
71+ ----------------
7372
7473.. contents ::
7574 :local:
7675
7776``nginx ``
78- ---------
77+ ^^^^^^^^^
7978
8079Meta-state for inclusion of all states.
8180
8281**Note: ** nginx requires the merge parameter of salt.modules.pillar.get(),
8382first available in the Helium release.
8483
8584``nginx.pkg ``
86- -------------
85+ ^^^^^^^^^^^^^
8786
8887Installs nginx from package, from the distribution repositories, the official nginx repo or the ppa from Launchpad.
8988
9089``nginx.src ``
91- -------------
90+ ^^^^^^^^^^^^^
9291
9392Builds and installs nginx from source.
9493
9594``nginx.certificates ``
96- ----------------------
95+ ^^^^^^^^^^^^^^^^^^^^^^
9796
9897Manages the deployment of nginx certificates.
9998
10099``nginx.config ``
101- ----------------
100+ ^^^^^^^^^^^^^^^^
102101
103102Manages the nginx main server configuration file.
104103
105104``nginx.service ``
106- -----------------
105+ ^^^^^^^^^^^^^^^^^
107106
108107Manages the startup and running state of the nginx service.
109108
110109``nginx.servers_config ``
111- ------------------------
110+ ^^^^^^^^^^^^^^^^^^^^^^^^
112111
113112Manages virtual host files. This state only manages the content of the files
114113and does not bind them to service calls.
115114
116115``nginx.servers ``
117- -----------------
116+ ^^^^^^^^^^^^^^^^^
118117
119118Manages nginx virtual hosts files and binds them to service calls.
120119
121120``nginx.passenger ``
122- -------------------
121+ ^^^^^^^^^^^^^^^^^^^
123122
124123Installs and configures Phusion Passenger module for nginx. You need to enable
125124the upstream phusion passenger repository with `install_from_phusionpassenger: true `.
126125Nginx will also be installed from that repository, as it needs to be modified to
127126allow the passenger module to work.
127+
128+ Testing
129+ -------
130+
131+ Linux testing is done with ``kitchen-salt ``.
132+
133+ ``kitchen converge ``
134+ ^^^^^^^^^^^^^^^^^^^^
135+
136+ Creates the docker instance and runs the ``template `` main state, ready for testing.
137+
138+ ``kitchen verify ``
139+ ^^^^^^^^^^^^^^^^^^
140+
141+ Runs the ``inspec `` tests on the actual instance.
142+
143+ ``kitchen destroy ``
144+ ^^^^^^^^^^^^^^^^^^^
145+
146+ Removes the docker instance.
147+
148+ ``kitchen test ``
149+ ^^^^^^^^^^^^^^^^
150+
151+ Runs all of the stages above in one go: i.e. ``destroy `` + ``converge `` + ``verify `` + ``destroy ``.
152+
153+ ``kitchen login ``
154+ ^^^^^^^^^^^^^^^^^
155+
156+ Gives you SSH access to the instance for manual testing.
0 commit comments