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 -y 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 vlan ifenslave-2.6 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
50 = Compile PVE packages from Source =
52 Download and install the following git modules in order from top to bottom:
54 # git clone git://git.proxmox.com/git/<PACKAGE.git>
56 You currently need the following packages:
59 libpve-http-server-perl.git
60 libpve-apiclient-perl.git
64 pve-access-control.git
73 #resource-agents-pve.git
75 #pve-kernel-3.10.0.git
78 ksm-control-daemon.git
83 Most packages can be installed with 'make dinstall' command.
86 5. Learn to use the quilt patch scripts.
89 There is an experimental package containing the API documentation
94 You can view the source code at:
96 https://git.proxmox.com
101 We decided to change our SOAP API (1.X) and use a REST like API. The
102 concept is described in [1] (Resource Oriented Architecture
103 (ROA)). The main advantage is that we are able to remove a lot of code
104 (the whole SOAP stack) to reduce software complexity.
106 We also moved away from server side content generation. Instead we use
107 the ExtJS Rich Internet Application Framework
108 (http://www.sencha.com).
110 That framework, like any other AJAX toolkit, can talk directly to the
111 REST API using JSON. So we were able to remove the server side
112 template toolkit completely.
114 = JSON and JSON Schema =
116 We use JSON as data format, because it is simple and parse-able by any
119 Additionally, we use JSON Schema [2] to formally describe our API. So
120 we can automatically generate the whole API Documentation, and we can
121 verify all parameters and return values.
123 A great side effect was that we are able to use JSON Schema to
124 produce command line argument parsers automatically. In fact, the REST
125 API and the command line tools use the same code.
127 Object linkage is done using the JSON Hyper Schema (links property).
129 A small utility called 'pvesh' exposes the whole REST API on the command
132 So here is a summary of the advantage:
134 - easy, human readable data format (native web browser format)
135 - automatic parameter verification (we can also verify return values)
136 - automatic generation of API documentation
137 - easy way to create command line tools (using same API).
139 = API Implementation (PVE::RESTHandler) =
141 All classes exposing methods on the API use PVE::RESTHandler as base class.
143 use base qw(PVE::RESTHandler);
145 To expose methods, one needs to call register_method():
147 __PACKAGE__->register_method ($schema);
149 Where $schema is a PVE method schema as described in
150 PVE::JSONSchema. It includes a description of parameters and return
151 values, and a reference to the actual code
153 __PACKAGE__->register_method ({
157 description => "simple return value of parameter 'text'",
159 additionalProperties => 0,
172 return $param->{text};
176 The 'name' property is only used if you want to call the method
177 directly from Perl. You can do that using:
179 print __PACKAGE__->echo({ text => "a test" });
181 We use Perl's AUTOLOAD feature to implement this. Note: You need to
182 pass parameters a HASH reference.
184 There is a special helper method called cli_handler(). This is used by
185 the CLIHandler Class for command line tools, where you want to pass
186 arguments as array of strings. This uses Getopt::Long to parse parameters.
188 There is a second way to map names to methods - using the 'path'
189 property. And you can register subclasses. That way you can set up a
190 filesystem like hierarchy to access methods.
193 ----------------------------
196 __PACKAGE__->register_method ({
202 __PACKAGE__->register_method ({
211 __PACKAGE__->register_method ({
217 -------------------------------
219 The utily method find_handler (in PVE::RESTHandler) can be use to do
220 'path' related method lookups.
222 C1->find_handler('GET', "/index") => C1::list1
223 C1->find_handler('GET', "/sub2/index") => C2::list2
225 The HTTP server use the URL (a path) to find the corresponding method.
230 [1] RESTful Web Services
231 Web services for the real world
234 Leonard Richardson, Sam Ruby
240 [2] JSON Schema links: http://json-schema.org/