Browse Source

docs(kitchen): update documentation

tags/v0.8.1
Javier Bértoli 5 years ago
parent
commit
530e22cc0a
1 changed files with 25 additions and 11 deletions
  1. +25
    -11
      docs/README.rst

+ 25
- 11
docs/README.rst View File



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


``kitchen converge``
^^^^^^^^^^^^^^^^^^^^
Requirements
^^^^^^^^^^^^

* Ruby
* Docker

.. 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 ``apt`` main state, ready for testing. Creates the docker instance and runs the ``apt`` main state, ready for testing.


``kitchen verify``
^^^^^^^^^^^^^^^^^^
``bin/kitchen verify``
^^^^^^^^^^^^^^^^^^^^^^


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


``kitchen destroy``
^^^^^^^^^^^^^^^^^^^
``bin/kitchen destroy``
^^^^^^^^^^^^^^^^^^^^^^^


Removes the docker instance. Removes the docker instance.


``kitchen test``
^^^^^^^^^^^^^^^^
``bin/kitchen test``
^^^^^^^^^^^^^^^^^^^^


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


``kitchen login``
^^^^^^^^^^^^^^^^^
``bin/kitchen login``
^^^^^^^^^^^^^^^^^^^^^


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


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

Loading…
Cancel
Save