saltstack-formulas/salt-formula
Template
2
0
Fork 0
Code Releases Activity

docs(readme): add Testing with Vagrant section

Browse Source
This commit is contained in:
Imran Iqbal 2021-03-26 14:59:56 +00:00
parent 163c77fcee
commit ef1bc02a86
No known key found for this signature in database
GPG Key ID: 6D8629439D2B7819
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/README.rst
View File

@ -255,7 +255,7 @@ Gives you SSH access to the instance for manual testing.
Testing with Vagrant
--------------------
Windows testing is done with ``kitchen-salt``.
Windows/FreeBSD/OpenBSD testing is done with ``kitchen-salt``.
Requirements
^^^^^^^^^^^^
@ -273,8 +273,8 @@ Setup
$ bundle install --with=vagrant
$ bin/kitchen test [platform]
Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
e.g. ``windows``.
Where ``[platform]`` is the platform name defined in ``kitchen.vagrant.yml``,
e.g. ``windows-81-latest-py3``.
Note
^^^^
@ -292,7 +292,7 @@ Then run the following commands as needed.
``bin/kitchen converge``
^^^^^^^^^^^^^^^^^^^^^^^^
Creates the Vagrant instance and runs the ``salt.minion`` main state, ready for testing.
Creates the Vagrant instance and runs the ``salt`` main states, ready for testing.
``bin/kitchen verify``
^^^^^^^^^^^^^^^^^^^^^^
@ -312,4 +312,4 @@ Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``veri
``bin/kitchen login``
^^^^^^^^^^^^^^^^^^^^^
Gives you RDP access to the instance for manual testing.
Gives you RDP/SSH access to the instance for manual testing.