annotate README @ 121:4868ace2726b

Add initial consistence checks in test suite for Xen_MemoryPool, Xen_ProcessorPool and Xen_VirtualSystemManagementService.

Signed-off-by: Luke Szymanski <Lukasz.Szymanski@Unisys.com>
author Jim Fehlig <jfehlig@novell.com>
date Fri Jun 08 10:22:05 2007 -0600 (2007-06-08)
parents 6ec07cc4fe79
rev   line source
jfehlig@28 1 1. INTRODUCTION
jfehlig@28 2
jfehlig@3 3 The Xen-CIM project implements various profiles defined by the System
jfehlig@3 4 Virtualization, Partitioning, and Clustering (SVPC) working group within
jfehlig@28 5 the Distributed Management Task Force (DMTF). The SVPC working group
jfehlig@28 6 includes members from EMC (VMWare), HP, IBM, Microsoft, Novell, Unisys,
jfehlig@28 7 XenSource, and others. The working group web page serves as a central
jfehlig@28 8 point for collaboration and can be found at
jfehlig@28 9
jfehlig@44 10 http://www.dmtf.org/apps/org/workgroup/redundancy
jfehlig@28 11
jfehlig@28 12 Membership to the working group requires registration but is free to all
jfehlig@28 13 DMTF member companies.
jfehlig@28 14
jfehlig@28 15 All profiles and schema created by the SVPC working group are
jfehlig@28 16 currently DMTF Confidential. The various profiles emerging from the
jfehlig@28 17 group cannot be shared at this time however the DMTF has given
jfehlig@28 18 permission to share the schema. Recent schema snapshots are located in
jfehlig@28 19 project directory schema/dmtf.
jfehlig@28 20
jfehlig@28 21 The profiles and schema are a work-in-progress and undergo rapid change.
jfehlig@28 22 Once stabilized, they are made publicly available as Experimental for
jfehlig@28 23 consumption and comment. At least two, interoperable implementations
jfehlig@28 24 must exits before promotion to Final.
jfehlig@28 25
jfehlig@28 26 The schema models a management domain, e.g. virtualization, and contains
jfehlig@28 27 all of the classes and their relationships that are required to describe
jfehlig@28 28 the management domain.
jfehlig@28 29
jfehlig@28 30 Profiles are schema companions that describe in normative text how the
jfehlig@28 31 model works. They are the specification to which implementations
jfehlig@28 32 should conform.
jfehlig@28 33
jfehlig@28 34 The Xen-CIM project aims to implement all relevant profiles produced
jfehlig@28 35 by the SVPC working group. The project is currently tracking the
jfehlig@28 36 following profiles:
jfehlig@28 37
jfehlig@28 38 DSP1042 System Virtualization Profile
jfehlig@44 39 DSP1057 Virtual System Profile
jfehlig@28 40 DSP1041 Resource Allocation Profile
jfehlig@28 41 DSP1043 Allocation Capabilities Profile
jfehlig@28 42
jfehlig@28 43 2. CONFIGURING
jfehlig@28 44
jfehlig@28 45 The project configure script accepts the standard configure options.
jfehlig@28 46 In addition, the --with-host-instrumentation=TYPE option can be used to
jfehlig@28 47 specify which host instrumentation will be used by the Xen-CIM providers.
jfehlig@28 48 The available TYPEs are omc and sblim with omc as the default.
jfehlig@28 49
jfehlig@28 50 "Host instrumentation" refers to implementations of DMTF profiles
jfehlig@28 51 describing physical host environments, such as DSP1052 Computer System
jfehlig@28 52 Profile. Many of the virtualization profiles reference profiles that have
jfehlig@28 53 been implemented by other open source projects, such as omc and sblim.
jfehlig@28 54 This project leverages that work and thus requires either omc or sblim for
jfehlig@28 55 model completeness. Further information on omc or sblim can be found at
jfehlig@28 56 their respective project sites:
jfehlig@28 57
jfehlig@28 58 OMC - http://developer.novell.com/wiki/index.php/OMC
jfehlig@28 59 SBLIM - http://sourceforge.net/projects/sblim/
jfehlig@3 60
jfehlig@3 61
jfehlig@28 62 3. BUILDING
jfehlig@3 63
jfehlig@3 64 You must have a CIMOM (including its associated development packages),
jfehlig@45 65 libxml2, and Xen development packages installed to compile. Then
jfehlig@45 66 simply try:
jfehlig@3 67
jfehlig@3 68 ./autoconfiscate.sh
jfehlig@3 69 ./configure
jfehlig@3 70 make
jfehlig@3 71
jfehlig@3 72
jfehlig@28 73 4. INSTALLING
jfehlig@3 74
jfehlig@28 75 Use "make install" to install the provider library files. Default
jfehlig@28 76 location is /usr/local/lib/cmpi but can be controlled by the usual
jfehlig@28 77 options to configure.
jfehlig@3 78
jfehlig@28 79 The Xen-CIM schema is derived from the DMTF schema and provides concrete
jfehlig@28 80 classes for the implementation. These schema files are located in the
jfehlig@28 81 schema subdirectory. The DMTF schema in schema/dmtf and the Xen-CIM
jfehlig@28 82 schema are installed using the "make postinstall" target.
jfehlig@44 83
jfehlig@44 84
jfehlig@44 85 5. RUNNING
jfehlig@44 86
jfehlig@45 87 The Xen CIM providers require Xen >= 3.0.4. Currently the providers
jfehlig@45 88 expect to communicate with the Xen Control Stack in Domain0 using a
jfehlig@45 89 Unix Domain Socket. This socket provides access to the XMLRPC-based
jfehlig@45 90 Xen API used by the providers. Only root processes can connect to this
jfehlig@45 91 socket so it is expected that the providers will be running in a
jfehlig@45 92 privileged process.
jfehlig@44 93
jfehlig@44 94 The Xen Control Stack must be configured to open / listen on this
jfehlig@44 95 socket and allow 'unconditional' access. Note that unconditional
jfehlig@44 96 is a little misleading since only privileged (root) processes can
jfehlig@44 97 connect to the socket. Configuration is controlled via the
jfehlig@44 98 xend configuration file /etc/xen/xend-config.sxp. To enable the
jfehlig@44 99 Xen API XMLRPC interface place the following line in xend-config.sxp:
jfehlig@44 100
jfehlig@44 101 (xen-api-server ((unix none)))
jfehlig@44 102
jfehlig@44 103 See xend-config.sxp for more details. Restart xend, e.g.:
jfehlig@44 104
jfehlig@44 105 /etc/init.d/xend restart
jfehlig@44 106
jfehlig@44 107 and then access the provider functionality using your favorite
jfehlig@44 108 CIM/WBEM client.