.. _getting_started:

.. role:: bash(code)
    :language: bash
    
***************
Getting started
***************

This document assumes that a tester has read the SPEC Cloud IaaS 2016 Benchmark `design <https://www.spec.org/cloud_iaas2016/docs/OsgCloudIaaSDesign2016.pdf>`_ and `run rules <https://www.spec.org/cloud_iaas2016/docs/OsgCloudRunRules2016.pdf>`_ documents.


---------------------------
Obtaining the Kit
---------------------------

The SPEC Cloud IaaS 2016 Benchmark kit is available as a zip file. Please see 
the `order page <http://spec.org/order.html>`_ for more details.

In the machine where benchmark harness will be set up, change to the home directory::

  cd ~/

Upload the kit zip file in the home directory of this machine.

Unzip in your home directory::

  unzip spec_cloud_iaas_2016*.zip 

The directory contains `CBTOOL <https://github.com/ibmcb/cbtool>`_, baseline and elasticity drivers and report generators, as well as 
HiBench and YCSB workloads. The directory also includes the Cassandra (2.1.11) and Hadoop (2.7.1) source 
code and packages (deb/rpm) for the versions . The tester must use the version of CBTOOL that ships with the
kit for a compliant run. The tester must also use the version of Cassandra and Hadoop packages or source code
that ships with the kit.

Some quick links:

:ref:`Setup benchmark harness, including CBTOOL, in a virtual machine (VM)<cloudbench_prepare_ubuntu_qcow2>`

:ref:`Configure CBTOOL with an OpenStack cloud<configure_cloud_openstack>`

:ref:`Run the benchmark with a simulated cloud<simulated>`

:ref:`Prepare workload images<workload_images>` 

:ref:`Upload images, launch a virtual machine and an application instance<upload_image_launch_vm_ai>`

:ref:`Set up benchmark parameters<config_yaml>`

:ref:`Run baseline phase for the first time<baseline_measurements>`

:ref:`Run elasticity + scalability phase for the first time<elasticity_measurements>`

:ref:`Compliant run<compliant_run>`

:ref:`Submit results<submit_results>`


-------------------
Workload Images
-------------------

The tester needs to build images from scratch for their cloud. The instructions 
for building images for various clouds are described in later sections.