JSONSchema.pm: register new standard option pve-replicate

[pve-common.git] / README.dev

diff --git a/README.dev b/README.dev
index d69f623809732c4a8acf0424c99ab65cb9f43d88..4e0794890b6b865fb1a1b4a07cf4cd7e19ad9cf7 100644 (file)
--- 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
 
 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)
    (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 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 \
 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,31 +31,40 @@ 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 \
 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 \
 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 \

-libsystemd-daemon-dev libreadline-gplv2-dev libio-multiplex-perl \
+libsystemd-dev libreadline-gplv2-dev libio-multiplex-perl \

 libnetfilter-log-dev libipset3 ipset socat libsasl2-dev libogg-dev \
 python-pyparsing libfilesys-df-perl libcrypt-ssleay-perl \
 libfile-readbackwards-perl libanyevent-perl libanyevent-http-perl \
 libnetfilter-log-dev libipset3 ipset socat libsasl2-dev libogg-dev \
 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 \
+unzip liblocale-po-perl libfile-sync-perl cstream \

 lzop dtach apt-transport-https hdparm gdisk parted ttf-dejavu-core \
 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 corosync-dev \
+libcpg-dev libquorum-dev libcmap-dev libuuid-perl \
+libqb-dev libapparmor-dev docbook2x libcap-dev dh-apparmor \
+graphviz libseccomp-dev libglib-perl libgtk3-perl libnss3-dev libdlm-dev \
+libudev-dev asciidoc-dblatex source-highlight inkscape \
+libiscsi-dev libiscsi7
+
+= 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/<PACKAGE.git>
 
 You currently need the following packages:
 
 
 # git clone git://git.proxmox.com/git/<PACKAGE.git>
 
 You currently need the following packages:
 

-libqb.git
-corosync-pve.git

 pve-common.git
 pve-common.git

+libpve-http-server-perl.git
+libpve-apiclient-perl.git
+pve-docs.git

 pve-cluster.git
 pve-cluster.git

-lvm.git

 pve-access-control.git
 pve-storage.git
 pve-access-control.git
 pve-storage.git

+pve-guest-common.git
+pve-firewall.git

 pve-qemu-kvm.git
 qemu-server.git
 vncterm.git
 pve-qemu-kvm.git
 qemu-server.git
 vncterm.git


@@ -58,11 +73,14 @@ spiceterm.git
 #vzctl.git
 #fence-agents-pve.git
 #resource-agents-pve.git
 #vzctl.git
 #fence-agents-pve.git
 #resource-agents-pve.git

+extjs.git

 pve-manager.git
 pve-manager.git

-pve-kernel-3.10.0.git
-libiscsi.git
+#pve-kernel-3.10.0.git
+#libiscsi.git

 #gfs2-utils.git
 ksm-control-daemon.git
 #gfs2-utils.git
 ksm-control-daemon.git

+pve-container.git
+pve-kernel.git

 
 Most packages can be installed with 'make dinstall' command.
 
 
 Most packages can be installed with 'make dinstall' command.
 


@@ -80,8 +98,7 @@ You can view the source code at:
 https://git.proxmox.com
 
 
 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
 
 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 +113,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.
 
 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.
 
 We use JSON as data format, because it is simple and parse-able by any
 web browser.


@@ -122,8 +138,7 @@ So here is a summary of the advantage:
    - automatic generation of API documentation
    - easy way to create command line tools (using same API).
 
    - 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.
 
 
 All classes exposing methods on the API use PVE::RESTHandler as base class.
 


@@ -154,7 +169,7 @@ __PACKAGE__->register_method ({
        type => 'string',
     },
     code => sub {
        type => 'string',
     },
     code => sub {

-       my ($conn, $resp, $param) = @_;
+       my ($param) = @_;

 
        return $param->{text};
     }
 
        return $param->{text};
     }


@@ -212,8 +227,8 @@ C1->find_handler('GET', "/sub2/index") => C2::list2
 The HTTP server use the URL (a path) to find the corresponding method. 
 
 
 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
 
 [1] RESTful Web Services
 Web services for the real world