Create a readme for this project

[DanRoeSparks]

I thought it might be nice to have some more ansible/vagrant-related hacktoberfest issues for people to have a go at.

For this one, just add a readme explaining how to run the code, any prerequisites (e.g. ansible, python, vagrant) and so on.

Might be nice to link/give credit to the various roles used in this project, too.

There's a basic one here https://github.com/DanRoeSparks/jenkins-vagrant/blob/master/README.md to get you started

[ksandhu16]

Can I work on this !

[DanRoeSparks]

Hi there, absolutely, yes!

[ksandhu16]

Can you please elaborate more on the readme file, about how the code should be run ?

[DanRoeSparks]

Normally for Ansible you'd run a command like (at the most basic):

ansible-playbook site.yml

(See https://docs.ansible.com/ansible/2.5/user_guide/playbooks_intro.html#executing-a-playbook for more info)

However, because we're using it as a provisioner for Vagrant, all we need to do here is run the standard Vagrant commands, e.g.:

vagrant up - creates a new vagrant box and runs through the provisioning steps in the Vagrant file
vagrant provision - runs the provisioning steps against an existing Vagrant VM
vagrant suspend - shuts down the vm and saves state
vagrant resume - resumes running a previously saved VM
vagrant destroy - shuts down and removes a Vagrant VM

You can add the --provision flag to any vagrant up/resume to force a reprovisioning of the machine.

For info on how Vagrant and Ansible work together, see:

https://docs.ansible.com/ansible/2.5/scenario_guides/guide_vagrant.html
https://www.vagrantup.com/docs/provisioning/ansible.html

And again, have a look at https://github.com/DanRoeSparks/jenkins-vagrant/blob/master/README.md for a basic example.