Convert md to rst

Try again with ReadTheDocs

docs/How_Create_Virtual_Machine.rst

@@ -0,0 +1,30 @@
+Introduction
+------------
+
+It is probable that when you start reading this document, you have set
+up and install Ravada successfully and now it is time to create a
+virtual machine.
+
+Steps
+-----
+
+1. First of all, log into Ravada using the username and password you
+   created in previous steps of installation. |alt text|
+2. on top right of the page, click on "Admin Tools" and then "Machines".
+   |alt text|
+
+3. In the new page, click on "New Machine".
+4. Choose a name for your virtual machine and choose an option for the
+   ISO image. the selected image needs to be installed accordingly. |alt
+   text|
+5. Now, you can see a list of available machines and the operations of
+   each. |alt text|
+
+please note that you can see any upcoming error or problems in section
+"messages".
+
+.. |alt text| image:: https://github.com/UPC/ravada/blob/master/Images/Virtual_machine_Create_images/0.png
+.. |alt text| image:: https://github.com/UPC/ravada/blob/master/Images/Virtual_machine_Create_images/1.png
+.. |alt text| image:: https://github.com/UPC/ravada/blob/master/Images/Virtual_machine_Create_images/2.png
+.. |alt text| image:: https://github.com/UPC/ravada/blob/master/Images/Virtual_machine_Create_images/3.png
+

docs/INSTALL.rst

@@ -0,0 +1,156 @@
+Requirements
+============
+
+OS
+--
+
+Ravada has been tested only on Ubuntu Xenial. It should also work in
+recent RedHat based systems. Debian jessie has been tried but kvm spice
+wasn't available there, so it won't work.
+
+Hardware
+--------
+
+It depends on the number and the type of the virtual machines. For most
+places
+
+Memory
+~~~~~~
+
+RAM is the main issue. Multiply the number of concurrent workstations by
+the amount of memory each one requires and that is the RAM that must
+have the server.
+
+Disks
+~~~~~
+
+The faster the disks, the better. Ravada uses incremental files for the
+disks images, so clones won't require many space.
+
+Install Ravada
+==============
+
+Ubuntu
+------
+
+We provide *deb* Ubuntu packages. Download it from the `UPC ETSETB
+repository <http://infoteleco.upc.edu/img/debian/>`__. Download and
+install them:
+
+::
+
+    $ wget http://infoteleco.upc.edu/img/debian/libmojolicious-plugin-renderfile-perl_0.10-1_all.deb
+    $ wget http://infoteleco.upc.edu/img/debian/ravada_0.2.6_all.deb
+    $ sudo dpkg -i libmojolicious-plugin-renderfile-perl_0.10-1_all.deb
+    $ sudo dpkg -i ravada_0.2.6_all.deb
+
+The last command will show a warning about missing dependencies. Install
+them running:
+
+::
+
+    $ sudo apt-get update
+    $ sudo apt-get -f install
+
+Development Release
+-------------------
+
+Read
+`INSTALL\_devel <https://upc.github.io/ravada/documentation/docs/INSTALL_devel.html>`__
+if you want to develop Ravada or install a bleeding edge, non-packaged,
+release.
+
+Mysql Database
+==============
+
+MySQL server
+------------
+
+It is required a MySQL server, it can be installed in another host or in
+the same one as the ravada package.
+
+::
+
+    $ sudo apt-get install mysql-server
+
+MySQL user
+----------
+
+Create a database named "ravada". in this stage the system wants you to
+identify a password for your sql.
+
+::
+
+    $ mysqladmin -u root -p create ravada
+
+Grant all permissions to your user:
+
+::
+
+    $ mysql -u root -p ravada -e "grant all on ravada.* to rvd_user@'localhost' identified by 'CHOOSE A PASSWORD'"
+
+Config file
+-----------
+
+Create a config file at /etc/ravada.conf with the username and password
+you just declared at the previous step. Please note that you need to
+edit the user and password via an editor. Here, we present Vi as an
+example.
+
+::
+
+    $ sudo vi /etc/ravada.conf
+    db:
+      user: rvd_user
+      password: THE PASSWORD CHOSEN BEFORE
+
+Ravada web user
+===============
+
+Add a new user for the ravada web. Use rvd\_back to create it.
+
+::
+
+    $ sudo /usr/sbin/rvd_back --add-user user.name
+
+Firewall (Optional)
+===================
+
+The server must be able to send *DHCP* packets to its own virtual
+interface.
+
+KVM should be using a virtual interface for the NAT domnains. Look what
+is the address range and add it to your *iptables* configuration.
+
+First we try to find out what is the new internal network:
+
+::
+
+    $  sudo route -n
+    ...
+    192.168.122.0   0.0.0.0         255.255.255.0   U     0      0        0 virbr0
+
+So it is 192.168.122.0 , netmask 24. Add it to your iptables
+configuration:
+
+::
+
+    sudo iptables -A INPUT -s 192.168.122.0/24 -p udp --dport 67:68 --sport 67:68 -j ACCEPT
+
+To confirm that the configuration was updated, check it with:
+
+::
+
+    sudo iptables -S
+
+Client
+======
+
+The client must have a spice viewer such as virt-viewer. There is a
+package for linux and it can also be downloaded for windows.
+
+Next
+====
+
+Read
+`production <https://upc.github.io/ravada/documentation/docs/production.html>`__.

docs/INSTALL_devel.rst

