|
1 | | -.. _readme: |
2 | | - |
3 | 1 | docker-formula |
4 | 2 | ============== |
5 | 3 |
|
@@ -47,10 +45,10 @@ Contributing to this repo |
47 | 45 |
|
48 | 46 | **Commit message formatting is significant!!** |
49 | 47 |
|
50 | | -Please see :ref:`How to contribute <CONTRIBUTING>` for more details. |
| 48 | +Please see `How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>`_ for more details. |
51 | 49 |
|
52 | 50 | Available Meta states |
53 | | ----------------------- |
| 51 | +--------------------- |
54 | 52 |
|
55 | 53 | .. contents:: |
56 | 54 | :local: |
@@ -90,8 +88,8 @@ This state installs Docker (see https://docs.docker.com/engine/install and https |
90 | 88 |
|
91 | 89 | This state installs Dockerd daemon on Linux (systemd support). |
92 | 90 |
|
93 | | -``docker.software.service`` |
94 | | -^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 91 | +``docker.software.service.clean`` |
| 92 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
95 | 93 |
|
96 | 94 | This state stops Dockerd daemon on Linux (systemd support). |
97 | 95 |
|
@@ -233,7 +231,7 @@ Saltstack `swarm module` state support (See https://docs.saltstack.com/en/latest |
233 | 231 | Opposite of `docker.swarm` state (See https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.swarm.html). |
234 | 232 |
|
235 | 233 | ``docker.networks`` |
236 | | -^^^^^^^^^^^^^^^^^^ |
| 234 | +^^^^^^^^^^^^^^^^^^^ |
237 | 235 |
|
238 | 236 | Create docker networks |
239 | 237 |
|
@@ -270,27 +268,26 @@ Where ``[platform]`` is the platform name defined in ``kitchen.yml``, |
270 | 268 | e.g. ``debian-9-2019-2-py3``. |
271 | 269 |
|
272 | 270 | ``bin/kitchen converge`` |
273 | | -^^^^^^^^^^^^^^^^^^^^ |
| 271 | +^^^^^^^^^^^^^^^^^^^^^^^^ |
274 | 272 |
|
275 | 273 | Creates the Docker instance and runs the ``docker`` main state, ready for testing. |
276 | 274 |
|
277 | 275 | ``bin/kitchen verify`` |
278 | | -^^^^^^^^^^^^^^^^^^ |
| 276 | +^^^^^^^^^^^^^^^^^^^^^^ |
279 | 277 |
|
280 | 278 | Runs the ``inspec`` tests on the actual instance. |
281 | 279 |
|
282 | 280 | ``bin/kitchen destroy`` |
283 | | -^^^^^^^^^^^^^^^^^^^ |
| 281 | +^^^^^^^^^^^^^^^^^^^^^^^ |
284 | 282 |
|
285 | 283 | Removes the Docker instance. |
286 | 284 |
|
287 | 285 | ``bin/kitchen test`` |
288 | | -^^^^^^^^^^^^^^^^ |
| 286 | +^^^^^^^^^^^^^^^^^^^^ |
289 | 287 |
|
290 | 288 | Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``. |
291 | 289 |
|
292 | 290 | ``bin/kitchen login`` |
293 | | -^^^^^^^^^^^^^^^^^ |
| 291 | +^^^^^^^^^^^^^^^^^^^^^ |
294 | 292 |
|
295 | 293 | Gives you SSH access to the instance for manual testing. |
296 | | - |
0 commit comments