Skip to content

Commit 530e22c

Browse files
committed
docs(kitchen): update documentation
1 parent e1c68e8 commit 530e22c

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

docs/README.rst

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -103,29 +103,43 @@ Testing
103103

104104
Linux testing is done with ``kitchen-salt``.
105105

106-
``kitchen converge``
107-
^^^^^^^^^^^^^^^^^^^^
106+
Requirements
107+
^^^^^^^^^^^^
108+
109+
* Ruby
110+
* Docker
111+
112+
.. code-block:: bash
113+
114+
$ gem install bundler
115+
$ bundle install
116+
$ bin/kitchen test [platform]
117+
118+
Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
119+
e.g. ``debian-9-2019-2-py3``.
120+
121+
``bin/kitchen converge``
122+
^^^^^^^^^^^^^^^^^^^^^^^^
108123

109124
Creates the docker instance and runs the ``apt`` main state, ready for testing.
110125

111-
``kitchen verify``
112-
^^^^^^^^^^^^^^^^^^
126+
``bin/kitchen verify``
127+
^^^^^^^^^^^^^^^^^^^^^^
113128

114129
Runs the ``inspec`` tests on the actual instance.
115130

116-
``kitchen destroy``
117-
^^^^^^^^^^^^^^^^^^^
131+
``bin/kitchen destroy``
132+
^^^^^^^^^^^^^^^^^^^^^^^
118133

119134
Removes the docker instance.
120135

121-
``kitchen test``
122-
^^^^^^^^^^^^^^^^
136+
``bin/kitchen test``
137+
^^^^^^^^^^^^^^^^^^^^
123138

124139
Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.
125140

126-
``kitchen login``
127-
^^^^^^^^^^^^^^^^^
141+
``bin/kitchen login``
142+
^^^^^^^^^^^^^^^^^^^^^
128143

129144
Gives you SSH access to the instance for manual testing.
130145

131-
.. vim: fenc=utf-8 spell spl=en cc=100 tw=99 fo=want sts=2 sw=2 et

0 commit comments

Comments
 (0)