Commit e66dad52 authored by Leonardo Galli's avatar Leonardo Galli

docs

parent 05399e70
......@@ -42,7 +42,7 @@ Installing ansible should be extremely simple, just run the following (on your h
pip3 install ansible
----
**Note:** On some operating systems you probably need to run this as root / with sudo (`sudo pip3 install ansible`)
NOTE: On some operating systems you probably need to run this as root / with sudo (`sudo pip3 install ansible`)
== Cloning the Repository
......
......@@ -35,4 +35,45 @@ Currently we have the following different virtual machines:
| 10.10.20.29
|===
Each Virtual Machine also has a specific ip address (based on their libc version), making it easier to access.
\ No newline at end of file
Each Virtual Machine also has a specific ip address (based on their libc version), making it easier to access.
== Creating / Starting the Virtual Machine
You create the virtual machine the same way as starting it!
This makes your life easier, as you only have to remember one command ;)
Running `vagrant up name` (so for e.g. libc version 27: `vagrant up 27`) starts up the virtual machine with the given name.
This should automatically create any networks, configure the virtual machine in VirtualBox, etc.
Furthermore, at the end of the startup process, you should see something like `Running provisioner ansible...` and then a lot of debug output.
This means, that vagrant is setting up everything inside the virtual machine, such as installing packages (vagrant calls this provisioning).
If you do not see any provisioning output and this is your first time starting this virtual machine, you have to manually provision it (See the next section).
== Provisioning the Virtual Machine
If vagrant did not provision the machine on first boot or you screwed something up and want to install default packages again, you need to run the following command:
[source,bash]
----
vagrant provision name
----
(Again, name refers to the name of the virtual machine, for example 27)
NOTE: If you really screwed something up, it might be easier to first destroy the virtual machine and then just start it again.
To destroy the machine, run `vagrant destroy name`.
WARNING: If you destroy the virtual machine, anything not saved in a shared folder will be lost!
== Turning the Virtual Machine Off
Turning the virtual machine off, can either be done when sshd into it, by just running `sudo poweroff`, or running `vagrant halt name`.
== Updating the Virtual Machine
If something is changed or added to the setup, you can easily update the Virtual Machine, by doing the following:
1. Pull the latest changes: Inside this repository, run `git pull`.
2. Possibly adjust any new config entries. (See link:../Usage.asciidoc[Changelog] for information on what changed)
3. Shutdown all your Virtual Machines.
4. Start them again (with `vagrant up --provision name`). This should force provisioning them.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment