From: Zack Cerza Date: Thu, 16 Jun 2016 14:48:16 +0000 (-0600) Subject: Move downburst section to its own doc X-Git-Tag: 1.1.0~598^2~1 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=c522b75c836225f0433848e0161dc1a22c4702a2;p=teuthology.git Move downburst section to its own doc Signed-off-by: Zack Cerza --- diff --git a/docs/README.rst b/docs/README.rst index 060eed56b..8fd86d1e9 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -68,121 +68,13 @@ Detailed test configuration See :ref:`detailed_test_config`. -VIRTUAL MACHINE SUPPORT +Virtual Machine Support ======================= For OpenStack support, see :ref:`openstack-backend` -Teuthology also supports virtual machines, which can function like -physical machines but differ in the following ways: - -VPSHOST: --------- -The following description is based on the Red Hat lab used by the Ceph -development and quality assurance teams. - -The teuthology database of available machines contains a vpshost field. -For physical machines, this value is null. For virtual machines, this entry -is the name of the physical machine that that virtual machine resides on. - -There are fixed "slots" for virtual machines that appear in the teuthology -database. These slots have a machine type of vps and can be locked like -any other machine. The existence of a vpshost field is how teuthology -knows whether or not a database entry represents a physical or a virtual -machine. - -In order to get the right virtual machine associations, the following needs -to be set in ~/.config/libvirt/libvirt.conf or for some older versions -of libvirt (like ubuntu precise) in ~/.libvirt/libvirt.conf:: - - uri_aliases = [ - 'mira001=qemu+ssh://ubuntu@mira001.front.sepia.ceph.com/system?no_tty=1', - 'mira003=qemu+ssh://ubuntu@mira003.front.sepia.ceph.com/system?no_tty=1', - 'mira004=qemu+ssh://ubuntu@mira004.front.sepia.ceph.com/system?no_tty=1', - 'mira006=qemu+ssh://ubuntu@mira006.front.sepia.ceph.com/system?no_tty=1', - 'mira007=qemu+ssh://ubuntu@mira007.front.sepia.ceph.com/system?no_tty=1', - 'mira008=qemu+ssh://ubuntu@mira008.front.sepia.ceph.com/system?no_tty=1', - 'mira009=qemu+ssh://ubuntu@mira009.front.sepia.ceph.com/system?no_tty=1', - 'mira010=qemu+ssh://ubuntu@mira010.front.sepia.ceph.com/system?no_tty=1', - 'mira011=qemu+ssh://ubuntu@mira011.front.sepia.ceph.com/system?no_tty=1', - 'mira013=qemu+ssh://ubuntu@mira013.front.sepia.ceph.com/system?no_tty=1', - 'mira014=qemu+ssh://ubuntu@mira014.front.sepia.ceph.com/system?no_tty=1', - 'mira015=qemu+ssh://ubuntu@mira015.front.sepia.ceph.com/system?no_tty=1', - 'mira017=qemu+ssh://ubuntu@mira017.front.sepia.ceph.com/system?no_tty=1', - 'mira018=qemu+ssh://ubuntu@mira018.front.sepia.ceph.com/system?no_tty=1', - 'mira020=qemu+ssh://ubuntu@mira020.front.sepia.ceph.com/system?no_tty=1', - 'mira024=qemu+ssh://ubuntu@mira024.front.sepia.ceph.com/system?no_tty=1', - 'mira029=qemu+ssh://ubuntu@mira029.front.sepia.ceph.com/system?no_tty=1', - 'mira036=qemu+ssh://ubuntu@mira036.front.sepia.ceph.com/system?no_tty=1', - 'mira043=qemu+ssh://ubuntu@mira043.front.sepia.ceph.com/system?no_tty=1', - 'mira044=qemu+ssh://ubuntu@mira044.front.sepia.ceph.com/system?no_tty=1', - 'mira074=qemu+ssh://ubuntu@mira074.front.sepia.ceph.com/system?no_tty=1', - 'mira079=qemu+ssh://ubuntu@mira079.front.sepia.ceph.com/system?no_tty=1', - 'mira081=qemu+ssh://ubuntu@mira081.front.sepia.ceph.com/system?no_tty=1', - 'mira091=qemu+ssh://ubuntu@mira091.front.sepia.ceph.com/system?no_tty=1', - 'mira098=qemu+ssh://ubuntu@mira098.front.sepia.ceph.com/system?no_tty=1', - 'vercoi01=qemu+ssh://ubuntu@vercoi01.front.sepia.ceph.com/system?no_tty=1', - 'vercoi02=qemu+ssh://ubuntu@vercoi02.front.sepia.ceph.com/system?no_tty=1', - 'vercoi03=qemu+ssh://ubuntu@vercoi03.front.sepia.ceph.com/system?no_tty=1', - 'vercoi04=qemu+ssh://ubuntu@vercoi04.front.sepia.ceph.com/system?no_tty=1', - 'vercoi05=qemu+ssh://ubuntu@vercoi05.front.sepia.ceph.com/system?no_tty=1', - 'vercoi06=qemu+ssh://ubuntu@vercoi06.front.sepia.ceph.com/system?no_tty=1', - 'vercoi07=qemu+ssh://ubuntu@vercoi07.front.sepia.ceph.com/system?no_tty=1', - 'vercoi08=qemu+ssh://ubuntu@vercoi08.front.sepia.ceph.com/system?no_tty=1', - 'senta01=qemu+ssh://ubuntu@senta01.front.sepia.ceph.com/system?no_tty=1', - 'senta02=qemu+ssh://ubuntu@senta02.front.sepia.ceph.com/system?no_tty=1', - 'senta03=qemu+ssh://ubuntu@senta03.front.sepia.ceph.com/system?no_tty=1', - 'senta04=qemu+ssh://ubuntu@senta04.front.sepia.ceph.com/system?no_tty=1', - ] - -DOWNBURST: ----------- - -When a virtual machine is locked, downburst is run on that machine to install a -new image. This allows the user to set different virtual OSes to be installed -on the newly created virtual machine. Currently the default virtual machine is -ubuntu (precise). A different vm installation can be set using the -``--os-type`` and ``--os-version`` options in ``teuthology.lock``. - -When a virtual machine is unlocked, downburst destroys the image on the -machine. - -Temporary yaml files are used to downburst a virtual machine. A typical -yaml file will look like this:: - - downburst: - cpus: 1 - disk-size: 30G - distro: centos - networks: - - {source: front} - ram: 4G - -These values are used by downburst to create the virtual machine. - -When locking a file, a downburst meta-data yaml file can be specified by using -the downburst-conf parameter on the command line. - -To find the downburst executable, teuthology first checks the PATH environment -variable. If not defined, teuthology next checks for -src/downburst/virtualenv/bin/downburst executables in the user's home -directory, /home/ubuntu, and /home/teuthology. This can all be overridden if -the user specifies a downburst field in the user's .teuthology.yaml file. - -HOST KEYS: ----------- - -Because teuthology reinstalls a new machine, a new hostkey is generated. After -locking, once a connection is established to the new machine, -``teuthology-lock`` with the ``--list`` or ``--list-targets`` options will -display the new keys. When vps machines are locked using the ``--lock-many`` -option, a message is displayed indicating that ``--list-targets`` should be run -later. - -ASSUMPTIONS: ------------- - -It is assumed that downburst is on the user's ``$PATH``. +For 'vps' support using `downburst `__, see +:ref:`downburst_vms` Test Suites diff --git a/docs/downburst_vms.rst b/docs/downburst_vms.rst new file mode 100644 index 000000000..cbecb45f6 --- /dev/null +++ b/docs/downburst_vms.rst @@ -0,0 +1,117 @@ +.. _downburst_vms: + +============= +Downburst VMs +============= + +Teuthology also supports virtual machines via `downburst +`__, which can function like physical +machines but differ in the following ways: + +VPS Hosts: +-------- +The following description is based on the Red Hat lab used by the Ceph +development and quality assurance teams. + +The teuthology database of available machines contains a vpshost field. +For physical machines, this value is null. For virtual machines, this entry +is the name of the physical machine that that virtual machine resides on. + +There are fixed "slots" for virtual machines that appear in the teuthology +database. These slots have a machine type of vps and can be locked like +any other machine. The existence of a vpshost field is how teuthology +knows whether or not a database entry represents a physical or a virtual +machine. + +In order to get the right virtual machine associations, the following needs +to be set in ~/.config/libvirt/libvirt.conf or for some older versions +of libvirt (like ubuntu precise) in ~/.libvirt/libvirt.conf:: + + uri_aliases = [ + 'mira001=qemu+ssh://ubuntu@mira001.front.sepia.ceph.com/system?no_tty=1', + 'mira003=qemu+ssh://ubuntu@mira003.front.sepia.ceph.com/system?no_tty=1', + 'mira004=qemu+ssh://ubuntu@mira004.front.sepia.ceph.com/system?no_tty=1', + 'mira006=qemu+ssh://ubuntu@mira006.front.sepia.ceph.com/system?no_tty=1', + 'mira007=qemu+ssh://ubuntu@mira007.front.sepia.ceph.com/system?no_tty=1', + 'mira008=qemu+ssh://ubuntu@mira008.front.sepia.ceph.com/system?no_tty=1', + 'mira009=qemu+ssh://ubuntu@mira009.front.sepia.ceph.com/system?no_tty=1', + 'mira010=qemu+ssh://ubuntu@mira010.front.sepia.ceph.com/system?no_tty=1', + 'mira011=qemu+ssh://ubuntu@mira011.front.sepia.ceph.com/system?no_tty=1', + 'mira013=qemu+ssh://ubuntu@mira013.front.sepia.ceph.com/system?no_tty=1', + 'mira014=qemu+ssh://ubuntu@mira014.front.sepia.ceph.com/system?no_tty=1', + 'mira015=qemu+ssh://ubuntu@mira015.front.sepia.ceph.com/system?no_tty=1', + 'mira017=qemu+ssh://ubuntu@mira017.front.sepia.ceph.com/system?no_tty=1', + 'mira018=qemu+ssh://ubuntu@mira018.front.sepia.ceph.com/system?no_tty=1', + 'mira020=qemu+ssh://ubuntu@mira020.front.sepia.ceph.com/system?no_tty=1', + 'mira024=qemu+ssh://ubuntu@mira024.front.sepia.ceph.com/system?no_tty=1', + 'mira029=qemu+ssh://ubuntu@mira029.front.sepia.ceph.com/system?no_tty=1', + 'mira036=qemu+ssh://ubuntu@mira036.front.sepia.ceph.com/system?no_tty=1', + 'mira043=qemu+ssh://ubuntu@mira043.front.sepia.ceph.com/system?no_tty=1', + 'mira044=qemu+ssh://ubuntu@mira044.front.sepia.ceph.com/system?no_tty=1', + 'mira074=qemu+ssh://ubuntu@mira074.front.sepia.ceph.com/system?no_tty=1', + 'mira079=qemu+ssh://ubuntu@mira079.front.sepia.ceph.com/system?no_tty=1', + 'mira081=qemu+ssh://ubuntu@mira081.front.sepia.ceph.com/system?no_tty=1', + 'mira091=qemu+ssh://ubuntu@mira091.front.sepia.ceph.com/system?no_tty=1', + 'mira098=qemu+ssh://ubuntu@mira098.front.sepia.ceph.com/system?no_tty=1', + 'vercoi01=qemu+ssh://ubuntu@vercoi01.front.sepia.ceph.com/system?no_tty=1', + 'vercoi02=qemu+ssh://ubuntu@vercoi02.front.sepia.ceph.com/system?no_tty=1', + 'vercoi03=qemu+ssh://ubuntu@vercoi03.front.sepia.ceph.com/system?no_tty=1', + 'vercoi04=qemu+ssh://ubuntu@vercoi04.front.sepia.ceph.com/system?no_tty=1', + 'vercoi05=qemu+ssh://ubuntu@vercoi05.front.sepia.ceph.com/system?no_tty=1', + 'vercoi06=qemu+ssh://ubuntu@vercoi06.front.sepia.ceph.com/system?no_tty=1', + 'vercoi07=qemu+ssh://ubuntu@vercoi07.front.sepia.ceph.com/system?no_tty=1', + 'vercoi08=qemu+ssh://ubuntu@vercoi08.front.sepia.ceph.com/system?no_tty=1', + 'senta01=qemu+ssh://ubuntu@senta01.front.sepia.ceph.com/system?no_tty=1', + 'senta02=qemu+ssh://ubuntu@senta02.front.sepia.ceph.com/system?no_tty=1', + 'senta03=qemu+ssh://ubuntu@senta03.front.sepia.ceph.com/system?no_tty=1', + 'senta04=qemu+ssh://ubuntu@senta04.front.sepia.ceph.com/system?no_tty=1', + ] + +Downburst: +---------- + +When a virtual machine is locked, downburst is run on that machine to install a +new image. This allows the user to set different virtual OSes to be installed +on the newly created virtual machine. Currently the default virtual machine is +ubuntu (precise). A different vm installation can be set using the +``--os-type`` and ``--os-version`` options in ``teuthology.lock``. + +When a virtual machine is unlocked, downburst destroys the image on the +machine. + +Temporary yaml files are used to downburst a virtual machine. A typical +yaml file will look like this:: + + downburst: + cpus: 1 + disk-size: 30G + distro: centos + networks: + - {source: front} + ram: 4G + +These values are used by downburst to create the virtual machine. + +When locking a file, a downburst meta-data yaml file can be specified by using +the downburst-conf parameter on the command line. + +To find the downburst executable, teuthology first checks the PATH environment +variable. If not defined, teuthology next checks for +src/downburst/virtualenv/bin/downburst executables in the user's home +directory, /home/ubuntu, and /home/teuthology. This can all be overridden if +the user specifies a downburst field in the user's .teuthology.yaml file. + +Host Keys: +---------- + +Because teuthology reinstalls a new machine, a new hostkey is generated. After +locking, once a connection is established to the new machine, +``teuthology-lock`` with the ``--list`` or ``--list-targets`` options will +display the new keys. When vps machines are locked using the ``--lock-many`` +option, a message is displayed indicating that ``--list-targets`` should be run +later. + +Assumptions: +------------ + +It is assumed that downburst is on the user's ``$PATH``. diff --git a/docs/index.rst b/docs/index.rst index 93df233cc..79aacf788 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,6 +9,7 @@ Content Index siteconfig.rst detailed_test_config.rst openstack_backend.rst + downburst_vms.rst INSTALL.rst LAB_SETUP.rst ChangeLog.rst