@@ -0,0 +1,65 @@
+Development release
+===================
+
+If you are not sure, you probably want to install the stable release.
+Follow this
+`guide <https://upc.github.io/ravada/documentation/docs/INSTALL.html>`__.
+
+You can get the development release cloning the sources. Don't do this
+if you install a packaged release.
+
+::
+
+    $ git clone https://github.com/frankiejol/ravada.git
+
+Ubuntu required packages
+------------------------
+
+These are the Ubuntu required packages. It is is only necessary for the
+development release.
+
+::
+
+    $ sudo apt-get install libmojolicious-perl  mysql-server libauthen-passphrase-perl  libdbd-mysql-perl libdbi-perl libdbix-connector-perl libipc-run3-perl libnet-ldap-perl libproc-pid-file-perl libvirt-bin libsys-virt-perl libxml-libxml-perl libconfig-yaml-perl libmoose-perl libjson-xs-perl qemu-utils perlmagick libmoosex-types-netaddr-ip-perl libsys-statistics-linux-perl libio-interface-perl libiptables-chainmgr-perl libnet-dns-perl wget liblocale-maketext-lexicon-perl libmojolicious-plugin-i18n-perl libdbd-sqlite3-perl
+
+-  libmojolicious-perl
+-  mysql-server
+-  libauthen-passphrase-perl
+-  libdbd-mysql-perl
+-  libdbi-perl
+-  libdbix-connector-perl
+-  libipc-run3-perl
+-  libnet-ldap-perl
+-  libproc-pid-file-perl
+-  libvirt-bin
+-  libsys-virt-perl
+-  libxml-libxml-perl
+-  libconfig-yaml-perl
+-  libmoose-perl
+-  libjson-xs-perl
+-  qemu-utils
+-  perlmagick
+-  libmoosex-types-netaddr-ip-perl
+-  libsys-statistics-linux-perl
+-  libio-interface-perl
+-  libiptables-chainmgr-perl
+-  libnet-dns-perl
+-  wget
+-  liblocale-maketext-lexicon-perl
+-  libmojolicious-plugin-i18n-perl
+
+Config file
+===========
+
+When developping Ravada, your username must be able to read the
+configuration file. Protect the config file from others and make it
+yours.
+
+::
+
+    $ sudo chmod o-rx /etc/ravada.conf
+    $ sudo chown your_username /etc/ravada.conf
+
+Read
+`devel-docs <https://upc.github.io/ravada/documentation/devel-docs/>`__
+to learn how to start it.

docs/README.rst

@@ -0,0 +1 @@
+Welcome to RAVADA documentation

docs/ROADMAP.rst

@@ -0,0 +1,15 @@
+v0.2
+====
+
+-  Polish the frontend
+
+v0.3
+====
+
+-  Manage remote nodes
+-  Hibernate automatically idle domains
+
+v0.4
+====
+
+-  manage LXC containers

docs/Ubuntu_Installation.rst

@@ -0,0 +1,30 @@
+This document aims to demonstrate how to install Ubuntu operating system
+on user computer. ## Steps 1. The user needs at least 4.5 GB of free
+space on their computer. 2. Connect your USB or DVD containing Ubuntu
+program. 3. When you turn on your computer the below image must show up
+automatically or by pressing F12. |alt text| 4. Make sure you are
+connected to internet, then the below image is shown. Mark both options
+and click on "continue". |alt text| 5. Below shows how to Use the
+checkboxes to choose whether you’d like to Install Ubuntu alongside
+another operating system, delete your existing operating system and
+replace it with Ubuntu. in our case we select "Something Else" and click
+on "continue". |alt text| 6. In this stage, you will create partitions.
+
+vda
+~~~
+
+Select "Free space" and then set the *mount point* to "/".
+
+vdb
+~~~
+
+Select "Free space" and then assign it to *swap area*
+
+7. The last step is choosing your language and region. after doing so
+   and restarting your computer you can start using Ubuntu. |alt text|
+
+.. |alt text| image:: https://github.com/UPC/ravada/blob/master/Images/install-ubuntu-desktop_1.jpg
+.. |alt text| image:: https://github.com/UPC/ravada/blob/master/Images/install-ubuntu-desktop_2.jpg
+.. |alt text| image:: https://github.com/UPC/ravada/blob/master/Images/install-ubuntu-desktop_4.jpg
+.. |alt text| image:: https://github.com/UPC/ravada/blob/master/Images/install-ubuntu-desktop_7.jpg
+

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-merlot

docs/add_kvm_storage_pool.rst

@@ -0,0 +1,56 @@
+If you run out of disk space you may add a new disk. KVM mush then be
+informed about this new space available by creating a new storage pool.
+
+Add the drive to the system
+---------------------------
+
+After booting with the new drive, check dmesg to find out the name of
+the new disk. It will probably be called /dev/sdSOMETHING.
+
+Double check this is actually the new disk, if not you may erase all the
+contents of the system. Type *df* to see the old disk partitions.
+
+Create a new partition with *fdisk*. It should show it as empty. Add
+only one primary partition for all the free space.
+
+Replace *sdX* by the real name of the new device:
+
+::
+
+    $ sudo fdisk /dev/sdX
+
+Format it with large files tunning:
+
+::
+
+    $ sudo mkfs.ext4 -m 0.001 -T largefiles /dev/sdX1
+
+Mount the new partition
+-----------------------
+
+Add this new partition to the filesystem table:
+
+::
+
+    $ sudo mkdir /var/lib/libvirt/images.2
+    $ sudo vim /etc/fstab
+    /dev/sdb1   /var/lib/libvirt/images.2 ext4  auto    0   3
+
+It will mount it next time you boot, but it can be used without
+rebooting issuing:
+
+::
+
+    sudo mount -a
+
+Add the drive to the Virtual Manager
+------------------------------------
+
+::
+
+    $ sudo virsh pool-define-as pool2 dir - - - - /var/lib/libvirt/images.2
+    $ sudo virsh pool-autostart pool2
+    $ sudo virsh pool-start pool2
+
+And that's it, now Ravada will use the pool that has more empty space
+the next time it needs to create a volume.