OpenStack Upstream Institute Virtual Environment
================================================

<h2 align=center><a href=bit.ly/training-vm>http://bit.ly/training-vm</a></h2>
-----------------------------------------------

Instructions
------------

1. Set up [VirtualBox]
2. Go to the [releases] page and download the [latest VM image][image].
3. Import the `ova` file (`File` -> `Import appliance...`) (on Windows? look [here][ova-import-help].)
4. Start up the VM

### Minimum requirements

* 5GB of **free** RAM (so at least 8GB in your laptop)
* Recent CPU with at least 4 cores
* 15GB disk space

[VirtualBox]: https://www.virtualbox.org/wiki/Downloads
[image]: https://github.com/kmARC/openstack-training-virtual-environment/releases/download/v2017.01/upstream-training-v2017.01.ova
[releases]: https://github.com/kmARC/openstack-training-virtual-environment/releases
[ova-import-help]: README-virtualbox-import.md

Learn how to set up devstack
----------------------------

These are the steps used to provision the vm:
* [install-base.sh](install-base.sh) (Git and dependent packages)
* [install-devstack.sh](install-devstack.sh) (Devstack)
* [install-gui.sh](install-gui.sh) (Xfce desktop environment, GUI applications)
* [files/](files/) - configuration files copied into the vm

Getting around in the VM
------------------------

1. Open a terminal and start devstack
    ``` bash
    /opt/devstack/stack.sh && optimize-memory
    ```
    This step takes about 10 minutes. 

2. Explore the environment. The four main software you will be using from the
    desktop during the training are:
    * a browser (Firefox)
    * a terminal emulator
    * a text editor (Geany, vim)
    * an IRC client (HexChat)
        > please make sure that you replace the default user `ubuntu` upon first
        > start before logging in to Freenode channels.

3. When `stack.sh` finished running, you can open the OpenStack Horizon Dashboard
    using the **DevStack** bookmark.

    * **Login**: `demo`
    * **Password**: `openstack`

4. Select the `demo` project

5. Start a VM. Use a tiny flavor. A CirrOS image is already set up by devstack

6. Assign a floating IP

7. Enable SSH and ICMP ports on the security groups

Using latest devstack
---------------------

Please do not update your openstack installation during the training. It requires bandwidth.

If you want to keep on using the training VM for devstacking, you should disable offline mode in [local.conf](files/opt/devstack/local.conf). Also reconsider git related settings here.

Screenshots
-----------

| Devstack running | Geany with keystone code loaded | git and HexChat |
|------------------|---------------------------------|-----------------|
|![devstack]       |![geany]                         |![git-xchat]         |

[devstack]: docs/01.png "Devstack running"
[geany]: docs/02.png "Geany with keystone code loaded"
[git-xchat]: docs/03.png "git and HexChat"

Advanced Topics
---------------

This section is mainly for developers of the *VM*

1. Set up VirtualBox
2. Set up Vagrant
3. `git clone https://github.com/kmARC/openstack-training-virtual-environment`
4. `cd openstack-training-virtual-environment`
5. `vagrant up`
6. `vagrant reload`
7. `vagrant ssh`

Follow instructions [as for the prebuilt image](#using-a-prebuilt-image)

### Roll your own image

Essentially the same procedure, with exporting an ova archive at the end which
then can be distributed and easily import into VirtualBox

1. install [libssl098:i386]
    (required for vmware vdiskmanager to shrink disks)
    ```bash
    wget http://security.ubuntu.com/ubuntu/ubuntu/pool/universe/o/openssl098/libssl0.9.8_0.9.8o-7ubuntu4_i386.deb
    sudo dpkg -i libssl0.9.8_0.9.8o-7ubuntu4_i386.deb
    ```
2. `./create-training-box.sh` 
    Provisions the VM and creates the distributable ova archive.

[vmvare-vdiskmanager]: https://kb.vmware.com/selfservice/viewAttachment.do?attachID=1023856-vdiskmanager-linux.7.0.1.zip&documentID=1023856
[libssl098:i386]: http://security.ubuntu.com/ubuntu/ubuntu/pool/universe/o/openssl098/

License
-------
MIT