update installation instructions
[pve-common.git] / README.dev
CommitLineData
e143e9d8 1====================================
47e4eb11 2Setup PVE Development Environment
e143e9d8
DM
3====================================
4
8bc53243
DM
51. Install Debian 'jessie'
62. Configure pvetest repository in apt sources.list
73. make sure you have a read IP address for your hostname in /etc/hosts
8 (using 127.0.1.1 will not work)
93. run: apt-get update
103. run: apt-get dist-upgrade
114. run: apt-get install proxmox-ve-3.10.0
12
135. Install prerequisites for development environment:
e143e9d8 14
47e4eb11 15# new jessie depends
47e4eb11 16
7da024b1 17apt-get -y install build-essential git-core debhelper autotools-dev \
8bc53243
DM
18autogen dh-autoreconf dkms doxygen check pkg-config groff quilt dpatch \
19automake autoconf libtool lintian libdevel-cycle-perl libjson-perl \
20libcommon-sense-perl liblinux-inotify2-perl libio-stringy-perl \
21libstring-shellquote-perl dh-systemd rpm2cpio libsqlite3-dev sqlite3 \
22libglib2.0-dev librrd-dev librrds-perl rrdcached libdigest-hmac-perl \
23libxml-parser-perl gdb libcrypt-openssl-random-perl \
24libcrypt-openssl-rsa-perl libnet-ldap-perl libauthen-pam-perl \
25libjson-xs-perl libterm-readline-gnu-perl oathtool libmime-base32-perl \
26liboath0 libpci-dev texi2html libsdl1.2-dev libgnutls28-dev \
27libspice-protocol-dev xfslibs-dev libnuma-dev libaio-dev \
28libspice-server-dev libusbredirparser-dev glusterfs-common \
29libusb-1.0-0-dev librbd-dev libpopt-dev iproute bridge-utils numactl \
30glusterfs-common ceph-common python-ceph libgoogle-perftools4 \
31libfile-chdir-perl lvm2 glusterfs-client liblockfile-simple-perl \
32libsystemd-daemon-dev libreadline-gplv2-dev libio-multiplex-perl \
33libnetfilter-log-dev libipset3 ipset socat libsasl2-dev libogg-dev \
34python-pyparsing libfilesys-df-perl libcrypt-ssleay-perl \
35libfile-readbackwards-perl libanyevent-perl libanyevent-http-perl \
36unzip liblocale-po-perl vlan ifenslave-2.6 libfile-sync-perl cstream \
37lzop dtach apt-transport-https hdparm gdisk parted ttf-dejavu-core \
38liblzma-dev dosfstools mtools libxen-dev
e143e9d8 39
7da024b1 403. Download and install the following git modules in order from top to bottom:
e143e9d8 41
7da024b1 42# git clone git://git.proxmox.com/git/<PACKAGE.git>
e143e9d8 43
7da024b1
DM
44You currently need the following packages:
45
47e4eb11 46libqb.git
7da024b1 47corosync-pve.git
7da024b1
DM
48pve-common.git
49pve-cluster.git
56d42b76 50lvm.git
7da024b1
DM
51pve-access-control.git
52pve-storage.git
53pve-qemu-kvm.git
54qemu-server.git
55vncterm.git
8bc53243
DM
56spiceterm.git
57#vzquota.git
58#vzctl.git
59#fence-agents-pve.git
60#resource-agents-pve.git
7da024b1 61pve-manager.git
8bc53243 62pve-kernel-3.10.0.git
60f4e8c7 63libiscsi.git
8bc53243 64#gfs2-utils.git
60f4e8c7 65ksm-control-daemon.git
e143e9d8 66
60f4e8c7 67Most packages can be installed with 'make dinstall' command.
e143e9d8
DM
68
694. Reboot the system.
705. Learn to use the quilt patch scripts.
716. Happy coding.
72
73There is an experimental package containing the API documentation
74as ExtJS application:
75
7da024b1
DM
76pve2-api-doc.git
77
78You can view the source code at:
79
80https://git.proxmox.com
e143e9d8
DM
81
82
83REST vs. SOAP
84=============
85
86We decided to change our SOAP API (1.X) and use a REST like API. The
87concept is described in [1] (Resource Oriented Architecture
88(ROA)). The main advantage is that we are able to remove a lot of code
89(the whole SOAP stack) to reduce software complexity.
90
91We also moved away from server side content generation. Instead we use
92the ExtJS Rich Internet Application Framework
93(http://www.sencha.com).
94
95That framework, like any other AJAX toolkit, can talk directly to the
96REST API using JSON. So we were able to remove the server side
97template toolkit completely.
98
99JSON and JSON Schema
100====================
101
102We use JSON as data format, because it is simple and parse-able by any
103web browser.
104
105Additionally, we use JSON Schema [2] to formally describe our API. So
106we can automatically generate the whole API Documentation, and we can
107verify all parameters and return values.
108
60f4e8c7 109A great side effect was that we are able to use JSON Schema to
e143e9d8
DM
110produce command line argument parsers automatically. In fact, the REST
111API and the command line tools use the same code.
112
113Object linkage is done using the JSON Hyper Schema (links property).
114
115A small utility called 'pvesh' exposes the whole REST API on the command
116line.
117
118So here is a summary of the advantage:
119
120 - easy, human readable data format (native web browser format)
121 - automatic parameter verification (we can also verify return values)
122 - automatic generation of API documentation
123 - easy way to create command line tools (using same API).
124
125API Implementation (PVE::RESTHandler)
126=====================================
127
128All classes exposing methods on the API use PVE::RESTHandler as base class.
129
130 use base qw(PVE::RESTHandler);
131
132To expose methods, one needs to call register_method():
133
134 __PACKAGE__->register_method ($schema);
135
136Where $schema is a PVE method schema as described in
137PVE::JSONSchema. It includes a description of parameters and return
138values, and a reference to the actual code
139
140__PACKAGE__->register_method ({
141 name => 'echo',
142 path => 'echo',
143 method => 'GET',
144 description => "simple return value of parameter 'text'",
145 parameters => {
146 additionalProperties => 0,
147 properties => {
148 text => {
149 type => 'string',
150 }
151 },
152 },
153 returns => {
154 type => 'string',
155 },
156 code => sub {
157 my ($conn, $resp, $param) = @_;
158
159 return $param->{text};
160 }
161});
162
163The 'name' property is only used if you want to call the method
164directly from Perl. You can do that using:
165
166 print __PACKAGE__->echo({ text => "a test" });
167
168We use Perl's AUTOLOAD feature to implement this. Note: You need to
169pass parameters a HASH reference.
170
171There is a special helper method called cli_handler(). This is used by
172the CLIHandler Class for command line tools, where you want to pass
173arguments as array of strings. This uses Getopt::Long to parse parameters.
174
175There is a second way to map names to methods - using the 'path'
176property. And you can register subclasses. That way you can set up a
177filesystem like hierarchy to access methods.
178
179Here is an example:
180----------------------------
181package C1;
182
183__PACKAGE__->register_method ({
184 subclass => "C2",
185 path => 'sub2',
186});
187
188
189__PACKAGE__->register_method ({
190 name => 'list1',
191 path => 'index',
192 method => 'GET',
193 ...
194});
195
196package C2;
197
198__PACKAGE__->register_method ({
199 name => 'list2',
200 path => 'index',
201 method => 'GET',
202 ...
203});
204-------------------------------
205
206The utily method find_handler (in PVE::RESTHandler) can be use to do
207'path' related method lookups.
208
209C1->find_handler('GET', "/index") => C1::list1
210C1->find_handler('GET', "/sub2/index") => C2::list2
211
212The HTTP server use the URL (a path) to find the corresponding method.
213
214
215References
216==========
217[1] RESTful Web Services
218Web services for the real world
219
220By
221 Leonard Richardson, Sam Ruby
222Publisher:
223 O'Reilly Media
224Released:
225 May 2007
226
227[2] JSON Schema links: http://json-schema.org/