rubbos installation guide
[bottlenecks.git] / vstf / vstf / agent / env / basic / Readme
1 the modules in this directory include some basic common purpose functions that can be used for other plugins.
2 you can see the modules in this directory as libraries that you can import for ease of creating your own plugin.
3
4 the main functions of the modules are listed as follows:
5  
6 ImageManger:
7         role:
8                 virtual machine images manager. used by VmManager.
9                 wraps 'qemu-img' command as underlying mechanism.
10         features:
11                 provides a function to create child image from a parent image.
12                 provides a function to delete child image.
13         
14 SourceManager:
15         role:
16                 source code manager.
17                 using 'pramiko' as underlying mechanism.
18         features:
19                 provides a function to download source code 
20                 provides a function which wrap 'make clean;make;make install' to compile and install.
21         
22 VmManager:
23         role:
24                 virtual machine manager which can create vm and configure vm on bootstrap.
25                 use libvirt as underlying mechanism. wrap 'virsh' command for creating vm.
26         features:
27                 provides a function to create vm from a vm configuration context.
28                 provides functions to detect if vm boots up successfully and onfigure bootstrap options for vm like ip and rabbitmq conf file.
29
30 vm9pfs:
31         used by VmManager.
32         host side 9pfs operation (mainly file operations) to communicate with vm by libvirt 9pfs.
33         see as communication protocol on client side. The vm runs a agent for receiving the commands. 
34                         
35 VmXmlHelp:
36         used by VmManager.
37         just some divided libvirt xml string templates for building a complete libvirt xml file on demand by VmManager.
38
39