diff --git a/docs/README.rst b/docs/README.rst index 9cfde81..5278cc9 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -149,28 +149,42 @@ Testing 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``. -Creates the docker instance and runs the ``template`` main state, ready for testing. +``bin/kitchen converge`` +^^^^^^^^^^^^^^^^^^^^^^^^ -``kitchen verify`` -^^^^^^^^^^^^^^^^^^ +Creates the docker instance and runs the ``fail2ban`` main state, ready for testing. + +``bin/kitchen verify`` +^^^^^^^^^^^^^^^^^^^^^^ Runs the ``inspec`` tests on the actual instance. -``kitchen destroy`` -^^^^^^^^^^^^^^^^^^^ +``bin/kitchen destroy`` +^^^^^^^^^^^^^^^^^^^^^^^ Removes the docker instance. -``kitchen test`` -^^^^^^^^^^^^^^^^ +``bin/kitchen test`` +^^^^^^^^^^^^^^^^^^^^ 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. -