X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=README.dev;h=a97f1c83a4986e53f51e59a9ce19d192c26c5132;hp=d69f623809732c4a8acf0424c99ab65cb9f43d88;hb=26bcdf92d5e8d49fbea192adf2b9b5253f6a50ae;hpb=8bc53243e0331bf30b7436381f85ae69ebf4eae8 diff --git a/README.dev b/README.dev index d69f623..a97f1c8 100644 --- a/README.dev +++ b/README.dev @@ -1,23 +1,29 @@ -==================================== -Setup PVE Development Environment -==================================== += Setup PVE Development Environment = 1. Install Debian 'jessie' 2. Configure pvetest repository in apt sources.list -3. make sure you have a read IP address for your hostname in /etc/hosts + + deb http://download.proxmox.com/debian jessie pvetest + +3. Add our repository key with apt-key: + + wget -O- "http://download.proxmox.com/debian/key.asc" | apt-key add - + +4. make sure you have a read IP address for your hostname in /etc/hosts (using 127.0.1.1 will not work) -3. run: apt-get update -3. run: apt-get dist-upgrade -4. run: apt-get install proxmox-ve-3.10.0 -5. Install prerequisites for development environment: +5. run: apt-get update +6. run: apt-get dist-upgrade +7. run: apt-get install proxmox-ve -# new jessie depends +You should now have a working Proxmox VE installation. -apt-get -y install build-essential git-core debhelper autotools-dev \ -autogen dh-autoreconf dkms doxygen check pkg-config groff quilt dpatch \ -automake autoconf libtool lintian libdevel-cycle-perl libjson-perl \ -libcommon-sense-perl liblinux-inotify2-perl libio-stringy-perl \ += Install build prerequisites for development environment = + +apt-get -y install build-essential git-core git-email debhelper \ +autotools-dev autogen dh-autoreconf dkms doxygen check pkg-config \ +groff quilt dpatch automake autoconf libtool lintian libdevel-cycle-perl \ +libjson-perl libcommon-sense-perl liblinux-inotify2-perl libio-stringy-perl \ libstring-shellquote-perl dh-systemd rpm2cpio libsqlite3-dev sqlite3 \ libglib2.0-dev librrd-dev librrds-perl rrdcached libdigest-hmac-perl \ libxml-parser-perl gdb libcrypt-openssl-random-perl \ @@ -25,7 +31,7 @@ libcrypt-openssl-rsa-perl libnet-ldap-perl libauthen-pam-perl \ libjson-xs-perl libterm-readline-gnu-perl oathtool libmime-base32-perl \ liboath0 libpci-dev texi2html libsdl1.2-dev libgnutls28-dev \ libspice-protocol-dev xfslibs-dev libnuma-dev libaio-dev \ -libspice-server-dev libusbredirparser-dev glusterfs-common \ +pve-libspice-server-dev libusbredirparser-dev glusterfs-common \ libusb-1.0-0-dev librbd-dev libpopt-dev iproute bridge-utils numactl \ glusterfs-common ceph-common python-ceph libgoogle-perftools4 \ libfile-chdir-perl lvm2 glusterfs-client liblockfile-simple-perl \ @@ -35,9 +41,14 @@ python-pyparsing libfilesys-df-perl libcrypt-ssleay-perl \ libfile-readbackwards-perl libanyevent-perl libanyevent-http-perl \ unzip liblocale-po-perl vlan ifenslave-2.6 libfile-sync-perl cstream \ lzop dtach apt-transport-https hdparm gdisk parted ttf-dejavu-core \ -liblzma-dev dosfstools mtools libxen-dev +liblzma-dev dosfstools mtools libxen-dev libfuse-dev libcorosync-pve-dev \ +libqb-dev libapparmor-dev docbook2x libcap-dev dh-apparmor libcgmanager-dev \ +graphviz libseccomp-dev libglib-perl libgtk3-perl libnss3-dev libdlm-dev \ +libudev-dev + += Compile PVE packages from Source = -3. Download and install the following git modules in order from top to bottom: +Download and install the following git modules in order from top to bottom: # git clone git://git.proxmox.com/git/ @@ -46,6 +57,7 @@ You currently need the following packages: libqb.git corosync-pve.git pve-common.git +pve-docs.git pve-cluster.git lvm.git pve-access-control.git @@ -59,10 +71,13 @@ spiceterm.git #fence-agents-pve.git #resource-agents-pve.git pve-manager.git -pve-kernel-3.10.0.git +#pve-kernel-3.10.0.git libiscsi.git #gfs2-utils.git ksm-control-daemon.git +pve-container.git +pve-firewall.git +pve-kernel.git Most packages can be installed with 'make dinstall' command. @@ -80,8 +95,7 @@ You can view the source code at: https://git.proxmox.com -REST vs. SOAP -============= += REST vs. SOAP = We decided to change our SOAP API (1.X) and use a REST like API. The concept is described in [1] (Resource Oriented Architecture @@ -96,8 +110,7 @@ That framework, like any other AJAX toolkit, can talk directly to the REST API using JSON. So we were able to remove the server side template toolkit completely. -JSON and JSON Schema -==================== += JSON and JSON Schema = We use JSON as data format, because it is simple and parse-able by any web browser. @@ -122,8 +135,7 @@ So here is a summary of the advantage: - automatic generation of API documentation - easy way to create command line tools (using same API). -API Implementation (PVE::RESTHandler) -===================================== += API Implementation (PVE::RESTHandler) = All classes exposing methods on the API use PVE::RESTHandler as base class. @@ -212,8 +224,8 @@ C1->find_handler('GET', "/sub2/index") => C2::list2 The HTTP server use the URL (a path) to find the corresponding method. -References -========== += References = + [1] RESTful Web Services Web services for the real world