1 = Setup PVE Development Environment =
3 1. Install Debian 'jessie'
4 2. Configure pvetest repository in apt sources.list
6 deb http://download.proxmox.com/debian jessie pvetest
8 3. Add our repository key with apt-key:
10 wget -O- "http://download.proxmox.com/debian/key.asc" | apt-key add -
12 4. make sure you have a read IP address for your hostname in /etc/hosts
13 (using 127.0.1.1 will not work)
15 5. run: apt-get update
16 6. run: apt-get dist-upgrade
17 7. run: apt-get install proxmox-ve
19 You should now have a working Proxmox VE installation.
21 = Install build prerequisites for development environment =
23 apt-get install build-essential git-core git-email debhelper \
24 autotools-dev autogen dh-autoreconf dkms doxygen check pkg-config \
25 groff quilt dpatch automake autoconf libtool lintian libdevel-cycle-perl \
26 libjson-perl libcommon-sense-perl liblinux-inotify2-perl libio-stringy-perl \
27 libstring-shellquote-perl dh-systemd rpm2cpio libsqlite3-dev sqlite3 \
28 libglib2.0-dev librrd-dev librrds-perl rrdcached libdigest-hmac-perl \
29 libxml-parser-perl gdb libcrypt-openssl-random-perl \
30 libcrypt-openssl-rsa-perl libnet-ldap-perl libauthen-pam-perl \
31 libjson-xs-perl libterm-readline-gnu-perl oathtool libmime-base32-perl \
32 liboath0 libpci-dev texi2html libsdl1.2-dev libgnutls28-dev \
33 libspice-protocol-dev xfslibs-dev libnuma-dev libaio-dev \
34 pve-libspice-server-dev libusbredirparser-dev glusterfs-common \
35 libusb-1.0-0-dev librbd-dev libpopt-dev iproute bridge-utils numactl \
36 glusterfs-common ceph-common python-ceph libgoogle-perftools4 \
37 libfile-chdir-perl lvm2 glusterfs-client liblockfile-simple-perl \
38 libsystemd-dev libreadline-gplv2-dev libio-multiplex-perl \
39 libnetfilter-log-dev libipset3 ipset socat libsasl2-dev libogg-dev \
40 python-pyparsing libfilesys-df-perl libcrypt-ssleay-perl \
41 libfile-readbackwards-perl libanyevent-perl libanyevent-http-perl \
42 unzip liblocale-po-perl libfile-sync-perl cstream \
43 lzop dtach apt-transport-https hdparm gdisk parted ttf-dejavu-core \
44 liblzma-dev dosfstools mtools libxen-dev libfuse-dev corosync-dev \
45 libcpg-dev libquorum-dev libcmap-dev libuuid-perl \
46 libqb-dev libapparmor-dev docbook2x libcap-dev dh-apparmor \
47 graphviz libseccomp-dev libglib-perl libgtk3-perl libnss3-dev libdlm-dev \
48 libudev-dev asciidoc-dblatex source-highlight inkscape \
49 libiscsi-dev libiscsi7
51 = Compile PVE packages from Source =
53 Download and install the following git modules in order from top to bottom:
55 # git clone git://git.proxmox.com/git/<PACKAGE.git>
57 You currently need the following packages:
60 libpve-http-server-perl.git
61 libpve-apiclient-perl.git
64 pve-access-control.git
75 #resource-agents-pve.git
78 #pve-kernel-3.10.0.git
81 ksm-control-daemon.git
85 Most packages can be installed with 'make dinstall' command.
88 5. Learn to use the quilt patch scripts.
91 There is an experimental package containing the API documentation
96 You can view the source code at:
98 https://git.proxmox.com
103 We decided to change our SOAP API (1.X) and use a REST like API. The
104 concept is described in [1] (Resource Oriented Architecture
105 (ROA)). The main advantage is that we are able to remove a lot of code
106 (the whole SOAP stack) to reduce software complexity.
108 We also moved away from server side content generation. Instead we use
109 the ExtJS Rich Internet Application Framework
110 (http://www.sencha.com).
112 That framework, like any other AJAX toolkit, can talk directly to the
113 REST API using JSON. So we were able to remove the server side
114 template toolkit completely.
116 = JSON and JSON Schema =
118 We use JSON as data format, because it is simple and parse-able by any
121 Additionally, we use JSON Schema [2] to formally describe our API. So
122 we can automatically generate the whole API Documentation, and we can
123 verify all parameters and return values.
125 A great side effect was that we are able to use JSON Schema to
126 produce command line argument parsers automatically. In fact, the REST
127 API and the command line tools use the same code.
129 Object linkage is done using the JSON Hyper Schema (links property).
131 A small utility called 'pvesh' exposes the whole REST API on the command
134 So here is a summary of the advantage:
136 - easy, human readable data format (native web browser format)
137 - automatic parameter verification (we can also verify return values)
138 - automatic generation of API documentation
139 - easy way to create command line tools (using same API).
141 = API Implementation (PVE::RESTHandler) =
143 All classes exposing methods on the API use PVE::RESTHandler as base class.
145 use base qw(PVE::RESTHandler);
147 To expose methods, one needs to call register_method():
149 __PACKAGE__->register_method ($schema);
151 Where $schema is a PVE method schema as described in
152 PVE::JSONSchema. It includes a description of parameters and return
153 values, and a reference to the actual code
155 __PACKAGE__->register_method ({
159 description => "simple return value of parameter 'text'",
161 additionalProperties => 0,
174 return $param->{text};
178 The 'name' property is only used if you want to call the method
179 directly from Perl. You can do that using:
181 print __PACKAGE__->echo({ text => "a test" });
183 We use Perl's AUTOLOAD feature to implement this. Note: You need to
184 pass parameters a HASH reference.
186 There is a special helper method called cli_handler(). This is used by
187 the CLIHandler Class for command line tools, where you want to pass
188 arguments as array of strings. This uses Getopt::Long to parse parameters.
190 There is a second way to map names to methods - using the 'path'
191 property. And you can register subclasses. That way you can set up a
192 filesystem like hierarchy to access methods.
195 ----------------------------
198 __PACKAGE__->register_method ({
204 __PACKAGE__->register_method ({
213 __PACKAGE__->register_method ({
219 -------------------------------
221 The utily method find_handler (in PVE::RESTHandler) can be use to do
222 'path' related method lookups.
224 C1->find_handler('GET', "/index") => C1::list1
225 C1->find_handler('GET', "/sub2/index") => C2::list2
227 The HTTP server use the URL (a path) to find the corresponding method.
232 [1] RESTful Web Services
233 Web services for the real world
236 Leonard Richardson, Sam Ruby
242 [2] JSON Schema links: http://json-schema.org/